# Szurubooru

Szurubooru is an image board engine for small and medium communities, supporting image and video posts, tags, annotations, and a rich JSON REST API. It is open source and self-hosted, installable on Docker Hub and Unraid.

Canonical page: https://ourlocalhost.com/app/1074/szurubooru

## Description

Szurubooru is an image board engine for small and medium communities, supporting image and video posts, tags, annotations, and a rich JSON REST API.

## Platform availability

Available on 1 of 9 platforms: Unraid.

## Health score

60/100 (Good), based on 3 of 4 factors.
- Maintained: 72 (last commit 82 days ago)
- Popular: 60 (1,021 GitHub stars)
- Easy to install: 35 (1 install platform, install notes, Docker image)

## Links

- GitHub: https://github.com/rr-/szurubooru
- Docker Hub: https://hub.docker.com/r/szurubooru/server
- Unraid: https://ca.unraid.net/apps/szurubooru-api-0rjj1mv11234gb?q=szurubooru-api

## Common questions

### Do I need to start the database before the szurubooru API container?

Yes. Start the database with docker compose up -d sql first, because the main API may fail if it cannot connect.

### What must be configured in config.yaml before running the board?

Set a real secret key, the database address, and the folders for images and settings. Placeholder values or wrong paths can make uploads unavailable and the board unsafe to share.

### How do I create the first administrator account?

Run docker compose run server ./szuru-admin users create admin admin@example.com administrator after the app is running, replacing the email with your own. Without this account, you cannot manage users, settings, or posts.

### Can I access a local szurubooru instance from outside without a domain?

Yes, forward the service ports and access it with the server IP and port. A reverse proxy is optional but useful for domain-based access.

## Alternatives

- Danbooru: Danbooru is an English language imageboard and image hosting website focused primarily on anime style illustrations.

---
Source: Our Local Host (https://ourlocalhost.com/app/1074/szurubooru), the self-hosted and open-source app directory.