### Start Database Container

Source: https://github.com/rr-/szurubooru/blob/master/doc/INSTALL.md

For the first run, it is recommended to start the database container separately.

```bash
user@host:szuru$ docker compose up -d sql
```

--------------------------------

### Initialize and Start PostgreSQL

Source: https://github.com/rr-/szurubooru/wiki/Installation-without-Docker

Initializes the PostgreSQL data directory and starts the PostgreSQL service. This is a prerequisite for creating databases.

```console
user@host:~$ sudo -i -u postgres initdb --locale en_US.UTF-8 -E UTF8 -D /var/lib/postgres/data
user@host:~$ sudo systemctl start postgresql
user@host:~$ sudo systemctl enable postgresql
```

--------------------------------

### Install Hard Dependencies with Apt

Source: https://github.com/rr-/szurubooru/wiki/Installation-without-Docker

Installs essential packages for Szurubooru using Apt on Ubuntu 24.04. This includes PostgreSQL, Python, FFmpeg, and development libraries. Ensure you have curl and ca-certificates installed.

```console
# Import the repository signing key:
sudo apt install curl ca-certificates
sudo install -d /usr/share/postgresql-common/pgdg
sudo curl -o /usr/share/postgresql-common/pgdg/apt.postgresql.org.asc --fail https://www.postgresql.org/media/keys/ACCC4CF8.asc

# Create the repository configuration file:
sudo sh -c 'echo "deb [signed-by=/usr/share/postgresql-common/pgdg/apt.postgresql.org.asc] https://apt.postgresql.org/pub/repos/apt $(lsb_release -cs)-pgdg main" > /etc/apt/sources.list.d/pgdg.list'

# Update the package lists:
user@host:~$ sudo apt update

# Install the latest version of PostgreSQL:
# If you want a specific version, use 'postgresql-16' or similar instead of 'postgresql'
sudo apt -y install postgresql
sudo apt -y install python3
sudo apt -y install python3-pip
sudo apt -y install ffmpeg
sudo apt -y install python3-virtualenv
sudo apt -y install libheif-dev
sudo apt -y install libavif-dev
mv /usr/lib/python3.12/EXTERNALLY-MANAGED /usr/lib/python3.12/EXTERNALLY-MANAGED.old
pip3 install alembic>=0.8.5
pip3 install certifi>=2017.11.5
pip3 install coloredlogs==5.0
pip3 install heif-image-plugin
pip3 install numpy>=1.8.2
pip3 install pillow-avif-plugin~=1.1.0
pip3 install pillow>=4.3.0
pip3 install psycopg2-binary>=2.6.1
pip3 install pyheif
pip3 install pynacl>=1.2.1
pip3 install pyRFC3339>=1.0
pip3 install pytz>=2018.3
pip3 install pyyaml>=3.11
pip3 install "SQLAlchemy>=1.0.12, <1.4"
pip3 install yt-dlp
pip3 install pillow-avif-plugin
pip3 install freezegun
```

--------------------------------

### Server Configuration Example

Source: https://context7.com/rr-/szurubooru/llms.txt

An example of the server configuration file (config.yaml), showing settings for name, secret key, data paths, database connection, and SMTP.

```yaml
# server/config.yaml example
name: My Image Board
secret: your-secret-key-change-this
data_url: /data/
data_dir: /data/

database: postgresql://szuru:password@sql:5432/szuru

default_rank: regular
enable_safety: true
contact_email: admin@example.com

smtp:
  host: smtp.example.com
  port: 587
  user: notifications@example.com
  pass: smtp-password

privileges:
  'posts:create:identified': regular
  'posts:create:anonymous': power
  'posts:edit:tags': regular
  'posts:delete': moderator
  'tags:create': regular
  'users:create:any': administrator
```

--------------------------------

### Start All Docker Containers

Source: https://github.com/rr-/szurubooru/blob/master/doc/INSTALL.md

Start all the Docker containers defined in the Docker Compose configuration.

```bash
user@host:szuru$ docker compose up -d
```

--------------------------------

### Szurubooru Config.yaml Example

Source: https://github.com/rr-/szurubooru/wiki/Installation-without-Docker

Example configuration for data URL and directory in config.yaml. These settings are crucial for Szurubooru to locate and serve data correctly.

```yaml
data_url: 'http://example.com/data/'
data_dir: '/srv/www/booru/client/public/data'
```

--------------------------------

### Docker Deployment: Start and Manage Containers

Source: https://context7.com/rr-/szurubooru/llms.txt

Commands to pull Docker images, start containers in the correct order, view logs, and run administrative tasks.

```bash
# Pull and start containers
docker compose pull
docker compose up -d sql       # Start database first
docker compose up -d           # Start all services

# View logs
docker compose logs -f

# Administrative tasks
docker compose run server ./szuru-admin --help
docker compose run server ./szuru-admin users create admin admin@example.com administrator
docker compose run server ./szuru-admin users reset-password admin
```

