# Installation Guide

## System Requirements

- **OS:** Windows 10+, macOS 10.13+, Linux kernel 3.x+
- **RAM:** 512 MB or higher
- **Disk Space:** 512 MB minimum + additional space for data

## Prerequisites

- Python 3.13 or higher
- ffmpeg 2026-01-29 (required if you intend to store video files)
- git (optional)

## Instructions

Once you have installed the required software, you need to configure the booru.

### Downloading the package

You have two options depending on whether you have git installed:

#### Using CLI (recommended)
Run the following command in the folder where the site will be located:
`git clone https://git.nekono.su/Nyako/Local-Booru.git .`

#### Using the website
1. Download the archive by clicking the buttons shown below:

   ![1](./img/1.png)

   ![2](./img/2.png)

2. Extract the archive into the folder where the site will be hosted.

### Installing dependencies

In the terminal, navigate to the folder where the site is located and run:
```bash
pip install uv
uv sync
```

### Configuring `config.json`

Config explanation:

| Key | Default | Description |
| :--- | :--- | :--- |
| `server`-`host` | `"127.0.2.1"` | Server host address |
| `server`-`port` | `80` | Server port |
| `server`-`count_page` | `25` | Number of items per page |
| `server`-`thumb_size` | `250` | Thumbnail size (pixels, long side) |
| `gb`-`id` | `""` | Gelbooru User ID |
| `gb`-`hash` | `""` | Gelbooru User Hash |
| `file`-`repos` | `["data/files"]` | List of directories where source files are stored |
| `file`-`dw` | `"data/files"` | Directory for new downloads |
| `file`-`thumb` | `"data/thumb"` | Directory for thumbnails |
| `file`-`data` | `"data"` | Directory for database |

1. You must obtain your Gelbooru User ID and Hash and add them to the config file for the system to function correctly.
2. Install the script in [VioletMonkey](https://git.nekono.su/Nyako/Local-Booru/raw/branch/main/button_script.user.js).

#### If you changed the Host or Port:
- Open any post.
- Update the base URL in the script configuration to match your custom settings.

### Launch

Simply run: `uv run run.py`