GitHub - Comitant/danbooru: A taggable image board written in Rails.

Quickstart

Using Github Codespaces

To launch a Danbooru instance in your browser:

Create a Github account.
Click Open in Github Codespaces.
Click the Create new codespace button.
Wait a few minutes for it to launch.

When it's done, you'll have a new Danbooru instance with a full development environment running in your browser. This way you can try out Danbooru without installing anything on your computer.

See the Codespaces section in the Docker Guide to learn more.

Using Docker

Run this to start a Danbooru instance:

sh -c "$(curl -sSL https://raw.githubusercontent.com/danbooru/danbooru/master/bin/setup)"

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

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

git clone http://github.com/danbooru/danbooru
cd danbooru
touch .env.local config/danbooru_local_config.rb
sudo docker compose up

When you're done, you can run the following to delete everything:

sudo docker compose down --volumes # Delete all data and images in your Danbooru instance.
sudo docker image prune # Clean up all unused Docker images.
rm -rf ~/danbooru # Delete the Danbooru code.

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

In the production environment, for historical reasons, Danbooru relies on Amazon AWS to send pool/post versions to a SQS queue, and on a separate archives service (available here) to extract the versions from that queue and insert them into a database.

The Docker Compose files in this repository come with a preconfigured archives service and an SQS mock using ElasticMQ, so following the docker tutorial at the start of this file is sufficient to have post/pool versions working for a new instance.

Google APIs

The following features require a Google Cloud account:

BigQuery database export

IQDB Service

IQDB integration is delegated to the IQDB 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.

Quickstart

Using Github Codespaces

To launch a Danbooru instance in your browser:

Create a Github account.
Click Open in Github Codespaces.
Click the Create new codespace button.
Wait a few minutes for it to launch.

When it's done, you'll have a new Danbooru instance with a full development environment running in your browser. This way you can try out Danbooru without installing anything on your computer.

See the Codespaces section in the Docker Guide to learn more.

Using Docker

Run this to start a Danbooru instance:

sh -c "$(curl -sSL https://raw.githubusercontent.com/danbooru/danbooru/master/bin/setup)"

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

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

git clone http://github.com/danbooru/danbooru
cd danbooru
touch .env.local config/danbooru_local_config.rb
sudo docker compose up

When you're done, you can run the following to delete everything:

sudo docker compose down --volumes # Delete all data and images in your Danbooru instance.
sudo docker image prune # Clean up all unused Docker images.
rm -rf ~/danbooru # Delete the Danbooru code.

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

In the production environment, for historical reasons, Danbooru relies on Amazon AWS to send pool/post versions to a SQS queue, and on a separate archives service (available here) to extract the versions from that queue and insert them into a database.

The Docker Compose files in this repository come with a preconfigured archives service and an SQS mock using ElasticMQ, so following the docker tutorial at the start of this file is sufficient to have post/pool versions working for a new instance.

Google APIs

The following features require a Google Cloud account:

BigQuery database export

IQDB Service

IQDB integration is delegated to the IQDB 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.

Quickstart

Using Github Codespaces

To launch a Danbooru instance in your browser:

Create a Github account.
Click Open in Github Codespaces.
Click the Create new codespace button.
Wait a few minutes for it to launch.

When it's done, you'll have a new Danbooru instance with a full development environment running in your browser. This way you can try out Danbooru without installing anything on your computer.

See the Codespaces section in the Docker Guide to learn more.

Using Docker

Run this to start a Danbooru instance:

sh -c "$(curl -sSL https://raw.githubusercontent.com/danbooru/danbooru/master/bin/setup)"

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

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

git clone http://github.com/danbooru/danbooru
cd danbooru
touch .env.local config/danbooru_local_config.rb
sudo docker compose up

When you're done, you can run the following to delete everything:

sudo docker compose down --volumes # Delete all data and images in your Danbooru instance.
sudo docker image prune # Clean up all unused Docker images.
rm -rf ~/danbooru # Delete the Danbooru code.

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