--------------------------------

### Post Snapshot Data Example

Source: https://github.com/rr-/szurubooru/blob/master/doc/API.md

Example of the 'data' field for a 'post' resource creation snapshot.

```json
{
    "source": "http://example.com/",
    "safety": "safe",
    "checksum": "deadbeef",
    "tags": ["tag1", "tag2"],
    "relations": [1, 2],
    "notes": [<note1>, <note2>, <note3>],
    "flags": ["loop"],
    "featured": false
}
```

--------------------------------

### Install Frontend Dependencies

Source: https://github.com/rr-/szurubooru/wiki/Installation-without-Docker

Navigates to the client directory and installs frontend dependencies using npm. It is recommended to run 'npm audit fix' afterwards to address vulnerabilities.

```console
user@host:szuru$ cd client
user@host:szuru/client$ npm install
```

--------------------------------

### Example Docker Compose for Szurubooru

Source: https://github.com/rr-/szurubooru/wiki/ARM-and-Raspberry-Pi-Support-for-Docker-builds

This is an example Docker Compose configuration file for Szurubooru. It serves as a template for setting up the service using Docker Compose.

```yaml
## Example Docker Compose configuration
##
## Use this as a template to set up docker-compose, or as guide to set up other
```

--------------------------------

### Copy Configuration Files

Source: https://github.com/rr-/szurubooru/blob/master/doc/INSTALL.md

Copy the example configuration files for the server and Docker Compose to their respective locations.

```bash
user@host:szuru$ cp server/config.yaml.dist server/config.yaml
user@host:szuru$ cp doc/example.env .env
```

--------------------------------

### Install Hard Dependencies with Pacman

Source: https://github.com/rr-/szurubooru/wiki/Installation-without-Docker

Installs essential packages for Szurubooru using Pacman on Arch Linux. Ensure Python 3.8+ and pip are installed.

```console
user@host:~$ sudo pacman -S postgresql
user@host:~$ sudo pacman -S python
user@host:~$ sudo pacman -S python-pip
user@host:~$ sudo pacman -S ffmpeg
user@host:~$ sudo pacman -S npm
user@host:~$ sudo pip install virtualenv
```

--------------------------------

### Tag Snapshot Data Example

Source: https://github.com/rr-/szurubooru/blob/master/doc/API.md

Example of the 'data' field for a 'tag' resource creation snapshot.

```json
{
    "names":        ["tag1", "tag2", "tag3"],
    "category":     "plain",
    "implications": ["imp1", "imp2", "imp3"],
    "suggestions":  ["sug1", "sug2", "sug3"]
}
```

--------------------------------

### Docker Environment Variables Example

Source: https://context7.com/rr-/szurubooru/llms.txt

An example of the .env file for Docker Compose, specifying port, base URL, database credentials, and data directory.

```ini
# .env example
PORT=:8080
BASE_URL=/
POSTGRES_USER=szuru
POSTGRES_PASSWORD=secure-db-password
POSTGRES_DB=szuru
DATA_DIR=./data
```

--------------------------------

### Install Backend Dependencies with Virtualenv

Source: https://github.com/rr-/szurubooru/wiki/Installation-without-Docker

Sets up a Python virtual environment named 'python_modules' in the server directory, activates it, and then installs backend dependencies from 'requirements.txt'. This isolates project dependencies.

```console
user@host:szuru/client$ cd ../server
user@host:szuru/server$ virtualenv python_modules # consistent with node_modules
user@host:szuru/server$ source python_modules/bin/activate # enters the sandbox
(python_modules) user@host:szuru/server$ pip install -r requirements.txt # installs the dependencies
```

--------------------------------

### Run Szurubooru with Waitress

Source: https://github.com/rr-/szurubooru/wiki/Installation-without-Docker

Install Waitress and run the Szurubooru application using the waitress-serve command. Ensure the virtual environment is activated.

```bash
user@host:szuru/server$ source python_modules/bin/activate
(python_modules) user@host:szuru/server$ pip install waitress
(python_modules) user@host:szuru/server$ waitress-serve --port 6666 szurubooru.facade:app
```

--------------------------------

### Install libseccomp2 on Raspbian

Source: https://github.com/rr-/szurubooru/wiki/ARM-and-Raspberry-Pi-Support-for-Docker-builds

Use these commands to download and install the libseccomp2 package, which is necessary for Alpine 3.13 compatibility on Raspbian.

```bash
$ wget http://ftp.de.debian.org/debian/pool/main/libs/libseccomp/libseccomp2_2.5.1-1_armhf.deb
$ dpkg -i libseccomp2_2.5.1-1_armhf.deb
```

--------------------------------

### Post Modification Snapshot Diff Example

Source: https://github.com/rr-/szurubooru/blob/master/doc/API.md

Example of a modification snapshot diff for a post, showing changes to 'source' and 'notes'.

