Skip to content

Config_ru

sensboston edited this page Nov 3, 2026 · 3 revisions

Документация конфигурационного файла TinyOPDS

Описание

Конфигурационный файл TinyOPDS имеет формат XML и содержит все настройки сервера. Файл автоматически создаётся при первом запуске программы и может быть отредактирован вручную или через графический интерфейс.

Имя файла: TinyOPDS.config
Расположение: В папке с программой
Формат: XML с кодировкой UTF-8

Важно: При редактировании файла вручную убедитесь, что TinyOPDS не запущен, иначе изменения будут перезаписаны при закрытии программы.

Структура файла

<?xml version="1.0" encoding="utf-8"?>
<configuration>
  <userSettings>
    <Portable>
      <TinyOPDS.Properties.Settings>
        <!-- Параметры конфигурации -->
      </TinyOPDS.Properties.Settings>
    </Portable>
  </userSettings>
</configuration>

Параметры конфигурации

Сетевые настройки

ServerPort

  • Тип: Целое число
  • По умолчанию: 8080
  • Описание: Порт, на котором работает HTTP сервер
  • Пример: 8080, 80, 9090

LocalInterfaceIndex

  • Тип: Целое число
  • По умолчанию: 0
  • Описание: Индекс сетевого интерфейса для прослушивания
    • 0 - первый найденный сетевой интерфейс
    • 1, 2, 3... - конкретный сетевой интерфейс по порядку
  • Примечание: Используется когда в системе несколько сетевых карт

UseUPnP

  • Тип: Boolean
  • По умолчанию: False
  • Описание: Использовать UPnP для автоматической настройки роутера
  • Значения: True / False

OpenNATPort

  • Тип: Boolean
  • По умолчанию: False
  • Описание: Автоматически открывать порт в NAT роутера
  • Значения: True / False

UseAbsoluteUri

  • Тип: Boolean
  • По умолчанию: False
  • Описание: Использовать абсолютные URI вместо относительных в OPDS каталоге
  • Значения: True / False
  • Примечание: Включите при работе через прокси или если клиенты неправильно обрабатывают относительные ссылки

Настройки библиотеки

LibraryPath

  • Тип: Строка
  • По умолчанию: Пусто
  • Описание: Путь к папке с книгами
  • Примеры:
    • Windows: C:\Books\Library
    • Linux/Mac: /home/user/books

WatchLibrary

  • Тип: Boolean
  • По умолчанию: False
  • Описание: Автоматически отслеживать изменения в библиотеке
  • Значения: True / False
  • Примечание: При включении автоматически сканирует новые/изменённые файлы

ServiceFilesPath

  • Тип: Строка
  • По умолчанию: Пусто
  • Описание: Путь к папке с дополнительными файлами (стили, скрипты)
  • Примечание: Оставьте пустым для использования встроенных файлов

Настройки сервера

ServerName

  • Тип: Строка
  • По умолчанию: TinyOPDS
  • Описание: Имя сервера, отображаемое в OPDS клиентах
  • Пример: Домашняя библиотека, My Books

RootPrefix

  • Тип: Строка
  • По умолчанию: opds
  • Описание: Префикс для OPDS каталога в URL
  • Пример: При значении opds каталог доступен по адресу http://server:8080/opds

HttpPrefix

  • Тип: Строка
  • По умолчанию: lib
  • Описание: Префикс для веб-интерфейса в URL
  • Пример: При значении lib веб-интерфейс доступен по http://server:8080/lib

Настройки отображения

ItemsPerWebPage

  • Тип: Целое число
  • По умолчанию: 200
  • Описание: Количество элементов на одной странице веб-интерфейса
  • Рекомендации: 50-500 элементов

ItemsPerOPDSPage

  • Тип: Целое число
  • По умолчанию: 100
  • Описание: Количество элементов на одной странице OPDS каталога
  • Рекомендации: 20-200 элементов (меньше для мобильных устройств)

BatchSize

  • Тип: Целое число
  • По умолчанию: 100
  • Описание: Размер пакета при обработке книг во время сканирования
  • Рекомендации: 50-500 (больше = быстрее, но больше памяти)

NewBooksPeriod

  • Тип: Целое число
  • По умолчанию: 2
  • Описание: Период в неделях для отображения "новых" книг
  • Пример: 2 - книги за последние 2 недели считаются новыми

Структура OPDS каталога

OPDSStructure

  • Тип: Строка
  • По умолчанию: Все разделы включены
  • Описание: Настройка видимости разделов OPDS каталога
  • Формат: раздел:состояние;раздел:состояние;...
  • Состояния:
    • 1 - раздел включён
    • 0 - раздел выключен

