audiobookshelf/readme.md

44 lines
1.3 KiB
Markdown
Raw Normal View History

# AudioBookshelf
AudioBookshelf is a self-hosted audiobook server for managing and playing your audiobooks.
2021-08-23 21:20:33 +02:00
**Currently in Beta** - **Free & open source Android/iOS app is in development**
2021-08-20 00:32:40 +02:00
<img alt="Screenshot1" src="https://github.com/advplyr/audiobookshelf/raw/master/images/ss_bookshelf.png" />
2021-08-20 02:21:04 +02:00
#### Folder Structures Supported:
```bash
/Title/...
/Author/Title/...
/Author/Series/Title/...
Title can start with the publish year like so:
/1989 - Awesome Book/...
```
2021-08-20 02:21:04 +02:00
#### There is still a lot to do:
* Adding new audiobooks require pressing Scan button again (on settings page)
2021-08-23 21:20:33 +02:00
* Matching is still manual - should auto-match when exact title and author with cover image is found
2021-08-20 02:21:04 +02:00
* Support different views to see more details of each audiobook
2021-08-23 21:20:33 +02:00
* Add ability to add/manage additional accounts with varying access levels
2021-08-20 02:21:04 +02:00
* Then comes the mobile app..
2021-08-20 00:32:40 +02:00
<img alt="Screenshot2" src="https://github.com/advplyr/audiobookshelf/raw/master/images/ss_streaming.png" />
## Installation
Built to run in Docker for now (also on Unraid server Community Apps)
```bash
docker run -d -p 1337:80 -v /audiobooks:/audiobooks -v /config:/config -v /metadata:/metadata --name audiobookshelf --rm advplyr/audiobookshelf
```
2021-08-20 00:32:40 +02:00
<img alt="Screenshot3" src="https://github.com/advplyr/audiobookshelf/raw/master/images/ss_audiobook.png" />
## Contributing
Feel free to help out