Skip to content

Uploads_en

sensboston edited this page Nov 3, 2026 · 1 revision

Book uploads

Starting with version 3.20, books can be added to the library from the web interface: from a phone, a tablet or another computer, without access to the library folder.

Enabling uploads

Uploads are off by default. They are set by two settings of TinyOPDS.config (the program window has no options for them):

Setting Default Meaning
EnableUploads False True enables uploads
MaxUploadSizeMB 20 Maximum file size, MB

Windows (program window). Exit TinyOPDS (tray menu → Exit: closing the window may only hide it to the tray, and the program saves its settings on exit), open TinyOPDS.config in the program folder (or in %LOCALAPPDATA%\TinyOPDS if the program folder is not writable) and add two lines inside <TinyOPDS.Properties.Settings>:

<EnableUploads>True</EnableUploads>
<MaxUploadSizeMB>20</MaxUploadSizeMB>

Then start TinyOPDS again.

TinyOPDSCLI and the Windows service. Same lines in the TinyOPDS.config of TinyOPDSCLI, then restart the service (or the console server).

Docker. Add the variables to environment and remove :ro from the library folder: uploaded books are written to the library, so the user given by PUID needs write access to it.

    volumes:
      - /volume1/books:/books
      - /volume1/docker/tinyopds:/data
    environment:
      - TINYOPDS_ENABLEUPLOADS=true
      - TINYOPDS_MAXUPLOADSIZEMB=20

Who can upload

Uploads have no password of their own: anyone who can open the web interface can upload books and delete uploaded ones. On a home network that is usually fine. If the server is reachable from the internet, turn on password protection (Auth tab of the program window, or TINYOPDS_USEHTTPAUTH and TINYOPDS_CREDENTIALS in Docker, see Docker (NAS)).

The server also protects itself: files larger than MaxUploadSizeMB are rejected, one client can upload at most 30 files an hour, and archives are unpacked and checked before they are accepted (unpacked size and contents).

Uploading a book

Double click the TinyOPDS logo in the page header (on a phone: double tap). A file dialog opens; choose the book. The result is shown at the bottom of the page: "Added to the library", "This book is already in the library", or the reason of an error.

Accepted files:

  • FB2 and EPUB;
  • ZIP with one book inside (for example book.fb2.zip). An archive with several books is rejected: a collection should be copied to the library folder instead.

Where uploaded books go

The file is saved to the Uploads subfolder of the library folder (it is created on the first upload). The book is added to the library at once, without a rescan: it is in the author, series and genre catalogs, in search and in Uploaded books on the main page (OPDS readers see the same catalog).

Duplicates are handled as during a scan. If the library already has the same book, the upload is reported as already present. If the uploaded copy is a better version of a book in the library (for example a newer FB2 version), it replaces the older copy in the catalogs; the older file itself is not touched.

Deleting an uploaded book

In the web interface, uploaded books have a delete button in the bottom left corner of the cover. After the confirmation the book is removed from the library and its file is deleted from the Uploads folder. If the book had replaced an older copy, that copy comes back to the catalogs.

Only uploaded books can be deleted this way; the rest of the library can't be changed from the web interface.

Clone this wiki locally