Доступные разделы:

  • newdate - Новые книги по дате
  • newtitle - Новые книги по названию
  • authorsindex - Индекс авторов
  • author-details - Подробности об авторе
  • author-series - Книги автора в сериях
  • author-no-series - Книги автора вне серий
  • author-alphabetic - Авторы по алфавиту
  • author-by-date - Авторы по дате добавления
  • sequencesindex - Индекс серий книг
  • genres - Жанры
  • downloads - Загрузки/Популярные

Пример:

<OPDSStructure>newdate:1;newtitle:0;authorsindex:1;genres:1</OPDSStructure>

Включены: новые по дате, индекс авторов, жанры. Выключены: новые по названию.

Локализация и сортировка

Language

  • Тип: Строка
  • По умолчанию: en
  • Описание: Язык интерфейса
  • Значения: en (English), ru (Русский), uk (Українська) и др.

SortOrder

  • Тип: Целое число
  • По умолчанию: 0
  • Описание: Порядок сортировки для смешанного алфавита
  • Значения:
    • 0 - Латиница первой
    • 1 - Кириллица первой

FilterBooksByInterfaceLanguage

  • Тип: Boolean
  • По умолчанию: False
  • Описание: Фильтровать книги по языку интерфейса
  • Значения: True / False
  • Примечание: При True показывает только книги на языке интерфейса

UseAuthorsAliases

  • Тип: Boolean
  • По умолчанию: True
  • Описание: Использовать псевдонимы авторов
  • Значения: True / False

Безопасность и авторизация

UseHTTPAuth

  • Тип: Boolean
  • По умолчанию: False
  • Описание: Использовать HTTP авторизацию (Basic Auth)
  • Значения: True / False

Credentials

  • Тип: Строка
  • По умолчанию: Пусто
  • Описание: Учётные данные для HTTP авторизации
  • Формат: Base64 от username:password или специальный формат программы
  • Примечание: Настраивайте через GUI для правильного шифрования

BanClients

  • Тип: Boolean
  • По умолчанию: False
  • Описание: Включить блокировку клиентов после неудачных попыток
  • Значения: True / False

WrongAttemptsCount

  • Тип: Целое число
  • По умолчанию: 5
  • Описание: Количество неудачных попыток до блокировки клиента
  • Примечание: Работает только при BanClients=True

RememberClients

  • Тип: Boolean
  • По умолчанию: False
  • Описание: Запоминать авторизованных клиентов
  • Значения: True / False

Настройки интерфейса

StartMinimized

  • Тип: Boolean
  • По умолчанию: False
  • Описание: Запускать программу свёрнутой в трей
  • Значения: True / False

CloseToTray

  • Тип: Boolean
  • По умолчанию: False
  • Описание: Сворачивать в трей при закрытии окна
  • Значения: True / False

StartWithWindows

  • Тип: Boolean
  • По умолчанию: False
  • Описание: Запускать при старте Windows
  • Значения: True / False
  • Примечание: Только для Windows

OnlyOneInstance

  • Тип: Boolean
  • По умолчанию: False
  • Описание: Разрешить только один экземпляр программы
  • Значения: True / False

Кэширование

CacheImagesInMemory

  • Тип: Boolean
  • По умолчанию: True
  • Описание: Кэшировать обложки книг в оперативной памяти
  • Значения: True / False

MaxRAMImageCacheSizeMB

  • Тип: Целое число
  • По умолчанию: 128
  • Описание: Максимальный размер кэша изображений в мегабайтах
  • Рекомендации: 64-512 МБ в зависимости от доступной памяти

Логирование

LogLevel

  • Тип: Целое число
  • По умолчанию: 0
  • Описание: Уровень детализации логов
  • Значения:
    • 0 - Информация (Info)
    • 1 - Предупреждения (Warning)
    • 2 - Ошибки (Error)
    • 3 - Аутентификация (Authentication)

SaveLogToDisk

  • Тип: Boolean
  • По умолчанию: True
  • Описание: Сохранять логи на диск
  • Значения: True / False
  • Файл лога: TinyOPDS.log в папке программы

Обновления

UpdatesCheck

  • Тип: Целое число
  • По умолчанию: 1
  • Описание: Частота проверки обновлений программы
  • Значения:
    • 0 - Никогда
    • 1 - Раз в неделю
    • 2 - Раз в месяц

