diff --git a/README.md b/README.md index a3328c6..9c74447 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,5 @@ # Local-Booru -Version Naming Rules: +## [ENGLISH README](doc/readme_en.md) | [РУССКИЙ README](doc/readme_ru.md) -[Version Code][Version Type] - -All technical versions are designated as snapshots (s) - -All test versions are designated as beta (b) - -All pre-release and release versions are designated as release candidate and release (rc, r) - -## AI Usage Disclaimer - -Files in the "template" folder may be entirely or partially generated by AI. \ No newline at end of file +## [INSTALL INSRUCTION](doc/readme_en.md) | [ИНСТРУКЦИЯ ПО УСТАНОВКЕ](doc/readme_ru.md) \ No newline at end of file diff --git a/doc/img/1.png b/doc/img/1.png new file mode 100644 index 0000000..16318c3 Binary files /dev/null and b/doc/img/1.png differ diff --git a/doc/img/2.png b/doc/img/2.png new file mode 100644 index 0000000..2bd8dfa Binary files /dev/null and b/doc/img/2.png differ diff --git a/doc/install_en.md b/doc/install_en.md new file mode 100644 index 0000000..6a583ac --- /dev/null +++ b/doc/install_en.md @@ -0,0 +1,63 @@ +# 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.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](./doc/img/1.png) + ![2](./doc/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: +`pip install -r requirements.txt` + +### 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 | + +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: `python run.py` \ No newline at end of file diff --git a/doc/install_ru.md b/doc/install_ru.md new file mode 100644 index 0000000..567a2cf --- /dev/null +++ b/doc/install_ru.md @@ -0,0 +1,69 @@ +## Системные требования + +OC: Windows 10+, macOS 10.13+, Linux kernel 3.x+ +ОЗУ: 512 МБ и выше +Диск: 512 МБ минимум + место под данные + +## Требуеться заранее установить + +- Python 3.13.13 и выше +- ffmpeg 2026-01-29 (Если вы будете хранить видео) +- git (по желанию) + +## Инструкиция + +Приготовив все программы вам надо настроить booru + +### Скачиваем пакет + +У вас есть два варианта в зависимости от установленного git + +#### Используя CLI сделать в папке где будет размещен сайт + +`git clone https://git.nekono.su/Nyako/Local-Booru.git .` + +#### Используя веб-сайт + +1. Скачиваем по кнопке: + +![1](./doc/img/1.png) + +![2](./doc/img/2.png) + +2. Делаем распаковку в папку где будет сайт + +### Производим установку зависимостей + +Используя CLI сделать в папке где будет размещен сайт + +`pip install -r requirements.txt` + +### Делаем конфигурацию файла config.json + +Объяснение конфига: + +| Ключ | По умолчанию | Пояснение | +|----------|----------|----------| +| `server`-`host` | `"127.0.2.1"` | Хост запуска сервера | +| `server`-`port` | `80` | Порт запуска сервера | +| `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"` | Каталог обложек | + +1. Обязательно надо получить ID и Hash пользователя и внести в конфиг для работы! + +2. Установить скрипт в VioletMonkey [отсюда](https://git.nekono.su/Nyako/Local-Booru/raw/branch/main/button_script.user.js) + +#### Если вы меняли Host или Port + +- Открыть любой пост + +- Ввести корневой путь в конфигурации скрипта на тот что у вас + +### Запуск + +Просто выполните `python run.py` \ No newline at end of file diff --git a/doc/readme_en.md b/doc/readme_en.md new file mode 100644 index 0000000..acb083f --- /dev/null +++ b/doc/readme_en.md @@ -0,0 +1,15 @@ +## Remarque + +Version Naming Rules: + +[Version Code][Version Type] + +All technical versions are designated as snapshots (s) + +All test versions are designated as beta (b) + +All pre-release and release versions are designated as release candidate and release (rc, r) + +## AI Usage Disclaimer + +Files in the "template" folder may be entirely or partially generated by AI. \ No newline at end of file diff --git a/README_ru.md b/doc/readme_ru.md similarity index 97% rename from README_ru.md rename to doc/readme_ru.md index f7020ce..f47113f 100644 --- a/README_ru.md +++ b/doc/readme_ru.md @@ -1,4 +1,4 @@ -# Local-Booru +## Ремарка Правила найменования версий: diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..2e05249 --- /dev/null +++ b/requirements.txt @@ -0,0 +1,14 @@ +blinker==1.9.0 +certifi==2026.5.20 +charset-normalizer==3.4.7 +click==8.4.1 +colorama==0.4.6 +Flask==3.1.3 +idna==3.17 +itsdangerous==2.2.0 +Jinja2==3.1.6 +MarkupSafe==3.0.3 +pillow==12.2.0 +requests==2.34.2 +urllib3==2.7.0 +Werkzeug==3.1.8