audiobookshelf

mirror of https://github.com/advplyr/audiobookshelf.git synced 2024-12-20 19:06:06 +01:00

Self-hosted audiobook and podcast server

audiobook-manager audiobooks audiobookshelf hacktoberfest podcasts self-hosted

Go to file

advplyr ff1eeda468 Change: config page to multiple pages, Add: user permissions for accessible libraries #120 , Add: map genre metadata tag #114 , Add: experimental audio player keyboard controls #121 , Add: view user audiobook progress list		2021-10-22 20:08:02 -05:00
build	linux installer use existing config	2021-09-25 17:37:21 -05:00
client	Change: config page to multiple pages, Add: user permissions for accessible libraries #120 , Add: map genre metadata tag #114 , Add: experimental audio player keyboard controls #121 , Add: view user audiobook progress list	2021-10-22 20:08:02 -05:00
images	New screenshot	2021-10-09 14:54:45 -05:00
server	Change: config page to multiple pages, Add: user permissions for accessible libraries #120 , Add: map genre metadata tag #114 , Add: experimental audio player keyboard controls #121 , Add: view user audiobook progress list	2021-10-22 20:08:02 -05:00
static	Fix server client.user undefined, update logo	2021-09-03 06:40:59 -05:00
.dockerignore	Abort backup if it is getting too large #89 , support for ebook only book folders #75	2021-10-10 16:36:21 -05:00
.gitignore	Abort backup if it is getting too large #89 , support for ebook only book folders #75	2021-10-10 16:36:21 -05:00
docker-template.xml	narrator filter, no series filter, full paths toggle, book landing page details, new sans font, update query string on filter/sort, persist experimental feature flag, batch edit redirect bug, upload file permissions and owner	2021-10-06 21:08:52 -05:00
Dockerfile	logLevel as server setting, logger config page, re-scan audiobook option, fix embedded cover extraction, flac and mobi support, fix series bookshelf not wrapping	2021-09-30 18:52:32 -05:00
index.js	narrator filter, no series filter, full paths toggle, book landing page details, new sans font, update query string on filter/sort, persist experimental feature flag, batch edit redirect bug, upload file permissions and owner	2021-10-06 21:08:52 -05:00
package-lock.json	Change: config page to multiple pages, Add: user permissions for accessible libraries #120 , Add: map genre metadata tag #114 , Add: experimental audio player keyboard controls #121 , Add: view user audiobook progress list	2021-10-22 20:08:02 -05:00
package.json	Change: config page to multiple pages, Add: user permissions for accessible libraries #120 , Add: map genre metadata tag #114 , Add: experimental audio player keyboard controls #121 , Add: view user audiobook progress list	2021-10-22 20:08:02 -05:00
prod.js	narrator filter, no series filter, full paths toggle, book landing page details, new sans font, update query string on filter/sort, persist experimental feature flag, batch edit redirect bug, upload file permissions and owner	2021-10-06 21:08:52 -05:00
readme.md	New screenshot	2021-10-09 14:54:45 -05:00

readme.md

Documentation · Install Guides · Showcase

About

Audiobookshelf is a self-hosted audiobook server for managing and playing your audiobooks.

Features

Fully open-source, including the android app (in beta)
Stream all audiobook formats on the fly
Multi-user support w/ custom permissions
Keeps progress per user and syncs across devices
Auto-detects library updates, no need to re-scan
Upload full audiobooks and covers
Backup your metadata + automated daily backups

Is there a feature you are looking for? Suggest it

Android app is in beta, try it out on the Google Play Store

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