2021-08-20 00:29:36 +02:00
|
|
|
# AudioBookshelf
|
|
|
|
|
|
|
|
|
|
AudioBookshelf is a self-hosted audiobook server for managing and playing your audiobooks.
|
|
|
|
|
|
2021-09-04 21:35:25 +02:00
|
|
|
Android app is in beta, try it out on the [Google Play Store](https://play.google.com/store/apps/details?id=com.audiobookshelf.app)
|
|
|
|
|
|
|
|
|
|
**Free & open source Android/iOS app is in development**
|
2021-08-20 00:29:36 +02:00
|
|
|
|
2021-08-26 14:09:23 +02:00
|
|
|
<img alt="Screenshot1" src="https://github.com/advplyr/audiobookshelf/raw/master/images/ss_streaming.png" />
|
2021-08-20 00:29:36 +02:00
|
|
|
|
2021-08-20 02:14:24 +02:00
|
|
|
|
2021-09-18 19:49:21 +02:00
|
|
|
## Directory Structure
|
2021-08-20 02:21:04 +02:00
|
|
|
|
2021-09-18 19:45:34 +02:00
|
|
|
Author, Series, Volume Number, Title and Publish Year can all be parsed from your folder structure.
|
2021-08-20 02:21:04 +02:00
|
|
|
|
2021-09-18 19:45:34 +02:00
|
|
|
**Note**: Files in the root directory `/audiobooks` will be ignored, all audiobooks should be in a directory
|
2021-09-05 02:58:39 +02:00
|
|
|
|
2021-09-18 19:45:34 +02:00
|
|
|
**1 Folder:** `/Title/...`\
|
|
|
|
|
**2 Folders:** `/Author/Title/...`\
|
|
|
|
|
**3 Folders:** `/Author/Series/Title/...`
|
|
|
|
|
|
2021-09-18 19:49:21 +02:00
|
|
|
### Parsing publish year
|
2021-09-18 19:45:34 +02:00
|
|
|
|
|
|
|
|
`/1984 - Hackers/...`\
|
|
|
|
|
Will save the publish year as `1984` and the title as `Hackers`
|
|
|
|
|
|
2021-09-18 19:49:21 +02:00
|
|
|
### Parsing volume number (only for series)
|
2021-09-18 19:45:34 +02:00
|
|
|
|
|
|
|
|
`/Book 3 - Hackers/...`\
|
|
|
|
|
Will save the volume number as `3` and the title as `Hackers`
|
|
|
|
|
|
|
|
|
|
`Book` `Volume` `Vol` `Vol.` are all supported case insensitive
|
|
|
|
|
|
|
|
|
|
These combinations will also work:\
|
|
|
|
|
`/Hackers - Vol. 3/...`\
|
|
|
|
|
`/1984 - Volume 3 - Hackers/...`\
|
|
|
|
|
`/1984 - Hackers Book 3/...`
|
|
|
|
|
|
2021-09-18 19:49:21 +02:00
|
|
|
|
|
|
|
|
### Parsing subtitles (optional in settings)
|
2021-09-18 19:45:34 +02:00
|
|
|
|
|
|
|
|
Title Folder: `/Hackers - Heroes of the Computer Revolution/...`
|
|
|
|
|
|
|
|
|
|
Will save the title as `Hackers` and the subtitle as `Heroes of the Computer Revolution`
|
|
|
|
|
|
2021-09-18 19:49:21 +02:00
|
|
|
|
|
|
|
|
### Full example
|
2021-09-18 19:45:34 +02:00
|
|
|
|
|
|
|
|
`/Steven Levy/The Hacker Series/1984 - Hackers - Heroes of the Computer Revolution - Vol. 1/...`
|
|
|
|
|
|
2021-09-18 19:53:52 +02:00
|
|
|
**Becomes:**
|
2021-09-18 19:53:14 +02:00
|
|
|
| Key | Value |
|
|
|
|
|
|---------------|-----------------------------------|
|
2021-09-18 19:45:34 +02:00
|
|
|
| Author | Steven Levy |
|
|
|
|
|
| Series | The Hacker Series |
|
|
|
|
|
| Publish Year | 1984 |
|
|
|
|
|
| Title | Hackers |
|
|
|
|
|
| Subtitle | Heroes of the Computer Revolution |
|
|
|
|
|
| Volume Number | 1 |
|
2021-08-20 02:14:24 +02:00
|
|
|
|
|
|
|
|
|
2021-09-18 19:52:38 +02:00
|
|
|
## Features coming soon
|
2021-08-20 00:29:36 +02:00
|
|
|
|
2021-08-20 02:21:04 +02:00
|
|
|
* Support different views to see more details of each audiobook
|
2021-09-04 21:35:25 +02:00
|
|
|
* iOS App (Android is in beta [here](https://play.google.com/store/apps/details?id=com.audiobookshelf.app))
|
2021-08-20 00:29:36 +02:00
|
|
|
|
|
|
|
|
## 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
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
## Contributing
|
|
|
|
|
|
|
|
|
|
Feel free to help out
|