```json
{
    "type": "object change",
    "value":
    {
        "source":
        {
            "type": "primitive change",
            "old-value": null,
            "new-value": "new source"
        },
        "notes":
        {
            "type": "list change",
            "removed": [],
            "added":
            [
                {"polygon": [[0, 0], [0, 1], [1, 1]], "text": "new note"}
            ]
        }
    }
}
```

--------------------------------

### Tag Category Snapshot Data Example

Source: https://github.com/rr-/szurubooru/blob/master/doc/API.md

Example of the 'data' field for a 'tag_category' resource creation snapshot.

```json
{
    "name":  "character",
    "color": "#FF0000",
    "default": false
}
```

--------------------------------

### Szurubooru .env configuration

Source: https://github.com/rr-/szurubooru/wiki/ARM-and-Raspberry-Pi-Support-for-Docker-builds

This is an example .env file for configuring Szurubooru. It includes settings for database credentials, build information, ports, and data storage directories. Remember to set appropriate permissions for the data directory.

```env
# Database credentials
POSTGRES_USER=[name]
POSTGRES_PASSWORD=[password]

# This shows up on the homescreen, indicating build information
BUILD_INFO=latest

# Port to expose HTTP service
PORT=[port]

# Directory to store image data
## remember to chmod this directory
MOUNT_DATA=/var/local/[name]/data

# Directory to store database files
MOUNT_SQL=/var/local/[name]/sql
```

--------------------------------

### Apache Configuration for Szurubooru

Source: https://github.com/rr-/szurubooru/wiki/Installation-without-Docker

Example Apache configuration for serving static content and proxying the API. Use this if Nginx is not preferred.

```apache
<VirtualHost *:80>
    ServerName example.com

    Redirect 302 /api /api/

    ProxyPreserveHost On
    ProxyPass /api/ http://127.0.0.1:6666/
    ProxyPassReverse /api/ http://127.0.0.1:6666/

    DocumentRoot "/srv/www/booru/client/public"
    FallbackResource /index.htm
    AllowEncodedSlashes On
</VirtualHost>
```

--------------------------------

### Search Query Example

Source: https://github.com/rr-/szurubooru/blob/master/doc/API.md

Demonstrates a search query combining multiple token types: anonymous, named, and sort tokens, with ranged values.

```text
sea -fav-count:8.. type:swf uploader:Pirate
```

--------------------------------

### Run Szurubooru Docker Container

Source: https://github.com/rr-/szurubooru/wiki/Customizing-UI-Colors

Start the Szurubooru Docker containers in detached mode after building the image.

```bash
docker-compose up -d
```

--------------------------------

### Create Pool Response

Source: https://context7.com/rr-/szurubooru/llms.txt

Example response after creating a pool, showing its assigned ID, version, names, category, associated posts with thumbnails, creation time, post count, and description.

```json
{
  "version": 1,
  "id": 5,
  "names": ["Nature Photography Tutorial", "nature_tutorial"],
  "category": "series",
  "posts": [
    {"id": 123, "thumbnailUrl": "/data/posts/123_thumb.jpg"},
    {"id": 124, "thumbnailUrl": "/data/posts/124_thumb.jpg"}
  ],
  "creationTime": "2024-01-20T16:00:00Z",
  "postCount": 4,
  "description": "Step-by-step guide to nature photography"
}
```

--------------------------------

### Getting Global Info

Source: https://github.com/rr-/szurubooru/blob/master/doc/API.md

Retrieves global statistics and server configuration information.

```APIDOC
## GET /info

### Description
Retrieves simple statistics about the server, including post count, disk usage, and featured post information. It also returns server configuration details.

### Method
GET

### Endpoint
/info

### Response
#### Success Response (200)
- **postCount** (integer) - The total number of posts.
- **diskUsage** (integer) - The total disk usage in bytes.
- **featuredPost** (object|null) - Information about the featured post, or null if none exists.
- **featuringTime** (string) - The time when the post was featured.
- **featuringUser** (string) - The user who featured the post.
- **serverTime** (string) - The current server time.
- **config** (object) - Server configuration details:
    - **userNameRegex** (string) - Regular expression for validating usernames.
    - **passwordRegex** (string) - Regular expression for validating passwords.
    - **tagNameRegex** (string) - Regular expression for validating tag names.
    - **tagCategoryNameRegex** (string) - Regular expression for validating tag category names.
    - **defaultUserRank** (integer) - The default user rank.
    - **privileges** (array) - An array of available privileges (keys are converted to lower camel case).

#### Response Example
```json
{
    "postCount": 12345,
    "diskUsage": 5432109876,
    "featuredPost": {
        "id": 100,
        "title": "Example Featured Post"
    },
    "featuringTime": "2023-10-27T10:00:00Z",
    "featuringUser": "admin",
    "serverTime": "2023-10-27T10:30:00Z",
    "config": {
        "userNameRegex": "^[a-zA-Z0-9_]{3,32}$",
        "passwordRegex": "^.{8,}$",
        "tagNameRegex": "^[a-z0-9]+$",
        "tagCategoryNameRegex": "^[a-z0-9_]+$",
        "defaultUserRank": 0,
        "privileges": [
            "view_posts",
            "upload_files"
        ]
    }
}
```
```

