Розширений посібник
Розширене та точне налаштування
Щоб переглянути параметри запуску, в командному рядку наберіть ./flibgolite -help
Використання: flibgolite [ПАРАМЕТР] [каталог даних]
Без ПАРАМЕТРІВ програма працюватиме в режимі консолі (Ctrl+C для виходу)
Застереження: одночасно можна використовувати лише один ПАРАМЕТР
ПАРАМЕТР повинен бути одним з:
-service [дія] - управління системним сервісом FLibGoLite
де дія одна з:
install (установити),
start (запустити),
stop (зупинити),
restart (перезапустити),
uninstall (видалити),
status (статус)
-reindex - очистити каталог, а потім сканувати папку з книгами, щоб наново додати книги до бази даних
-config - створити файл конфігурації за промовчанням у папці ./config для налаштування
-help - відобразити цю довідку
-version - вивести інформацію про версію
каталог даних - необов'язковий (типовим є поточний каталог)
Приклади:
Зрозумілий файл конфігурації config.yml із деревом папок створюється під час першого запуску програми. Цей файл зберігається в підпапці config розташування програми. Для розширеного налаштування його можна редагувати.
За замовчуванням такий:
library:
# Book folders
STOCK: "books/stock" # Book stock
TRASH: "books/trash" # Error and duplicate files and archives will be moved to this folder
#NEW: "books/new" # Uncomment the line to have separate folder for new acquired books
genres:
TREE_FILE: "config/genres.xml"
database:
DSN: "dbdata/books.db"
# Delay before start each new acquisitions folder processing
POLL_DELAY: 30
# Maximum parallel new acquisitions processing routines
MAX_SCAN_THREADS: 10
# Book queue size
BOOK_QUEUE_SIZE: 1000
# File queue size
FILE_QUEUE_SIZE: 1000
# Maximum number of books in one transaction
MAX_BOOKS_IN_TX: 1000
logs:
# Logs are here
# To redirect the log output to console (stdout) just comment out the appropriate line OPDS or SCAN
OPDS: "logs/opds.log"
SCAN: "logs/scan.log"
# Logging levels: D - debug, I - info, W - warnings (default), E - errors
LEVEL: "W"
opds:
# OPDS-server port so opds can be found at http://<server name or IP-address or localhost>:8085/opds
PORT: 8085
# OPDS-server title that is displayed in a book reader
TITLE: "FLib Go Go Go!!!"
# OPDS feeds entries page size
PAGE_SIZE: 30
# Do not convert FB2 to EPUB format
#NO_CONVERSION: true
locales:
# Locales folder. You can add your own locale file there like en.yml, ru.yml, uk.yml
DIR: "config/locales"
# Default english locale for opds feeds (bookreaders opds menu tree) can be changed to:
# "uk" for Ukrainian,
# "ru" for Russian
DEFAULT: "en"
# Accept only these languages publications. Add others if needed please.
ACCEPTED: "en, ru, uk"Щоб змінити розташування папки, просто відредагуйте відповідний рядок в config.yml
Наприклад, якщо потрібно створити окрему папку для нових придбаних книг, розкоментуйте рядок
NEW: "books/new"та замініть books/new на відповідний шлях до папки.
Ви можете змінити HTTP-порт OPDS за замовчуванням 8085 на свій
# OPDS-server port so opds can be found at http://<server name or IP-address>:8085/opds
PORT: 8085Тут можна встановити бажане ім’я сервера OPDS
# OPDS-server title that is displayed in a book reader
TITLE: "FLib Go Go Go!!!"Ви можете змінити кількість книг, які ваша читалка завантажуватиме за раз під час прогортання сторінки (оновлення екрана)
# OPDS feeds entries page size
PAGE_SIZE: 30Не встановлюйте це значення більше, ніж за замовчуванням. З меншими значеннями він оновлюється швидше.
Ви можете вимкнути миттєве перетворення FB2 у формат EPUB, просто розкоментуйте рядок, щоб встановити для NO_CONVERSION значення true.
# Do not convert FB2 to EPUB format
NO_CONVERSION: trueДля додаткової локалізації є кілька простих налаштувань.
4.1. За замовчуванням обробка нових книг обмежена англійськими, українськими та руськими книгами. Ви можете розширити цей перелік, додавши потрібні
теги IETF
, такі як de, fr, it тощо.
# Accept only these languages publications. Add others if needed please.
ACCEPTED: "en, ru, uk"4.2. За замовчуванням читалка буде відображати меню і коментарі англійською мовою en. Якщо хочете українською, можете змінити цей параметр на uk.
# Default english locale for opds feeds (bookreaders opds menu tree) can be changed to:
# "uk" for Ukrainian,
# "ru" for Russian
DEFAULT: "en"5.1. Список книг зберігається у файлі books.db бази даних SQLite, розташованому в папці dbdata.
DSN: "dbdata/books.db"Обережно
Файл бази даних створюється при першому запуску програми і не підтримує редагування
5.2. У разі втрати або пошкодження файл бази даних може бути відновлено командою
Це може тривати деякий час.
5.3. Процес реєстрації нових надходжень зображено на діаграмі
У більшості випадків процес реєстрації нових придбань не вимагає налаштування, оскільки його швидкість визначається в основному продуктивністю системи введення-виведення (контролерами, типами дисків тощо). За необхідності змінити роботу процесу можна такими налаштуваннями:
# Delay before start each new acquisitions folder processing
POLL_DELAY: 30
# Maximum parallel new acquisitions processing routines
MAX_SCAN_THREADS: 10
# Book queue size
BOOK_QUEUE_SIZE: 1000
# File queue size
FILE_QUEUE_SIZE: 1000
# Maximum number of books in one transaction
MAX_BOOKS_IN_TX: 1000При роботі сервіс записує журнали opds.log та scan.log, розташовані в папці logs.
OPDS: "logs/opds.log"
SCAN: "logs/scan.log"opds.log містить записи про запити читалок.
scan.log містить записи про нові книги та індексацію архіву.
Щоб перенаправити виведення журналу на консоль (stdout), просто закоментуйте відповідний рядок OPDS або SCAN.
Немає необхідності видаляти журнали, щоб звільнити місце на диску, оскільки журнали змінюються (перезаписуються) через 7 днів.
Ви можете налаштувати рівень ведення журналу (подробиця) на один із можливих значень: D - налагодження, I - інформація, W - попередження (за замовчуванням), E - помилки
LEVEL: "W"Пропозиції, повідомлення про помилки та коментарі вітаються тут