4cc8dd41ec
Unlike Unicorn, Puma doesn't have a builtin HTTP request timeout mechanism, so we have to use Rack::Timeout instead. See the caveats in the Rack::Timeout documentation [1]. In Unicorn, a timeout would send a SIGKILL to the worker, immediately killing it. This would result in a dropped connection and a Cloudflare 502 error to the user. In Puma, it raises an exception, which we can catch and return a better error to the user. On the other hand, raising an exception can potentially corrupt application state if it's sent at the wrong time, or be delayed indefinitely if the app is stuck in IO or C extension code. The default request timeout is 65 seconds. 65 seconds is to give things like HTTP requests on a 60 second timeout enough time to complete. Set the RACK_REQUEST_TIMEOUT environment variable to change the timeout. 1: https://github.com/sharpstone/rack-timeout#further-documentation
Quickstart
Clone this repository and run bin/danbooru to start a basic Danbooru instance:
git clone https://github.com/danbooru/danbooru
cd danbooru
./bin/danbooru
This will install Docker Compose and use it to start Danbooru. This will take several minutes and produce lots of output. When it's done, Danbooru will be running at http://localhost.
Alternatively, if you already have Docker Compose installed, you can just do:
docker-compose -f config/docker/docker-compose.simple.yaml up
Manual Installation
Follow the INSTALL.debian script to install Danbooru.
The INSTALL.debian script is written for Debian, but can be adapted for other distributions. Danbooru has been successfully installed on Debian, Ubuntu, Fedora, Arch, and OS X. It is recommended that you use an Ubuntu-based system since Ubuntu is what is used in development and production.
See here for a guide on how set up Danbooru inside a virtual machine.
For best performance, you will need at least 256MB of RAM for PostgreSQL and Rails. The memory requirement will grow as your database gets bigger.
In production, Danbooru uses PostgreSQL 10.18, but any release later than this should work.
Troubleshooting
If your setup is not working, here are the steps I usually recommend to people:
-
Test the database. Make sure you can connect to it using
psql. Make sure the tables exist. If this fails, you need to work on correctly installing PostgreSQL, importing the initial schema, and running the migrations. -
Test the Rails database connection by using
bin/rails console. RunPost.countto make sure Rails can connect to the database. If this fails, you need to make sure your Danbooru configuration files are correct. -
Test Nginx to make sure it's working correctly. You may need to debug your Nginx configuration file.
-
Check all log files.
Services
Danboou depends on a couple of cloud services and several microservices to implement certain features.
Amazon Web Services
The following features require an Amazon AWS account:
- Pool history
- Post history
Google APIs
The following features require a Google Cloud account:
- BigQuery database export
IQDB Service
IQDB integration is delegated to the IQDB service.
Archive Service
In order to access pool and post histories you will need to install and configure the Archives service.
Reportbooru Service
The following features are delegated to the Reportbooru service:
- Post views
- Missed searches report
- Popular searches report
Recommender Service
Post recommendations require the Recommender service.