--------------------------------

### Get Server Information

Source: https://context7.com/rr-/szurubooru/llms.txt

Retrieves global server statistics, configuration details, and information about the featured post. Requires an 'Accept: application/json' header.

```bash
curl -X GET "http://localhost:8080/api/info" \
  -H "Accept: application/json"
```

--------------------------------

### Nginx Configuration for Szurubooru

Source: https://github.com/rr-/szurubooru/wiki/Installation-without-Docker

Example Nginx configuration to serve static files and proxy API requests. Ensure the API URL matches the config.yaml setting.

```nginx
server {
    listen 80;
    server_name example.com;

    location ~ ^/api$ {
        return 302 /api/;
    }
    location ~ ^/api/(.*)$ {
        if ($request_uri ~* "/api/(.*)") { # preserve PATH_INFO as-is
            proxy_pass http://127.0.0.1:6666/$1;
        }
    }
    location / {
        root /srv/www/booru/client/public;
        try_files $uri /index.htm;
    }
}
```

--------------------------------

### Run Szurubooru with Gunicorn

Source: https://github.com/rr-/szurubooru/wiki/Installation-without-Docker

Install Gunicorn and run the Szurubooru application using the gunicorn command. This is an alternative to Waitress for serving the WSGI application.

```bash
user@host:szuru/server$ source python_modules/bin/activate
(python_modules) user@host:szuru/server$ pip install gunicorn
(python_modules) user@host:szuru/server$ gunicorn szurubooru.facade:app -b 127.0.0.1:6666
```

--------------------------------

### Client Dockerfile for Szurubooru

Source: https://github.com/rr-/szurubooru/wiki/ARM-and-Raspberry-Pi-Support-for-Docker-builds

This Dockerfile builds the client component of Szurubooru using a multi-stage build process. It installs Node.js dependencies, builds the client, and then copies the static assets to an Nginx image.

```docker
FROM arm32v7/node:9 as builder
WORKDIR /opt/app

COPY package.json ./
RUN npm install

COPY . ./

ARG BUILD_INFO="docker-latest"
ARG CLIENT_BUILD_ARGS=""
RUN BASE_URL="__BASEURL__" node build.js --gzip ${CLIENT_BUILD_ARGS}


FROM tobi312/rpi-nginx:alpine
WORKDIR /var/www

RUN \
    # Create init file
    echo "#!/bin/sh" >> /init && \
    echo 'sed -i "s|__BACKEND__|${BACKEND_HOST}|" /etc/nginx/nginx.conf' >> /init && \
    echo 'sed -i "s|__BASEURL__|${BASE_URL:-/}|g" /var/www/index.htm /var/www/manifest.json' >> /init && \
    echo 'exec nginx' >> /init && \
    chmod a+x /init

CMD ["/init"]
VOLUME ["/data"]

COPY nginx.conf.docker /etc/nginx/nginx.conf
COPY --from=builder /opt/app/public/ .
```

--------------------------------

### Get Global Server Information

Source: https://github.com/rr-/szurubooru/blob/master/doc/API.md

Retrieves key statistics about the server, including post count, disk usage, and configuration details. The configuration values are directly from the server, with privilege keys converted to lower camel case.

```json
{
    "postCount": <post-count>,
    "diskUsage": <disk-usage>,
    "featuredPost": <featured-post>,
    "featuringTime": <time>,
    "featuringUser": <user>,
    "serverTime": <server-time>,
    "config": {
        "userNameRegex": <user-name-regex>,
        "passwordRegex": <password-regex>,
        "tagNameRegex": <tag-name-regex>,
        "tagCategoryNameRegex": <tag-category-name-regex>,
        "defaultUserRank": <default-rank>,
        "privileges": <privileges>
    }
}
```

--------------------------------

### Create Anonymous Post

Source: https://context7.com/rr-/szurubooru/llms.txt

Upload a new post anonymously if permitted by server configuration. This example uses multipart upload for an image and includes an 'anonymous: true' flag in the metadata.

```bash
curl -X POST "http://localhost:8080/api/posts/" \
  -H "Authorization: Basic dXNlcjE6cGFzc3dvcmQ=" \
  -F "content=@/path/to/image.png" \
  -F 'metadata={"tags": ["art"], "safety": "safe", "anonymous": true}'
```

--------------------------------

### Optimistic Locking Versioning Example

Source: https://github.com/rr-/szurubooru/blob/master/doc/API.md

When retrieving a resource, the server returns a version number. Clients must include this version number in subsequent PUT or DELETE requests to prevent concurrent modification issues.

