Расширенное руководство
Расширенная и тонкая настройка
Чтобы просмотреть параметры запуска, в командной строке наберите ./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, если вы хотите на русском, вы можете изменить эту настройку на ru.
# 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»Предложения, отчеты об ошибках и комментарии приветствуются здесь