In the production environment, for historical reasons, Danbooru relies on Amazon AWS to send pool/post versions to a SQS queue, and on a separate archives service (available here) to extract the versions from that queue and insert them into a database.

The Docker Compose files in this repository come with a preconfigured archives service and an SQS mock using ElasticMQ, so following the docker tutorial at the start of this file is sufficient to have post/pool versions working for a new instance.

Google APIs

The following features require a Google Cloud account:

BigQuery database export

IQDB Service

IQDB integration is delegated to the IQDB 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.

Quickstart

Using Github Codespaces

To launch a Danbooru instance in your browser:

Create a Github account.
Click Open in Github Codespaces.
Click the Create new codespace button.
Wait a few minutes for it to launch.

When it's done, you'll have a new Danbooru instance with a full development environment running in your browser. This way you can try out Danbooru without installing anything on your computer.

See the Codespaces section in the Docker Guide to learn more.

Using Docker

Run this to start a Danbooru instance:

sh -c "$(curl -sSL https://raw.githubusercontent.com/danbooru/danbooru/master/bin/setup)"

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

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

git clone http://github.com/danbooru/danbooru
cd danbooru
touch .env.local config/danbooru_local_config.rb
sudo docker compose up

When you're done, you can run the following to delete everything:

sudo docker compose down --volumes # Delete all data and images in your Danbooru instance.
sudo docker image prune # Clean up all unused Docker images.
rm -rf ~/danbooru # Delete the Danbooru code.

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

In the production environment, for historical reasons, Danbooru relies on Amazon AWS to send pool/post versions to a SQS queue, and on a separate archives service (available here) to extract the versions from that queue and insert them into a database.

The Docker Compose files in this repository come with a preconfigured archives service and an SQS mock using ElasticMQ, so following the docker tutorial at the start of this file is sufficient to have post/pool versions working for a new instance.

Google APIs

The following features require a Google Cloud account:

BigQuery database export

IQDB Service

IQDB integration is delegated to the IQDB 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.

Quickstart

Using Github Codespaces

To launch a Danbooru instance in your browser:

Create a Github account.
Click Open in Github Codespaces.
Click the Create new codespace button.
Wait a few minutes for it to launch.

When it's done, you'll have a new Danbooru instance with a full development environment running in your browser. This way you can try out Danbooru without installing anything on your computer.

See the Codespaces section in the Docker Guide to learn more.

Using Docker

Run this to start a Danbooru instance:

sh -c "$(curl -sSL https://raw.githubusercontent.com/danbooru/danbooru/master/bin/setup)"

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

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

git clone http://github.com/danbooru/danbooru
cd danbooru
touch .env.local config/danbooru_local_config.rb
sudo docker compose up

When you're done, you can run the following to delete everything:

sudo docker compose down --volumes # Delete all data and images in your Danbooru instance.
sudo docker image prune # Clean up all unused Docker images.
rm -rf ~/danbooru # Delete the Danbooru code.

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

In the production environment, for historical reasons, Danbooru relies on Amazon AWS to send pool/post versions to a SQS queue, and on a separate archives service (available here) to extract the versions from that queue and insert them into a database.

The Docker Compose files in this repository come with a preconfigured archives service and an SQS mock using ElasticMQ, so following the docker tutorial at the start of this file is sufficient to have post/pool versions working for a new instance.

Google APIs

The following features require a Google Cloud account:

BigQuery database export

IQDB Service

IQDB integration is delegated to the IQDB 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.

Quickstart

Using Github Codespaces

To launch a Danbooru instance in your browser:

Create a Github account.
Click Open in Github Codespaces.
Click the Create new codespace button.
Wait a few minutes for it to launch.

When it's done, you'll have a new Danbooru instance with a full development environment running in your browser. This way you can try out Danbooru without installing anything on your computer.

See the Codespaces section in the Docker Guide to learn more.