```json
{
    "version": 2
}
```

--------------------------------

### Get Tag Siblings Response

Source: https://context7.com/rr-/szurubooru/llms.txt

Example response structure for the Get Tag Siblings API, listing related tags and their occurrence counts.

```json
{
  "results": [
    {"tag": {"names": ["landscape"], "category": "default", "usages": 89}, "occurrences": 78},
    {"tag": {"names": ["forest"], "category": "default", "usages": 45}, "occurrences": 42},
    {"tag": {"names": ["water"], "category": "default", "usages": 67}, "occurrences": 35}
  ]
}
```

--------------------------------

### Field Selection Query

Source: https://github.com/rr-/szurubooru/blob/master/doc/API.md

Example of a GET request utilizing the `fields` query parameter to retrieve only specific fields (id and tags) from the posts resource.

```http
GET /posts/?fields=id,tags
```

--------------------------------

### Docker Deployment: Clone and Configure

Source: https://context7.com/rr-/szurubooru/llms.txt

Steps to clone the Szurubooru repository, configure server settings, and set up the Docker environment variables.

```bash
# Clone repository
git clone https://github.com/rr-/szurubooru.git szuru
cd szuru

# Configure server
cp server/config.yaml.dist server/config.yaml
# Edit config.yaml - set secret key and SMTP settings

# Configure Docker environment
cp doc/example.env .env
# Edit .env - set PORT, BASE_URL, POSTGRES_PASSWORD, etc.
```

--------------------------------

### Compile Szurubooru Frontend

Source: https://github.com/rr-/szurubooru/wiki/Installation-without-Docker

Navigate to the client directory and run the build script. Use --no-transpile for older browser compatibility and --debug for source maps.

```bash
user@host:szuru$ cd client
user@host:szuru/client$ node build.js
```

--------------------------------

### Create User API (Registration)

Source: https://context7.com/rr-/szurubooru/llms.txt

Register a new user account by providing a username, password, and email address. This endpoint does not require authentication.

```bash
curl -X POST "http://localhost:8080/api/users/" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "newuser",
    "password": "securepassword123",
    "email": "newuser@example.com"
  }'
```

--------------------------------

### Create Post via URL

Source: https://context7.com/rr-/szurubooru/llms.txt

Upload a new post by providing a URL for the content. The server will download the content from the specified URL. Requires authentication and JSON Content-Type.

```bash
curl -X POST "http://localhost:8080/api/posts/" \
  -H "Content-Type: application/json" \
  -H "Authorization: Basic dXNlcjE6cGFzc3dvcmQ=" \
  -d '{ 
    "tags": ["video", "nature"],
    "safety": "safe",
    "contentUrl": "https://example.com/video.mp4"
  }'
```

--------------------------------

### Getting User

Source: https://github.com/rr-/szurubooru/blob/master/doc/API.md

Retrieves information about a specific user.

```APIDOC
## GET /user/<name>

### Description
Retrieves information about an existing user.

### Method
GET

### Endpoint
/user/<name>

### Parameters
#### Path Parameters
- **name** (string) - Required - The name of the user to retrieve.

### Response
#### Success Response (200)
- A [user resource](#user).

#### Errors
- the user does not exist
- privileges are too low
```

--------------------------------

### Create Post with Token

Source: https://context7.com/rr-/szurubooru/llms.txt

Use this endpoint to create a new post, including content token, with appropriate authorization headers.

```bash
curl -X POST "http://localhost:8080/api/posts/" \
  -H "Content-Type: application/json" \
  -H "Authorization: Basic dXNlcjE6cGFzc3dvcmQ=" \
  -d '{
    "tags": ["uploaded"],
    "safety": "safe",
    "contentToken": "deadbeef12345678"
  }'
```

--------------------------------

### Getting Pool API

Source: https://github.com/rr-/szurubooru/blob/master/doc/API.md

Retrieves information about an existing pool.

```APIDOC
## Getting pool

### Description
Retrieves information about an existing pool.

### Method
GET

### Endpoint
/pool/<id>

### Parameters
#### Path Parameters
- **id** (integer) - Required - The ID of the pool to retrieve.

### Response
#### Success Response (200)
- **pool resource** (object) - A representation of the pool.

#### Response Example
```json
{
  "id": 1,
  "version": 2,
  "names": ["My Pool", "Another Name"],
  "category": "General",
  "description": "This is a sample pool.",
  "posts": [101, 102, 103],
  "created_at": "2023-10-27T10:00:00Z",
  "updated_at": "2023-10-27T10:05:00Z"
}
```

### Errors
- the pool does not exist
- privileges are too low
```

--------------------------------

### Server Dockerfile for Szurubooru

Source: https://github.com/rr-/szurubooru/wiki/ARM-and-Raspberry-Pi-Support-for-Docker-builds

This Dockerfile sets up the server component for Szurubooru. It includes Python dependencies, system packages like ffmpeg, and configures a user for running the application. It uses a multi-stage build to minimize the final image size.

