szurubooru-api

szurubooru-api

Docker app from FoxxMD's Repository

Overview

Backend API container for Szurubooru, an image board engine for small and medium communities

szurubooru

Szurubooru is an image board engine inspired by services such as Danbooru, Gelbooru and Moebooru dedicated for small and medium communities. Its name has its roots in Polish language and has onomatopeic meaning of scraping or scrubbing. It is pronounced as shoorubooru.

Features

  • Post content: images (JPG, PNG, GIF, animated GIF), videos (MP4, WEBM), Flash animations
  • Ability to retrieve web video content using yt-dlp
  • Post comments
  • Post notes / annotations, including arbitrary polygons
  • Rich JSON REST API (see documentation)
  • Token based authentication for clients
  • Rich search system
  • Rich privilege system
  • Autocomplete in search and while editing tags
  • Tag categories
  • Tag suggestions
  • Tag implications (adding a tag automatically adds another)
  • Tag aliases
  • Pools and pool categories
  • Duplicate detection
  • Post rating and favoriting; comment rating
  • Polished UI
  • Browser configurable endless paging
  • Browser configurable backdrop grid for transparent images

Installation

It is recommended that you use Docker for deployment. See installation instructions.

More installation resources, as well as related projects can be found on the GitHub project Wiki

Screenshots

Post list:

20160908_180032_fsk

Post view:

20160908_180429_lmp

License

GPLv3.

Install szurubooru-api on Unraid in a few clicks.

Find szurubooru-api in Community Apps on your Unraid server, review the template, and click Install. Unraid handles the Docker app or plugin setup from the published template.

Open the Apps tab on your Unraid server Search Community Apps for szurubooru-api Review the template variables and paths Click Install

Requirements

Postgres 11 installed

Download Statistics

448,114
Total Downloads
12,167
This Month
10,600
Avg / Month

Total Downloads Over Time

Loading chart...

Related apps

Explore more like this

Explore all

Details

Repository
szurubooru/server:latest
Last Updated2026-05-26
First Seen2019-12-16

Runtime arguments

Network
bridge
Shell
bash
Privileged
false

Template configuration

Postgres HostVariable

IP address of Postgres instance

Target
POSTGRES_HOST
Postgres DBVariable

Name of the database on Postgres instance to use

Target
POSTGRES_DB
Postgres UserVariable

Username of Postgres user

Target
POSTGRES_USER
Postgres PasswordVariable

Password of Postgres user

Target
POSTGRES_PASSWORD
Image DataPathrw

Directory on host to store image data

Target
/data
Default
/mnt/user/appdata/szurubooru/data
Value
/mnt/user/appdata/szurubooru/data
Api PortPorttcp

Port to expose API interface on. This is accessed by the frontend.

Target
6666
Default
6666
Value
6666