build | ||
client | ||
images | ||
server | ||
static | ||
.dockerignore | ||
.gitignore | ||
docker-template.xml | ||
Dockerfile | ||
index.js | ||
package-lock.json | ||
package.json | ||
prod.js | ||
readme.md |
AudioBookshelf
AudioBookshelf is a self-hosted audiobook server for managing and playing your audiobooks.
See Install guides and documentation
Android app is in beta, try it out on the Google Play Store
Free & open source Android/iOS app is in development
![Screenshot1](https://github.com/advplyr/audiobookshelf/raw/master/images/ss_streaming.png)
Organizing your audiobooks
Directory structure and folder names are critical to AudioBookshelf!
See documentation for supported directory structure, folder naming conventions, and audio file metadata usage.
Installation
** Default username is "root" with no password
Docker Install
Available in Unraid Community Apps
docker pull advplyr/audiobookshelf
docker run -d \
-p 1337:80 \
-v </path/to/audiobooks>:/audiobooks \
-v </path/to/config>:/config \
-v </path/to/metadata>:/metadata \
--name audiobookshelf \
--rm advplyr/audiobookshelf
Linux (amd64) Install
A simple installer is added to setup the initial config. If you already have audiobooks, you can enter the path to your audiobooks during the install. The installer will create a user and group named audiobookshelf
.
Ubuntu Install via PPA
A PPA is hosted on github, add and install:
curl -s --compressed "https://advplyr.github.io/audiobookshelf-ppa/KEY.gpg" | sudo apt-key add -
sudo curl -s --compressed -o /etc/apt/sources.list.d/audiobookshelf.list "https://advplyr.github.io/audiobookshelf-ppa/audiobookshelf.list"
sudo apt update
sudo apt install audiobookshelf
or use a single command
curl -s --compressed "https://advplyr.github.io/audiobookshelf-ppa/KEY.gpg" | sudo apt-key add - && sudo curl -s --compressed -o /etc/apt/sources.list.d/audiobookshelf.list "https://advplyr.github.io/audiobookshelf-ppa/audiobookshelf.list" && sudo apt update && sudo apt install audiobookshelf
Install via debian package
Get the deb
file from the github repo.
See instructions
Linux file locations
Project directory: /usr/share/audiobookshelf/
Config file: /etc/default/audiobookshelf
System Service: /lib/systemd/system/audiobookshelf.service
Ffmpeg static build: /usr/lib/audiobookshelf-ffmpeg/
Run from source
Note: you will need npm
, node12
, and ffmpeg
to run this project locally
git clone https://github.com/advplyr/audiobookshelf.git
cd audiobookshelf
# All paths default to root directory. Config path is the database.
# Directories will be created if they don't exist
# Paths are relative to the root directory, so "../Audiobooks" would be a valid path
npm run prod -- -p [PORT] --audiobooks [AUDIOBOOKS_PATH] --config [CONFIG_PATH] --metadata [METADATA_PATH]
Contributing
Feel free to help out