Using Docker

Run this to start a Danbooru instance:

sh -c "$(curl -sSL https://raw.githubusercontent.com/danbooru/danbooru/master/bin/setup)"

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

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

git clone http://github.com/danbooru/danbooru
cd danbooru
touch .env.local config/danbooru_local_config.rb
sudo docker compose up

When you're done, you can run the following to delete everything:

sudo docker compose down --volumes # Delete all data and images in your Danbooru instance.
sudo docker image prune # Clean up all unused Docker images.
rm -rf ~/danbooru # Delete the Danbooru code.

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

In the production environment, for historical reasons, Danbooru relies on Amazon AWS to send pool/post versions to a SQS queue, and on a separate archives service (available here) to extract the versions from that queue and insert them into a database.

The Docker Compose files in this repository come with a preconfigured archives service and an SQS mock using ElasticMQ, so following the docker tutorial at the start of this file is sufficient to have post/pool versions working for a new instance.

Google APIs

The following features require a Google Cloud account:

BigQuery database export

IQDB Service

IQDB integration is delegated to the IQDB 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.

Quickstart

Using Github Codespaces

To launch a Danbooru instance in your browser:

Create a Github account.
Click Open in Github Codespaces.
Click the Create new codespace button.
Wait a few minutes for it to launch.

When it's done, you'll have a new Danbooru instance with a full development environment running in your browser. This way you can try out Danbooru without installing anything on your computer.

See the Codespaces section in the Docker Guide to learn more.

Using Docker

Run this to start a Danbooru instance:

sh -c "$(curl -sSL https://raw.githubusercontent.com/danbooru/danbooru/master/bin/setup)"

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

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

git clone http://github.com/danbooru/danbooru
cd danbooru
touch .env.local config/danbooru_local_config.rb
sudo docker compose up

When you're done, you can run the following to delete everything:

sudo docker compose down --volumes # Delete all data and images in your Danbooru instance.
sudo docker image prune # Clean up all unused Docker images.
rm -rf ~/danbooru # Delete the Danbooru code.

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

In the production environment, for historical reasons, Danbooru relies on Amazon AWS to send pool/post versions to a SQS queue, and on a separate archives service (available here) to extract the versions from that queue and insert them into a database.

The Docker Compose files in this repository come with a preconfigured archives service and an SQS mock using ElasticMQ, so following the docker tutorial at the start of this file is sufficient to have post/pool versions working for a new instance.

Google APIs

The following features require a Google Cloud account:

BigQuery database export

IQDB Service

IQDB integration is delegated to the IQDB 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.

Quickstart

Using Github Codespaces

To launch a Danbooru instance in your browser:

Create a Github account.
Click Open in Github Codespaces.
Click the Create new codespace button.
Wait a few minutes for it to launch.

When it's done, you'll have a new Danbooru instance with a full development environment running in your browser. This way you can try out Danbooru without installing anything on your computer.

See the Codespaces section in the Docker Guide to learn more.

Using Docker

Run this to start a Danbooru instance:

sh -c "$(curl -sSL https://raw.githubusercontent.com/danbooru/danbooru/master/bin/setup)"

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

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

git clone http://github.com/danbooru/danbooru
cd danbooru
touch .env.local config/danbooru_local_config.rb
sudo docker compose up

When you're done, you can run the following to delete everything:

sudo docker compose down --volumes # Delete all data and images in your Danbooru instance.
sudo docker image prune # Clean up all unused Docker images.
rm -rf ~/danbooru # Delete the Danbooru code.

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

In the production environment, for historical reasons, Danbooru relies on Amazon AWS to send pool/post versions to a SQS queue, and on a separate archives service (available here) to extract the versions from that queue and insert them into a database.

The Docker Compose files in this repository come with a preconfigured archives service and an SQS mock using ElasticMQ, so following the docker tutorial at the start of this file is sufficient to have post/pool versions working for a new instance.

Google APIs

