Go to file
Marcus Noble 179caf37dd
Mark release as unimplemented
Signed-off-by: Marcus Noble <github@marcusnoble.co.uk>
2021-11-12 17:46:16 +00:00
internal/service Updated with latest and title top level 2021-11-12 17:39:43 +00:00
opds add unittests 2021-05-06 02:48:02 -04:00
.gitignore update .gitignore 2021-05-06 00:38:14 -04:00
CHANGELOG.md update changelog 2021-06-10 02:40:47 -04:00
CONTRIBUTING.md Added contribution secction to the readme 2021-08-23 00:22:08 -04:00
Dockerfile Updated with latest and title top level 2021-11-12 17:39:43 +00:00
LICENSE Initial commit 2017-03-03 21:05:37 -05:00
Makefile Mark release as unimplemented 2021-11-12 17:46:16 +00:00
README.md Added contribution secction to the readme 2021-08-23 00:22:08 -04:00
go.mod Updated with latest and title top level 2021-11-12 17:39:43 +00:00
go.sum Updated with latest and title top level 2021-11-12 17:39:43 +00:00
main.go add unittests 2021-05-06 02:48:02 -04:00
main_test.go add unittests 2021-05-06 02:48:02 -04:00

README.md

dir2opds - serve books from a directory

dir2opds inspects the given folder and serve an OPDS 1.1 compliant server.

Overview

There are good options to serve books using OPDS. Calibre is good for that but if your server is headless, install Calibre doesn't seem to be the best option.

That is why calibre2opds exists, but if you have too many books and you don't want to create a Calibre library dir2opds could help you to have an OPDS server from a directory with one condition:

  • A folder should have only folders or only files.

Change log

Installation

go install github.com/dubyte/dir2opds@latest

Usage

dir2opds -dir ./books -port 8080

Tested on:

  • Moon+ reader

More information

Binary release

Raspberry pi deployment using binary release

cd && mkdir dir2opds && cd dir2opds

# get the binary
wget https://github.com/dubyte/dir2opds/releases/download/v0.0.10/dir2opds_0.0.10_Linux_ARMv7.tar.gz

tar xvf dir2opds_0.0.10_Linux_ARMv7.tar.gz

sudo touch /etc/systemd/system/dir2opds.service

# Paste the content below but rember to pass the fullpath of your books in -dir
sudo nano /etc/systemd/system/dir2opds.service

sudo systemctl enable dir2opds.service

sudo systemctl start dir2opds.service

/etc/systemd/system/dir2opds.service

[Unit]
Description=dir2opds
Documentation=https://github.com/dubyte/dir2opds
After=network-online.target

[Service]
User=pi
Restart=on-failure

ExecStart=/home/pi/dir2opds/dir2opds -dir <FULL PATH OF BOOKS FOLDER> -port 8080

[Install]
WantedBy=multi-user.target

How to contribute