```docker
FROM scratch as approot
WORKDIR /opt/app

COPY alembic.ini wait-for-es generate-thumb ./
COPY szurubooru/ ./szurubooru/
COPY config.yaml.dist ./


FROM python:3.6-slim
WORKDIR /opt/app

ARG PUID=1000
ARG PGID=1000
ARG PORT=6666
RUN \
    # Set users
    mkdir -p /opt/app /data && \
    groupadd -g ${PGID} app && \
    useradd -d /opt/app -M -c '' -g app -r -u ${PUID} app && \
    chown -R app:app /opt/app /data && \
    # Create init file
    echo "#!/bin/sh" >> /init && \
    echo "set -e" >> /init && \
    echo "cd /opt/app" >> /init && \
    echo "./wait-for-es" >> /init && \
    echo "alembic upgrade head" >> /init && \
    echo "exec waitress-serve --port ${PORT} szurubooru.facade:app" 
        >> /init && \
    chmod a+x /init && \
    # Install ffmpeg
    apt-get -yqq update && \
    apt-get -yq install --no-install-recommends ffmpeg libpq-dev make gcc libffi-dev zlib1g-dev libjpeg-dev libtiff-dev libfreetype6-dev liblcms2-dev libwebp-dev tcl-dev && \
    rm -rf /var/lib/apt/lists/* && \
    # Install waitress
    pip3 install --no-cache-dir waitress

COPY --chown=app:app requirements.txt ./requirements.txt
RUN pip3 install --no-cache-dir -r ./requirements.txt

# done to minimize number of layers in final image
COPY --chown=app:app --from=approot / /

VOLUME ["/data/"]
EXPOSE ${PORT}
USER app
CMD ["/init"]
```

--------------------------------

### Create PostgreSQL User and Database

Source: https://github.com/rr-/szurubooru/wiki/Installation-without-Docker

Creates a new PostgreSQL user named 'szuru' with no superuser privileges and then creates a database owned by this user. A password is set for the user.

```console
user@host:~$ sudo -i -u postgres createuser --interactive
Enter name of role to add: szuru
Shall the new role be a superuser? (y/n) n
Shall the new role be allowed to create databases? (y/n) n
Shall the new role be allowed to create more new roles? (y/n) n
user@host:~$ sudo -i -u postgres createdb szuru
user@host:~$ sudo -i -u postgres psql -c "ALTER USER szuru PASSWORD 'dog';"
```

--------------------------------

### Getting Tag

Source: https://github.com/rr-/szurubooru/blob/master/doc/API.md

Retrieves detailed information about a specific tag.

```APIDOC
## Getting Tag

### Description
Retrieves information about an existing tag.

### Method
GET

### Endpoint
`/tag/<name>`

### Parameters
#### Path Parameters
- **name** (string) - Required - The name of the tag to retrieve.

### Response
#### Success Response (200)
- **tag resource** (object) - A tag resource object.

#### Response Example
```json
{
  "name": "example_tag",
  "version": 1,
  "names": ["example_tag"],
  "category": "general",
  "description": "An example tag.",
  "implications": [],
  "suggestions": []
}
```

### Errors
- the tag does not exist
- privileges are too low
```

--------------------------------

### Getting around post

Source: https://github.com/rr-/szurubooru/blob/master/doc/API.md

Retrieves information about posts that are before or after an existing post.

```APIDOC
## GET /post/<id>/around

### Description
Retrieves information about posts that are before or after an existing post.

### Method
GET

### Endpoint
/post/<id>/around

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the post.

### Response
#### Success Response (200)
- **prev** (post-resource) - Description of the previous post.
- **next** (post-resource) - Description of the next post.

#### Response Example
```json
{
  "prev":  null,
  "next":  {
    "id": "123",
    "created_at": "2023-01-01T10:00:00Z",
    "md5": "abcdef1234567890abcdef1234567890",
    "width": 1920,
    "height": 1080,
    "file_size": 1024000,
    "file_ext": "jpg",
    "source": "http://example.com/image.jpg",
    "is_favorited": false,
    "score": 5,
    "upitioners": 10,
    "downitioners": 5,
    "comment_count": 3,
    "tag_count": 15,
    "fav_count": 2,
    "uploader_id": "user123",
    "uploader_name": "ExampleUser",
    "created_at": "2023-01-01T10:00:00Z"
  }
}
```
```

--------------------------------

### Get Around Post

Source: https://github.com/rr-/szurubooru/blob/master/doc/API.md

Retrieves information about posts that are before or after an existing post.

```http
GET /post/<id>/around
```

--------------------------------

### Docker Deployment

Source: https://context7.com/rr-/szurubooru/llms.txt

Instructions for deploying Szurubooru using Docker Compose.

