# Инструкция по установке

## Системные требования

- **OC:** Windows 10+, macOS 10.13+, Linux kernel 3.x+
- **ОЗУ:** 512 МБ и выше
- **Диск:** 512 МБ минимум + место под данные

## Установка и запуск

Мы предлагаем два способа установки и запуска:

- Через uv (Рекомендуеться для Windows)
- Через Docker (Рекомендуеться для Linux)

### Установка через UV

1. Подготовка необходимых программ
   - Python 3.13 и выше
   - ffmpeg 2026-01-29
   - git (по желанию)
2. Скачиваем галерею
   - Если установлен git:
      ```bash
      git clone https://git.nekono.su/Nyako/Local-Booru.git
      cd Local-Booru
      ```
   - Если git не установлен:
      ![1](./img/1.png)
      ![2](./img/2.png)
      Делаем распаковку в папку где будет сайт и открываем корневую папку в CMD
3. Производим установку зависимостей
   ```bash
   pip install uv
   uv sync
   ```
4. При успешной устанвке производим 
   ```bash
   uv run run.py
   ```

### Установка через Docker

1. Подготовка необходимых программ
   ```bash
   apt-get update && apt-get install
   apt-get install git
   ```
2. Клонирование репозитория
   ```bash
   git clone https://git.nekono.su/Nyako/Local-Booru.git
   cd Local-Booru
   ```
3. Отредактируйте файл config.json. Вставив всё необходимое.
4. Запустите галерею
   ```bash
   docker compose up --build
   ```

## Объяснение config.json

Объяснение конфига:

| Ключ | По умолчанию | Пояснение | Заметки |
|----------|----------|----------| - |
| `server`-`host` | `"127.0.2.1"` | Хост запуска сервера | Игнорируеться в docker |
| `server`-`port` | `80` | Порт запуска сервера | Игнорируеться в docker |
| `server`-`count_page` | `25` | Количество элементов на странице | - |
| `server`-`thumb_size` | `250` | Размер превью в пикселях по широкой стороне | - |
| `gb`-`id` | `""` | ID пользователя Gelbooru | - |
| `gb`-`hash` | `""` | Hash пользователя Gelbooru | - |
| `file`-`repos` | `["data/files"]` | Список каталогов где храняться полные файлы | - |
| `file`-`dw` | `"data/files"` | Каталог хранения загрузок | - |
| `file`-`thumb` | `"data/thumb"` | Каталог обложек | - |
| `file`-`data` | `"data"` | Каталог базы данных | - |

## Скрипт для браузера 

1. Обязательно надо получить ID и Hash пользователя и внести в конфиг для работы!
2. Установить скрипт в [VioletMonkey](https://git.nekono.su/Nyako/Local-Booru/raw/branch/main/button_script.user.js)
3. Если вы меняли Host или Port либо делаете запуск через Docker
   - Открыть любой пост
   - Ввести корневой путь в конфигурации скрипта на тот что у вас