Skip to content

aibooruorg/aibooru

Repository files navigation

Discord codecov

Quickstart

Using Github Codespaces

To launch an AIBooru instance in your browser:

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

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

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

Using Docker

Run this to start an AIBooru instance:

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

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

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

git clone http://github.com/aibooruorg/aibooru
cd aibooru
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 AIBooru instance.
sudo docker image prune            # Clean up all unused Docker images.
rm -rf ~/aibooru                   # Delete the AIBooru code.

Installation

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

Alternatively, you may use the Manual Installation Guide to install AIBooru 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 AIBooru Discord, or in the discussions area on Github.

Services

AIBooru depends on a couple of cloud services and several microservices to implement certain features.

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:

  • Missed searches report
  • Popular searches report

Recommender Service

Post recommendations require the Recommender service.