```APIDOC
## Docker Deployment

### Installation and Configuration
Deploy Szurubooru using Docker Compose with the server, client, and PostgreSQL database containers.

### Steps
1. **Clone the repository**:
   ```bash
   git clone https://github.com/rr-/szurubooru.git szuru
   cd szuru
   ```
2. **Configure the server**:
   ```bash
   cp server/config.yaml.dist server/config.yaml
   # Edit server/config.yaml - set secret key and SMTP settings
   ```
3. **Configure Docker environment variables**:
   ```bash
   cp doc/example.env .env
   # Edit .env - set PORT, BASE_URL, POSTGRES_PASSWORD, etc.
   ```
4. **Pull and start containers**:
   ```bash
   docker compose pull
   docker compose up -d sql       # Start database first
   docker compose up -d           # Start all services
   ```
5. **View logs**:
   ```bash
   docker compose logs -f
   ```
6. **Administrative tasks**:
   ```bash
   docker compose run server ./szuru-admin --help
   docker compose run server ./szuru-admin users create admin admin@example.com administrator
   docker compose run server ./szuru-admin users reset-password admin
   ```

### Configuration File Examples
#### `server/config.yaml`
```yaml
name: My Image Board
secret: your-secret-key-change-this
data_url: /data/
data_dir: /data/

database: postgresql://szuru:password@sql:5432/szuru

default_rank: regular
enable_safety: true
contact_email: admin@example.com

smtp:
  host: smtp.example.com
  port: 587
  user: notifications@example.com
  pass: smtp-password

privileges:
  'posts:create:identified': regular
  'posts:create:anonymous': power
  'posts:edit:tags': regular
  'posts:delete': moderator
  'tags:create': regular
  'users:create:any': administrator
```

#### `.env`
```ini
PORT=:8080
BASE_URL=/
POSTGRES_USER=szuru
POSTGRES_PASSWORD=secure-db-password
POSTGRES_DB=szuru
DATA_DIR=./data
```
```

--------------------------------

### Getting Pool Category

Source: https://github.com/rr-/szurubooru/blob/master/doc/API.md

Retrieves information about a specific pool category by its name.

```APIDOC
## Getting pool category

### Description
Retrieves information about an existing pool category.

### Method
GET

### Endpoint
`/pool-category/<name>`

### Parameters
#### Path Parameters
- **name** (string) - Required - The name of the pool category to retrieve.

### Response
#### Success Response (200)
- **pool category resource** (object) - A representation of the pool category.

#### Response Example
```json
{
  "id": 1,
  "name": "example_category",
  "color": "#00FF00",
  "version": 1
}
```

### Errors
- the pool category does not exist
- privileges are too low
```

--------------------------------

### Getting Tag Category

Source: https://github.com/rr-/szurubooru/blob/master/doc/API.md

Retrieves information about a specific tag category by its name.

```APIDOC
## Getting tag category

### Description

Retrieves information about an existing tag category.

### Method

`GET`

### Endpoint

`/tag-category/<name>`

### Parameters

#### Path Parameters

- **name** (string) - Required - The name of the tag category to retrieve.

### Errors

- the tag category does not exist
- privileges are too low
```

--------------------------------

### Configure Szurubooru Settings

Source: https://github.com/rr-/szurubooru/wiki/Installation-without-Docker

Copy the distribution configuration file and edit it. Pay close attention to data directory, data URL, database settings, and the SMTP section.

```bash
user@host:szuru/client$ cd ..
user@host:szuru$ mv server/config.yaml.dist .
user@host:szuru$ cp config.yaml.dist config.yaml
user@host:szuru$ vim config.yaml
```

--------------------------------

### Getting Post API

Source: https://github.com/rr-/szurubooru/blob/master/doc/API.md

This endpoint retrieves information about a specific post using its ID.

```APIDOC
## GET /post/<id>

### Description
Retrieves information about an existing post.

### Method
GET

### Endpoint
/post/<id>

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the post to retrieve.

### Response
#### Success Response (200)
- **post resource** - A post resource object.

#### Response Example
```json
{
  "example": "response body"
}
```

### Errors
- the post does not exist
- privileges are too low
```

--------------------------------

### Create User

Source: https://github.com/rr-/szurubooru/blob/master/doc/API.md

Use this endpoint to create a new user. Names and passwords must adhere to server configuration regex. Email, rank, and avatar are optional. 'manual' avatar style requires an 'avatar' file.

```json
{
    "name":        <user-name>,
    "password":    <user-password>,
    "email":       <email>,
    "rank":        <rank>,
    "avatarStyle": <avatar-style>   // optional
}
```

--------------------------------

### Build Docker Containers

Source: https://github.com/rr-/szurubooru/blob/master/doc/INSTALL.md

Build the Docker containers from source using Docker Compose.

```bash
user@host:szuru$ docker compose build
```

--------------------------------

### Monitor Application Logs

Source: https://github.com/rr-/szurubooru/blob/master/doc/INSTALL.md

