a0ne/docker-pdf-server repository overview

⁠Docker PDF Server

Welcome to the Docker PDF Server! This project provides an ultra-minimalist PDF server for a quick, e-book-like viewing experience of a moderately sized PDF library. Built with Flask and HTML, it offers a no-nonsense, straightforward way to upload, delete, view, search, and serve PDFs.

See docker-pdf-server⁠ on GitHub

⁠Why Docker PDF Server?

I developed this server out of a personal need for a quick, e-book-like viewing experience for my PDF library. Unlike document organizers like Paperless-ngx or eBook focused apps like Calibre-web, Kavita etc., this server focuses solely on delivering a simple way to upload, browse, search, and access PDF e-books for reading. When you click on a PDF, it is served as is.

It is functionally similar to any typical client app for any NAS. However, this server brings the convenience of browser-based access, allowing for quick viewing and on-the-go reading on any device. Be aware that it lacks a database or any form of grouping/bookmarking system and relies solely on file system, so it may not be for you if you have anything over a few 1000 files and want to sync bookmarks etc.

⁠Getting Started

Just run the below docker command replacing the username, password and secret with your preferred values, and you should be up and running.

docker run -e DOCKER_PDF_SERVER_USER=<your-username> \
 -e DOCKER_PDF_SERVER_PASSWORD=<your-password> \
 -e DOCKER_PDF_SERVER_KEY=<your-random-secret-key> \
 -p 3040:5000 -v /Users/writable/host/path/pdf-library:/app/library/ a0ne/docker-pdf-server:latest

You can then access the app by going to http://localhost:3040

⁠Ideas, Issues and Improvements

Feature development has been driven by personal use case, primarily centered around managing a few hundred PDFs for reading. However, I might think of additions that maintain the server's lightweight nature, such as a folder system etc.

Feel free to header over to the GitHub Repo⁠ to contribute or raise issues to improve the Docker PDF Server!