Skip to content

Config_uk

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