The following features require a Google Cloud account:

BigQuery database export

IQDB Service

IQDB integration is delegated to the IQDB 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.

Name		Name	Last commit message	Last commit date
.dependabot		.dependabot
.devcontainer		.devcontainer
.github		.github
app		app
bin		bin
config		config
db		db
doc		doc
lib		lib
public		public
script/fixes		script/fixes
test		test
.codeclimate.yml		.codeclimate.yml
.codecov.yml		.codecov.yml
.editorconfig		.editorconfig
.env		.env
.eslintrc.yml		.eslintrc.yml
.gitignore		.gitignore
.irbrc		.irbrc
.mailmap		.mailmap
.rubocop.yml		.rubocop.yml
.ruby-version		.ruby-version
.simplecov		.simplecov
.stylelintrc.yml		.stylelintrc.yml
.tool-versions		.tool-versions
CHANGELOG.md		CHANGELOG.md
Dockerfile		Dockerfile
Gemfile		Gemfile
Gemfile.lock		Gemfile.lock
LICENSE		LICENSE
Procfile		Procfile
README.md		README.md
Rakefile		Rakefile
babel.config.json		babel.config.json
buildkitd.toml		buildkitd.toml
config.ru		config.ru
docker-compose.dev.yaml		docker-compose.dev.yaml
docker-compose.yaml		docker-compose.yaml
package-lock.json		package-lock.json
package.json		package.json
postcss.config.js		postcss.config.js

Name		Name	Last commit message	Last commit date
.dependabot		.dependabot
.devcontainer		.devcontainer
.github		.github
app		app
bin		bin
config		config
db		db
doc		doc
lib		lib
public		public
script/fixes		script/fixes
test		test
.codeclimate.yml		.codeclimate.yml
.codecov.yml		.codecov.yml
.editorconfig		.editorconfig
.env		.env
.eslintrc.yml		.eslintrc.yml
.gitignore		.gitignore
.irbrc		.irbrc
.mailmap		.mailmap
.rubocop.yml		.rubocop.yml
.ruby-version		.ruby-version
.simplecov		.simplecov
.stylelintrc.yml		.stylelintrc.yml
.tool-versions		.tool-versions
CHANGELOG.md		CHANGELOG.md
Dockerfile		Dockerfile
Gemfile		Gemfile
Gemfile.lock		Gemfile.lock
LICENSE		LICENSE
Procfile		Procfile
README.md		README.md
Rakefile		Rakefile
babel.config.json		babel.config.json
buildkitd.toml		buildkitd.toml
config.ru		config.ru
docker-compose.dev.yaml		docker-compose.dev.yaml
docker-compose.yaml		docker-compose.yaml
package-lock.json		package-lock.json
package.json		package.json
postcss.config.js		postcss.config.js

Name		Name	Last commit message	Last commit date
.dependabot		.dependabot
.devcontainer		.devcontainer
.github		.github
app		app
bin		bin
config		config
db		db
doc		doc
lib		lib
public		public
script/fixes		script/fixes
test		test
.codeclimate.yml		.codeclimate.yml
.codecov.yml		.codecov.yml
.editorconfig		.editorconfig
.env		.env
.eslintrc.yml		.eslintrc.yml
.gitignore		.gitignore
.irbrc		.irbrc
.mailmap		.mailmap
.rubocop.yml		.rubocop.yml
.ruby-version		.ruby-version
.simplecov		.simplecov
.stylelintrc.yml		.stylelintrc.yml
.tool-versions		.tool-versions
CHANGELOG.md		CHANGELOG.md
Dockerfile		Dockerfile
Gemfile		Gemfile
Gemfile.lock		Gemfile.lock
LICENSE		LICENSE
Procfile		Procfile
README.md		README.md
Rakefile		Rakefile
babel.config.json		babel.config.json
buildkitd.toml		buildkitd.toml
config.ru		config.ru
docker-compose.dev.yaml		docker-compose.dev.yaml
docker-compose.yaml		docker-compose.yaml
package-lock.json		package-lock.json
package.json		package.json
postcss.config.js		postcss.config.js

