dir2opds/README.md

32 lines
826 B
Markdown
Raw Normal View History

2018-03-03 21:04:01 +00:00
# dir2opds - serve books from a directory
dir2opds inspect 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
2018-03-03 21:06:09 +00:00
There are good options to server books using opds. Calibre is good doing
that but if your server is headless sometimes install calibre
2018-03-03 21:04:01 +00:00
just for serve the books don't seems to be the best option.
That is why calibre2opds exists, but if you just have too many books and
you don't want to create a calibre library.
In that case dir2opds could help you to have an opds server from a
directory if you follow one rule:
- A folder should have only folders or only files (aka books).
It is ok to have sub-folders.
2017-03-04 03:41:48 +00:00
# Installation
2018-03-03 21:04:01 +00:00
go get github.com/dubyte/dir2opds
# Usage
dir2opds -dir ./books -port 8080
2017-03-04 03:41:48 +00:00
2018-03-03 21:04:01 +00:00
# Tested in:
- 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