Repository navigation
Docker_ru
TinyOPDS CLI доступен в виде Docker-образа для NAS (Synology, QNAP и т.п.) и любого Linux с Docker, для процессоров amd64 (Intel/AMD) и arm64. Это тот же сервер, что и на Windows: OPDS-каталог, веб-интерфейс со встроенной читалкой, поиск, конвертация в EPUB и MOBI, только без окна — всё задаётся настройками контейнера.
Образ: sensboston/tinyopds на Docker Hub, копия — ghcr.io/sensboston/tinyopds (если Docker Hub недоступен).
Бета. Что проверено, а что нет. У автора нет NAS, поэтому образ не проверялся на настоящих Synology, QNAP и других NAS. Каждая сборка проходит автоматические тесты на Linux amd64 и arm64 (сканирование, поиск, дубликаты, скачивание книг, веб-интерфейс, права на папку данных, слежение за папкой, пароли), а сам образ установлен и проверен в демо-версии CasaOS. Если вы запустили его на NAS, пожалуйста, создайте issue или напишите в теме на форуме: модель NAS, версия ОС, количество книг, время первого сканирования и, если что-то не так, лог контейнера.
Нужны две папки:
- библиотека — ваши книги: FB2, EPUB, ZIP-архивы (в том числе Флибуста и Либрусек), можно с подпапками. TinyOPDS её только читает;
-
папка данных — сюда TinyOPDS кладёт настройки (
TinyOPDS.config), базу (books.sqlite) и лог. Её сохраняйте: тогда после обновления образа библиотека не пересканируется с нуля.
Примеры путей (подставьте свои):
| Система | Библиотека | Папка данных |
|---|---|---|
| Synology | /volume1/books |
/volume1/docker/tinyopds (создайте docker и tinyopds в File Station) |
| QNAP | /share/Books |
/share/Container/tinyopds |
| CasaOS / ZimaOS | /DATA/Media/Books |
/DATA/AppData/tinyopds |
Сервер работает от имени пользователя NAS с номером PUID и группой PGID, чтобы файлы в папке данных принадлежали этому пользователю, а не root. Чтобы их узнать, зайдите на NAS по SSH под этим пользователем и выполните
id
Ответ вида uid=1026(user) gid=100(users) означает PUID=1026, PGID=100. На Synology у первого созданного пользователя обычно именно 1026 и 100. У пользователя должен быть доступ на чтение к библиотеке и на запись к папке данных.
Этот текст используется всеми способами установки ниже. Поменяйте папки слева в volumes, PUID/PGID и, если нужно, порт.
services:
tinyopds:
image: sensboston/tinyopds:latest
container_name: tinyopds
ports:
- "8080:8080"
volumes:
- /volume1/books:/books:ro
- /volume1/docker/tinyopds:/data
environment:
- PUID=1026
- PGID=100
- TZ=Europe/Moscow
- TINYOPDS_LANGUAGE=ru
restart: unless-stopped-
ports: левое число — порт на NAS, правое (8080) не трогайте. Если 8080 занят, пишите, например,"8090:8080". На QNAP порт 8080 по умолчанию занят веб-интерфейсом QTS — там сразу ставьте другой. -
volumes: слева ваши папки, справа (/booksи/data) не трогайте.:ro— библиотека только для чтения. - Если Docker Hub недоступен, используйте образ
ghcr.io/sensboston/tinyopds:latest.
- Центр пакетов → установить Container Manager.
- Container Manager → Проект → Создать.
- Имя проекта:
tinyopds, путь: папка данных (например,/docker/tinyopds). - Источник: Создать docker-compose.yml → вставить текст из шага 3.
- Далее → (настройки Web Station можно пропустить) → Готово. Образ скачается, контейнер запустится.
Если DSM предупредит о брандмауэре — разрешите выбранный порт.
В DSM 6 нет проектов (compose), всё настраивается в диалогах:
- Docker → Реестр → поиск
sensboston/tinyopds→ Загрузить → тегlatest. -
Образ → выбрать
sensboston/tinyopds→ Запуск → Дополнительные настройки. - Включить автоматический перезапуск.
-
Том → Добавить папку: библиотека → путь монтирования
/books, только чтение; папка данных →/data. - Параметры порта: локальный порт 8080 (или другой) → порт контейнера 8080.
-
Среда → добавить
PUID,PGID,TZ,TINYOPDS_LANGUAGE(значения как в шаге 3). - Применить → Далее → Готово.
- App Center → установить Container Station.
- Container Station → Приложения (Applications) → Создать.
- Имя:
tinyopds, вставить текст из шага 3 (с путями/share/...и другим портом вместо 8080, например"8090:8080"). - Создать. Образ скачается, контейнер запустится.
На главной «+» → Install a customized app → значок импорта справа вверху → вкладка Docker Compose → вставить текст из шага 3 и добавить в конец блок ниже (иконка и название в CasaOS) → Submit → Install.
x-casaos:
main: tinyopds
title:
en_us: TinyOPDS
icon: https://raw.githubusercontent.com/sensboston/tinyopds/master/TinyOPDS/TinyOPDS.png
port_map: "8080"В port_map — тот же порт, что слева в ports.
Stacks → Add stack → вставить текст из шага 3 → Deploy the stack.
В папке с docker-compose.yml:
sudo docker compose up -d
или без compose-файла:
sudo docker run -d --name tinyopds -p 8080:8080 \
-v /volume1/books:/books:ro -v /volume1/docker/tinyopds:/data \
-e PUID=1026 -e PGID=100 -e TZ=Europe/Moscow -e TINYOPDS_LANGUAGE=ru \
--restart unless-stopped sensboston/tinyopds:latest
При каждом запуске контейнер сканирует библиотеку: в первый раз индексирует все книги, потом — только новые. Сервер отвечает уже во время сканирования, книги появляются по мере обработки. Ход сканирования виден в логе контейнера (строка раз в 30 секунд).
Сколько займёт первое сканирование на NAS, пока неизвестно: на ПК библиотека Флибусты (около 600 тысяч книг) сканируется за пару часов, на NAS с Celeron/N100 и жёсткими дисками будет дольше, на ARM — ещё дольше. Сообщите своё время, пожалуйста.
Дальше:
- веб-интерфейс:
http://<адрес NAS>:8080/ - OPDS-каталог для читалок (KOReader, Moon+ Reader, FBReader, PocketBook и т.д.):
http://<адрес NAS>:8080/opds
(8080 замените на свой порт, если меняли)
Новые книги просто копируйте в папку библиотеки — примерно через 30 секунд после окончания копирования они появятся сами, перезапуск не нужен. Удалённые и переименованные файлы тоже отслеживаются. Если библиотека лежит на сетевой папке другого компьютера (там слежение за папкой изменений не видит), раз в сутки выполняется полное пересканирование.
Получите зашифрованную строку с пользователями (одна или несколько пар логин/пароль), по SSH на NAS:
sudo docker run --rm sensboston/tinyopds encred user1 password1 user2 password2
и добавьте в environment две строки:
- TINYOPDS_USEHTTPAUTH=true
- TINYOPDS_CREDENTIALS=<строка, которую выдала команда>Затем пересоздайте контейнер (Container Manager: проект → Действие → Собрать; QNAP: приложение → Обновить; командная строка: sudo docker compose up -d).
Любая настройка из TinyOPDS.config задаётся переменной окружения TINYOPDS_<ИМЯ НАСТРОЙКИ> большими буквами. Полезные:
| Переменная | По умолчанию | Назначение |
|---|---|---|
TINYOPDS_LANGUAGE |
en |
Язык интерфейса и веб-сайта: en, ru, uk, de, fr, es, pl
|
TINYOPDS_SERVERNAME |
Название библиотеки | |
TINYOPDS_DARKTHEMEONWEB |
false |
Тёмная тема веб-интерфейса |
TINYOPDS_ROOTPREFIX |
opds |
Путь OPDS-каталога |
TINYOPDS_ITEMSPEROPDSPAGE |
100 |
Элементов на странице OPDS |
TINYOPDS_WATCHLIBRARY |
true |
Слежение за папкой библиотеки: новые, переименованные и удалённые книги |
TINYOPDS_SCAN_INTERVAL_HOURS |
24 |
Интервал полного пересканирования в часах, 0 — выключить |
TZ |
UTC |
Часовой пояс, например Europe/Moscow
|
/data/TinyOPDS.config можно править и напрямую, но только при остановленном контейнере; переменные окружения главнее файла.
Чтобы добавлять книги из веб-интерфейса (см. Загрузка книг), добавьте в environment строку TINYOPDS_ENABLEUPLOADS=true (и TINYOPDS_MAXUPLOADSIZEMB, если нужен предел размера, отличный от 20 МБ) и уберите :ro у папки библиотеки: загруженные книги сохраняются в её подпапку Uploads, поэтому пользователю из PUID нужны права на запись в библиотеку.
Скачайте новый образ и пересоздайте контейнер:
- Synology DSM 7: Container Manager сам покажет, что есть обновление; или проект → Действие → Остановить, Образ → обновить, проект → Собрать;
- QNAP: приложение → Обновить;
- командная строка:
sudo docker compose pull && sudo docker compose up -d.
База и настройки в папке данных сохраняются. Некоторые релизы просят пересканировать библиотеку с нуля — см. описание релиза.
Большую библиотеку можно отсканировать TinyOPDS на Windows (так быстрее) и положить books.sqlite в папку данных на NAS. Архивы должны лежать в корне папки библиотеки и на ПК, и на NAS (пути к книгам хранятся относительно этой папки). На время копирования остановите контейнер.