Name		Name	Last commit message	Last commit date
.dependabot		.dependabot
.devcontainer		.devcontainer
.github		.github
app		app
bin		bin
config		config
db		db
doc		doc
lib		lib
public		public
script/fixes		script/fixes
test		test
.codeclimate.yml		.codeclimate.yml
.codecov.yml		.codecov.yml
.editorconfig		.editorconfig
.env		.env
.eslintrc.yml		.eslintrc.yml
.gitignore		.gitignore
.irbrc		.irbrc
.mailmap		.mailmap
.rubocop.yml		.rubocop.yml
.ruby-version		.ruby-version
.simplecov		.simplecov
.stylelintrc.yml		.stylelintrc.yml
.tool-versions		.tool-versions
CHANGELOG.md		CHANGELOG.md
Dockerfile		Dockerfile
Gemfile		Gemfile
Gemfile.lock		Gemfile.lock
LICENSE		LICENSE
Procfile		Procfile
README.md		README.md
Rakefile		Rakefile
babel.config.json		babel.config.json
buildkitd.toml		buildkitd.toml
config.ru		config.ru
docker-compose.dev.yaml		docker-compose.dev.yaml
docker-compose.yaml		docker-compose.yaml
package-lock.json		package-lock.json
package.json		package.json
postcss.config.js		postcss.config.js

Name		Name	Last commit message	Last commit date
.dependabot		.dependabot
.devcontainer		.devcontainer
.github		.github
app		app
bin		bin
config		config
db		db
doc		doc
lib		lib
public		public
script/fixes		script/fixes
test		test
.codeclimate.yml		.codeclimate.yml
.codecov.yml		.codecov.yml
.editorconfig		.editorconfig
.env		.env
.eslintrc.yml		.eslintrc.yml
.gitignore		.gitignore
.irbrc		.irbrc
.mailmap		.mailmap
.rubocop.yml		.rubocop.yml
.ruby-version		.ruby-version
.simplecov		.simplecov
.stylelintrc.yml		.stylelintrc.yml
.tool-versions		.tool-versions
CHANGELOG.md		CHANGELOG.md
Dockerfile		Dockerfile
Gemfile		Gemfile
Gemfile.lock		Gemfile.lock
LICENSE		LICENSE
Procfile		Procfile
README.md		README.md
Rakefile		Rakefile
babel.config.json		babel.config.json
buildkitd.toml		buildkitd.toml
config.ru		config.ru
docker-compose.dev.yaml		docker-compose.dev.yaml
docker-compose.yaml		docker-compose.yaml
package-lock.json		package-lock.json
package.json		package.json
postcss.config.js		postcss.config.js

Latest commit

History

Folders and files

Repository files navigation

Quickstart

Using Github Codespaces

Using Docker

Installation

Services

Amazon Web Services

Google APIs

IQDB Service

Reportbooru Service

Recommender Service

About

Resources

Stars

Watchers

Forks

Releases

Packages

Contributors

Languages

Latest commit

History

Folders and files

Repository files navigation

Quickstart

Using Github Codespaces

Using Docker

Installation

Services

Amazon Web Services

Google APIs

IQDB Service

Reportbooru Service

Recommender Service

About

Resources

Stars

Watchers

Forks

Releases

Packages

Contributors

Languages

Latest commit

History

Folders and files

Repository files navigation

Quickstart

Using Github Codespaces

Using Docker

Installation

Services

Amazon Web Services

Google APIs

IQDB Service

Reportbooru Service

Recommender Service

About

Resources

Stars

Watchers

Forks

Releases

Packages

Contributors

Languages

Latest commit

History

Folders and files

Repository files navigation

Quickstart

Using Github Codespaces

Using Docker

Installation

Services

Amazon Web Services

Google APIs