View and monitor the application logs in real-time. Press CTRL+C to exit.

```bash
user@host:szuru$ docker compose logs -f
# (CTRL+C to exit)
```

--------------------------------

### GET /posts/

Source: https://github.com/rr-/szurubooru/blob/master/doc/API.md

Searches for posts with various filtering options. Supports pagination through offset and limit parameters.

```APIDOC
## GET /posts/

### Description
Searches for posts. Supports filtering by various criteria including tags, uploader, score, and more. Pagination is handled via `offset` and `limit` query parameters.

### Method
GET

### Endpoint
/posts/

### Query Parameters
- **offset** (integer) - Optional - The starting position for the search results.
- **limit** (integer) - Optional - The maximum number of results to return per page.
- **query** (string) - Optional - The search query string. This can include various named tokens for filtering.

### Named Tokens for Query Parameter:
- **id** (integer) - having given post number
- **tag** (string) - having given tag (accepts wildcards)
- **score** (integer) - having given score
- **uploader** (string) - uploaded by given user (accepts wildcards)
- **upload** (string) - alias of upload
- **submit** (string) - alias of upload
- **comment** (string) - commented by given user (accepts wildcards)
- **fav** (string) - favorited by given user (accepts wildcards)
- **pool** (integer) - belonging to the pool with the given ID
- **tag-count** (integer) - having given number of tags
- **comment-count** (integer) - having given number of comments
- **fav-count** (integer) - favorited by given number of users
- **note-count** (integer) - having given number of annotations
- **note-text** (string) - having given note text (accepts wildcards)
- **relation-count** (integer) - having given number of relations
- **feature-count** (integer) - having been featured given number of times
- **type** (string) - given type of posts. `<value>` can be either `image`, `animation` (or `animated` or `anim`), `flash` (or `swf`) or `video` (or `webm`).
- **content-checksum** (string) - having given SHA1 checksum
- **file-size** (integer) - having given file size (in bytes)
- **image-width** (integer) - having given image width (where applicable)
- **image-height** (integer) - having given image height (where applicable)
- **image-area** (integer) - having given number of pixels (image width * image height)
- **image-aspect-ratio** (number) - having given aspect ratio (image width / image height)
- **image-ar** (number) - alias of `image-aspect-ratio`
- **width** (integer) - alias of `image-width`

### Response
#### Success Response (200)
- **resource** (object) - A paged search result resource, where each item is a post resource.

#### Error Response (e.g., 403)
- **error** (string) - Indicates that privileges are too low.
```

--------------------------------

### Get User Profile

Source: https://context7.com/rr-/szurubooru/llms.txt

Retrieves the profile information for a specified user. Requires the user's name.

```bash
curl -X GET "http://localhost:8080/api/user/newuser" \
  -H "Accept: application/json"
```

--------------------------------

### Szurubooru Python Dependencies

Source: https://github.com/rr-/szurubooru/wiki/ARM-and-Raspberry-Pi-Support-for-Docker-builds

This file lists the Python package dependencies required for Szurubooru. Ensure these are installed in your environment.

```python
alembic>=0.8.5
pyyaml>=3.11
psycopg2-binary>=2.6.1
SQLAlchemy>=1.0.12
coloredlogs==5.0
elasticsearch>=5.0.0
elasticsearch-dsl>=5.0.0
numpy>=1.8.2
pillow>=4.3.0
pynacl==1.2.1
pytz>=2018.3
pyRFC3339>=1.0
```

--------------------------------

### Getting featured post

Source: https://github.com/rr-/szurubooru/blob/master/doc/API.md

Retrieves the post that is currently featured on the main page. Returns null if no post is featured.

```APIDOC
## GET /featured-post

### Description
Retrieves the post that is currently featured on the main page in web client. If no post is featured, `<post>` is null. Note that this method exists mostly for compatibility with setting featured post - most of times, you'd want to use query global info which contains more information.

### Method
GET

### Endpoint
/featured-post

### Response
#### Success Response (200)
- (post resource or null) - The featured post resource, or null if none is featured.

#### Response Example
```json
{
  "id": "456",
  "created_at": "2023-01-02T11:00:00Z",
  "md5": "fedcba0987654321fedcba0987654321",
  "width": 1024,
  "height": 768,
  "file_size": 512000,
  "file_ext": "png",
  "source": "http://example.com/featured.png",
  "is_favorited": false,
  "score": 10,
  "upitioners": 20,
  "downitioners": 10,
  "comment_count": 5,
  "tag_count": 20,
  "fav_count": 5,
  "uploader_id": "user456",
  "uploader_name": "FeaturedUser",
  "created_at": "2023-01-02T11:00:00Z"
}
```
```

--------------------------------

### Get Featured Post

Source: https://github.com/rr-/szurubooru/blob/master/doc/API.md

Retrieves the post currently featured on the main page. Returns null if no post is featured.

```http
GET /featured-post
```