Розширений посібник

Розширене та точне налаштування

Параметри запуску  

Щоб переглянути параметри запуску, в командному рядку наберіть ./flibgolite -help

Використання: flibgolite [ПАРАМЕТР] [каталог даних]

Без ПАРАМЕТРІВ програма працюватиме в режимі консолі (Ctrl+C для виходу)
Застереження: одночасно можна використовувати лише один ПАРАМЕТР

ПАРАМЕТР повинен бути одним з:
  -service [дія] - управління системним сервісом FLibGoLite
    де дія одна з:
      install (установити),
      start (запустити),
      stop (зупинити),
      restart (перезапустити),
      uninstall (видалити),
      status (статус)
  -reindex - очистити каталог, а потім сканувати папку з книгами, щоб наново додати книги до бази даних
  -config - створити файл конфігурації за промовчанням у папці ./config для налаштування
  -help - відобразити цю довідку
  -version - вивести інформацію про версію

каталог даних - необов'язковий (типовим є поточний каталог)

Приклади:

flibgolite                     #Запустіть FLibGoLite у консольному режимі

flibgolite -service install    #Встановити FLibGoLite як системну службу
flibgolite -service start      #Запустити службу FLibGoLite

./flibgolite                          #Запустіть FLibGoLite у консольному режимі

sudo ./flibgolite -service install    #Встановити FLibGoLite як системну службу
sudo ./flibgolite -service start      #Запустити службу FLibGoLite

Тонка настройка  

1. Головний файл налаштування  

Зрозумілий файл конфігурації config.yml створюється разом із деревом папок при першому запуску програми в підпапці config папки, в якій лежить виконуваний файл програми flibgolite. Для тонкої будови config.yml можна редагувати.
За замовчуванням такий:

• config.yml

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: 300 
  # Maximum parallel new acquisitions processing routines
  MAX_SCAN_THREADS: 10
  # Book queue size
  BOOK_QUEUE_SIZE: 20000
  # File queue size
  FILE_QUEUE_SIZE: 20000
  # Maximum number of books in one transaction
  MAX_BOOKS_IN_TX: 20000
  # Level of checking new books for duplicates: N - no check, F - fast check (default) by CRC32, S - slow check by CRC32 or title and plot comparison
  DEDUPLICATE_LEVEL: "F"

logs:
  # Logs are here
  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: 20
  # Latest books period in days
  LATEST_DAYS: 14
  # Do not convert FB2 to EPUB format if set to true, default: false
  NO_CONVERSION: false

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"

2. Налаштування розташування папки з книгами  

За замовчуванням FLibGoLite додає до OPDS-каталогу книги з папки books/stock і нікуди їх не переміщає. Щоб змінити розташування папки, просто відредагуйте відповідний рядок в config.yml

  STOCK: "books/stock" # Book stock

та замініть books/stock на відповідний шлях до папки.

  Обережно

У шляхах замість зворотного слеша \ використовуйте прямий слеш /.

Також це можна зробити за допомогою створення посилання на іншу папку на диску, де ваші книги лежать.
Наприклад:

mklink /J.\books D:\path\to\books

ln -s /path/to/books ./books

3. Налаштування OPDS  

3.1. Ви можете змінити HTTP-порт OPDS за замовчуванням 8085 на свій

# OPDS-server port so opds can be found at http://<server name or IP-address>:8085/opds
PORT: 8085

3.2. Тут можна встановити бажане ім’я сервера OPDS

# OPDS-server title that is displayed in a book reader
TITLE: "FLib Go Go Go!!!"

3.3. Ви можете змінити кількість книг, які ваша читалка завантажуватиме за раз під час прогортання сторінки (оновлення екрана)

# OPDS feeds entries page size
PAGE_SIZE: 20

  Попередження

Не встановлюйте це значення значно більше значення за замовчуванням. Це може зробити оновлення сторінки або прокручування екрана некомфортним.

3.4. Ви можете вимкнути миттєве перетворення FB2 у формат EPUB, просто розкоментуйте рядок, щоб встановити для NO_CONVERSION значення true.

# Do not convert FB2 to EPUB format
NO_CONVERSION: true

4. Поради щодо локалізації  

Для додаткової локалізації є кілька простих налаштувань.

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. База даних списку книг  

5.1. Список книг зберігається у файлах бази даних SQLite, розміщених у папці dbdata.

DSN: "dbdata/books.db"

  Обережно

Файли бази даних створюються при першому запуску програми та не призначені для ручного редагування

5.2. У разі втрати або пошкодження файли бази даних можуть бути відновлені командою

flibgolite -reindex

sudo ./flibgolite -reindex

Це може тривати деякий час.

  Примітка

Те саме можна виконати вручну: зупинити сервіс, видалити файли бази даних і запустити сервіс заново.

5.3. Процес реєстрації нових надходжень зображено на діаграмі

У більшості випадків процес реєстрації нових придбань не вимагає налаштування, оскільки його швидкість визначається в основному продуктивністю системи введення-виведення (контролерами, типами дисків тощо). За необхідності змінити роботу процесу можна такими налаштуваннями:

 # Delay before start each new acquisitions folder processing
  POLL_DELAY: 300 
  # Maximum parallel new acquisitions processing routines
  MAX_SCAN_THREADS: 10
  # Book queue size
  BOOK_QUEUE_SIZE: 20000
  # File queue size
  FILE_QUEUE_SIZE: 20000
  # Maximum number of books in one transaction
  MAX_BOOKS_IN_TX: 20000

5.4. При додаванні нових книг у каталог можна налаштувати відбраковування дублікатів:

• N - не перевіряти,
• F - перевіряти тільки за збігом хеша CRC32 (за умовчанням),
• S - перевіряти за збігом CRC32 або за назвою книги та за коротким описом.

  # Level of checking new books for duplicates: N - no check, F - fast check (default) by CRC32, S - slow check by CRC32 or title and plot comparison
  DEDUPLICATE_LEVEL: "F"

6. Ведення журналу  

При роботі сервіс записує журнали opds.log та scan.log, розташовані в папці logs.

  # Logs are here
  OPDS: "logs/opds.log"
  SCAN: "logs/scan.log"

opds.log містить записи про запити читалок. scan.log містить записи про нові книги та індексацію архіву.

Немає необхідності видаляти журнали, щоб звільнити місце на диску, оскільки журнали змінюються (перезаписуються) через 7 днів.

Можна задати один із наступних рівнів деталізації журналу:

• D - налагодження,
• I - інформація,
• W - попередження (за замовчуванням),
• E - помилки.

  # Logging levels: D - debug, I - info, W - warnings (default), E - errors
  LEVEL: "W" 

Пропозиції, повідомлення про помилки та коментарі вітаються тут