dir2opds/README.md

32 lines
834 B
Markdown
Raw Normal View History

2018-03-03 21:04:01 +00:00
# dir2opds - serve books from a directory
2021-05-06 02:20:30 +00:00
dir2opds inspects the given folder and serve an OPDS 1.1 compliant server.
2017-03-04 03:41:48 +00:00
2018-03-03 21:04:01 +00:00
# Overview
2021-05-06 02:20:30 +00:00
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.
2018-03-03 21:04:01 +00:00
That is why calibre2opds exists, but if you have too many books and
2021-05-06 02:20:30 +00:00
you don't want to create a Calibre library dir2opds could help you to
have an OPDS server from a directory with one condition:
2018-03-03 21:04:01 +00:00
2021-05-06 02:20:30 +00:00
- A folder should have only folders or only files.
2017-03-04 03:41:48 +00:00
2019-03-16 18:40:53 +00:00
# change log
- [Changelog](CHANGELOG.md)
2017-03-04 03:41:48 +00:00
# Installation
2019-03-10 08:15:15 +00:00
go get -u github.com/dubyte/dir2opds
2018-03-03 21:04:01 +00:00
# Usage
dir2opds -dir ./books -port 8080
2017-03-04 03:41:48 +00:00
2021-05-06 02:20:30 +00:00
# Tested on:
2018-03-03 21:04:01 +00:00
- Moon+ reader
2017-03-04 03:41:48 +00:00
2018-03-03 21:04:01 +00:00
# More information
2018-03-03 21:07:24 +00:00
- http://opds-spec.org
2017-03-04 03:41:48 +00:00
# binary release
- https://github.com/dubyte/dir2opds/releases