Skip to content

Interface_en

Jump to bottom
Sergey Svinolobov edited this page Sep 13, 2025 · 2 revisions

TinyOPDS Interface Guide

Scanner Tab

The Scanner tab is responsible for indexing your book library and managing the database.

Path to books folder - specify the folder where your library is stored. Use the button on the right to select via standard Windows dialog.

Monitor changes - when enabled, the program automatically tracks additions, modifications, and deletions of files in the library in real-time.

Database file name - SQLite database that stores all book information. Default is books.sqlite.

Library statistics:

  • Books in database - total number of indexed books broken down by format (fb2, epub)
  • Books found - number of books discovered during the last scan (may exceed database count due to duplicates)
  • Invalid books - corrupted or unreadable files
  • Skipped books - files that could not be processed
  • Duplicates - number of duplicates detected (program automatically keeps the best version)
  • Books processed - total number of files scanned during the session

Process information:

  • Start time - when scanning was started
  • Elapsed time - scan duration
  • Scan rate - number of books processed per minute
  • Status - current state (FINISHED - completed)

Important: Scanning large archives (350-400 GB) may take several hours, as each book is checked for duplicates when added to the database. If you plan to use TinyOPDS on a low-powered computer (e.g., Raspberry Pi 4/5 with 4 GB RAM), it's recommended to perform the initial scan on a fast PC with an SSD drive, then copy the ready database to the target device.

Server Tab

HTTP server and network connection settings.

Server name - the name of your library that will be displayed in OPDS clients.

Network interface - select the IP address on which the server will run. Choose a specific address for local network or 0.0.0.0 to listen on all interfaces.

Port - TCP port for HTTP server (default 8080).

OPDS root - path for OPDS catalog in URL (default "opds").

Forward port on router - automatic port forwarding configuration via UPnP. Option is only available if router supports UPnP. To enable UPnP on your router, typically you need to access the router's web interface (usually 192.168.1.1 or 192.168.0.1), find the "UPnP" or "Universal Plug and Play" section in network/security settings and activate this feature.

URLs:

  • Local OPDS URL - address for connecting OPDS clients on local network
  • Local web URL - web interface address for browser
  • External OPDS URL - address for internet access (if port forwarding is configured)
  • External web URL - external web interface address

Server statistics:

  • Unique clients - number of different devices that have connected to the server
  • Total requests - total number of HTTP requests
  • Books sent - number of books downloaded
  • Images sent - number of covers transmitted

OPDS Catalog Tab

OPDS catalog display and organization settings.

Items per OPDS page - number of books/authors per page in OPDS client (50-100 recommended for mobile devices).

Items per web page - number of items per web interface page (can be higher as browsers are more powerful).

Items sort order - choose display priority:

  • Cyrillic first - Russian authors and books will be shown first
  • Latin first - English and other Latin titles first

"New books" check period - books added during this period will appear in the "New arrivals" section:

  • One week
  • Two weeks
  • Three weeks
  • Month
  • Month and half
  • Two months
  • Three months

Cache images:

  • In memory - faster but requires more RAM
  • On disk - saves memory, slightly slower

Memory cache size - RAM amount for storing book covers (128-512 MB is usually sufficient).

Clear download history - removes information about downloaded books from the "Downloaded books" section in OPDS catalog.

OPDS Routes Tab

Configure OPDS catalog structure. You can enable or disable various sections and configure their hierarchy.

Catalog structure:

  • Root - main catalog page
    • New Books - recently added books
      • New Books (by date) - sorted by addition date
      • New Books (alphabetically) - alphabetical sorting of new arrivals
    • By Authors - browse by authors
      • Author's books - list of selected author's works
        • Books by Series - grouped by series/cycles
        • Books without Series - standalone works
        • Books Alphabetically - all author's books from A to Z
        • Books by Date - sorted by publication date
    • By Series - browse by book series
    • By Genres - divided by genres (science fiction, detective, etc.)
    • Downloaded books - download history from this device

Uncheck sections you don't need in your catalog.

Auth Tab

Security and access control settings using HTTP Basic authentication.

Use HTTP basic authentication - enables standard HTTP authentication to password-protect the library.

Remember authorized clients - devices won't be prompted for password again after first login.

Ban clients after N failed attempts - protection against password brute-forcing.

Users table:

  • Add usernames and passwords for library access
  • The * symbol in the first column indicates the active user
  • You can create multiple accounts for different devices

Security statistics:

  • Successful logins - number of correct authorizations
  • Failed logins - login attempts with incorrect password
  • Banned clients - IP addresses blocked for exceeding attempt limit

Misc Tab

General program settings and logging.

Start with Windows - automatic start at system boot.

Start minimized - program immediately minimizes to tray.

Close or minimize to tray - when clicking the X button, program doesn't close but hides to system tray.

Only one instance - prevents running multiple copies of the program simultaneously. If you uncheck this option, you can run multiple TinyOPDS instances with different ports to serve different libraries or configurations.

GUI and OPDS language - choose language for GUI and OPDS catalog:

  • English
  • Українська
  • Русский
  • Deutsch
  • Español
  • Français

Check for update - frequency of automatic new version checks:

  • Never
  • Once a week
  • Once a month

Save log to file - enables logging events to file for diagnostics.

Log verbosity level:

  • Info, warnings and errors - maximum detail
  • Warnings and errors - medium level
  • Errors only - minimal logging

View log file - opens current log file in text editor.

Console Version - TinyOPDSCLI

TinyOPDSCLI - command-line version of the program designed for installation as a system service.

Available commands:

  • install - install and start TinyOPDS as Windows/Linux/macOS service
  • uninstall - remove TinyOPDS service
  • start - start service (or run in console mode if service is not installed)
  • stop - stop service
  • scan - perform library scan
  • encred user pwd - encode credentials for configuration

Note: Service management commands require administrator privileges.

Installing as a Service

Windows:

TinyOPDSCLI.exe install

Linux (with Mono):

sudo mono TinyOPDSCLI.exe install

macOS (with Mono):

sudo mono TinyOPDSCLI.exe install

After installation, the service will automatically start at system boot.

Clone this wiki locally