Repository navigation
Docker_uk
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/Kyiv
- TINYOPDS_LANGUAGE=uk
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/Kyiv -e TINYOPDS_LANGUAGE=uk \
--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/Kyiv
|
/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 (шляхи до книг зберігаються відносно цієї папки). На час копіювання зупиніть контейнер.