timyiscool / danbooru

A taggable image board written in Rails.

Quickstart

Run this to start a basic Danbooru instance:

curl -sSL https://raw.githubusercontent.com/danbooru/danbooru/master/bin/danbooru | sh

This will install Docker Compose and use it to start Danbooru. When it's done, Danbooru will be running at http://localhost:3000.

Alternatively, if you already have Docker Compose installed, you can just do:

wget https://raw.githubusercontent.com/danbooru/danbooru/master/docker-compose.yaml
docker compose up

You will likely need to run docker with elevated permissions.

If you get an error such as 'name' does not match any of the regexes: '^x-' make sure that you're running an updated version of Docker Compose.

Installation

See the Docker Guide for more information on running Danbooru using Docker. This is the recommended way to run Danbooru.

Alternatively, you may use the Manual Installation Guide to install Danbooru without Docker. Manual installation is much more difficult than using Docker, and therefore is not recommended or officially supported.

For help, ask in the #technical channel on the Danbooru Discord, or in the discussions area on Github.

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.