LastCheck

  • Тип: Дата/время
  • Формат: MM/dd/yyyy HH:mm:ss
  • Описание: Дата последней проверки обновлений
  • Пример: 09/22/2025 23:55:38
  • Примечание: Обновляется автоматически, только после ответа GitHub (неудачная проверка повторяется через минуту)

InstallUpdates

  • Тип: Логический
  • По умолчанию: False
  • Описание: Устанавливать найденное обновление автоматически (Windows, только программа с окном): новый TinyOPDS.exe скачивается из релиза, проверяется по SHA-256 и номеру версии, заменяет работающий, и программа перезапускается. Если идёт сканирование, обновление ставится после его окончания. Настройки и база сохраняются. Если в папку программы нельзя писать или проверка не прошла, об обновлении только сообщается
  • Значения: True / False

LatestRelease

  • Тип: Строка
  • Описание: Тег и хеш exe последнего релиза, который видела проверка обновлений, например v3.20 sha256:.... Пока найденная новая версия не установлена, проверка (и напоминание) идёт раз в сутки; о релизе с пересобранным exe (новый хеш, та же версия) тоже сообщается
  • Примечание: Обновляется автоматически

Загрузка книг

См. Загрузка книг.

EnableUploads

  • Тип: Логический
  • По умолчанию: False
  • Описание: Разрешить загрузку книг из веб-интерфейса (FB2, EPUB, ZIP с одной книгой) в подпапку Uploads библиотеки
  • Значения: True / False
  • Примечание: Отдельного пароля нет: если сервер доступен из интернета, защитите его через UseHTTPAuth

MaxUploadSizeMB

  • Тип: Целое число
  • По умолчанию: 20
  • Описание: Максимальный размер загружаемого файла, МБ

Примеры конфигураций

Минимальная конфигурация

<?xml version="1.0" encoding="utf-8"?>
<configuration>
  <userSettings>
    <Portable>
      <TinyOPDS.Properties.Settings>
        <LibraryPath>C:\Books</LibraryPath>
        <ServerPort>8080</ServerPort>
      </TinyOPDS.Properties.Settings>
    </Portable>
  </userSettings>
</configuration>

Конфигурация с авторизацией

<?xml version="1.0" encoding="utf-8"?>
<configuration>
  <userSettings>
    <Portable>
      <TinyOPDS.Properties.Settings>
        <LibraryPath>/home/user/books</LibraryPath>
        <ServerPort>8080</ServerPort>
        <UseHTTPAuth>True</UseHTTPAuth>
        <Credentials><!-- Настройте через GUI --></Credentials>
        <BanClients>True</BanClients>
        <WrongAttemptsCount>3</WrongAttemptsCount>
      </TinyOPDS.Properties.Settings>
    </Portable>
  </userSettings>
</configuration>

Конфигурация для больших библиотек

<?xml version="1.0" encoding="utf-8"?>
<configuration>
  <userSettings>
    <Portable>
      <TinyOPDS.Properties.Settings>
        <LibraryPath>/mnt/nas/books</LibraryPath>
        <ServerPort>80</ServerPort>
        <BatchSize>500</BatchSize>
        <ItemsPerWebPage>500</ItemsPerWebPage>
        <ItemsPerOPDSPage>50</ItemsPerOPDSPage>
        <CacheImagesInMemory>True</CacheImagesInMemory>
        <MaxRAMImageCacheSizeMB>512</MaxRAMImageCacheSizeMB>
        <WatchLibrary>True</WatchLibrary>
      </TinyOPDS.Properties.Settings>
    </Portable>
  </userSettings>
</configuration>

Рекомендации

Для домашнего использования

  • Оставьте большинство параметров по умолчанию
  • Включите CloseToTray и StartMinimized для работы в фоне
  • Используйте WatchLibrary=True для автоматического обновления

Для публичного доступа

  • Обязательно включите UseHTTPAuth=True
  • Настройте BanClients=True с разумным WrongAttemptsCount
  • Используйте нестандартный порт вместо 8080
  • Уменьшите ItemsPerOPDSPage для мобильных клиентов

Для больших библиотек (100,000+ книг)

  • Увеличьте BatchSize до 500-1000
  • Увеличьте MaxRAMImageCacheSizeMB при наличии памяти
  • Отключите WatchLibrary и сканируйте по расписанию
  • Увеличьте ItemsPerWebPage для удобства навигации

Совместимость

  • Файл конфигурации совместим между версиями TinyOPDS
  • GUI и CLI версии используют один и тот же файл конфигурации
  • При обновлении программы новые параметры добавляются автоматически с значениями по умолчанию
  • Резервное копирование конфигурации рекомендуется перед обновлением

Clone this wiki locally