Documentation · User Guides · Support

About

Audiobookshelf is a self-hosted audiobook and podcast server.

Features

Fully open-source, including the android & iOS app (in beta)
Stream all audio formats on the fly
Search and add podcasts to download episodes w/ auto-download
Multi-user support w/ custom permissions
Keeps progress per user and syncs across devices
Auto-detects library updates, no need to re-scan
Upload books and podcasts w/ bulk upload drag and drop folders
Backup your metadata + automated daily backups
Progressive Web App (PWA)
Chromecast support on the web app and android app
Fetch metadata and cover art from several sources
Chapter editor and chapter lookup (using Audnexus API)
Merge your audio files into a single m4b
Embed metadata and cover image into your audio files (using Tone)
Basic ebook support and e-reader (experimental)

Is there a feature you are looking for? Suggest it

Join us on Discord or Matrix

Android App (beta)

Try it out on the Google Play Store

iOS App (beta)

Available using Test Flight: https://testflight.apple.com/join/wiic7QIW - Join the discussion

Build your own tools & clients

Check out the API documentation

Organizing your audiobooks

Directory structure and folder names are important to Audiobookshelf!

See documentation for supported directory structure, folder naming conventions, and audio file metadata usage.

Installation

See install docs

Reverse Proxy Set Up

Important! Audiobookshelf requires a websocket connection.

Note: Subfolder paths (e.g. /audiobooks) are not supported yet. See issue

NGINX Proxy Manager

Toggle websockets support.

NGINX Reverse Proxy

Add this to the site config file on your nginx server after you have changed the relevant parts in the <> brackets, and inserted your certificate paths.

server
{
        listen 443 ssl;
        server_name <sub>.<domain>.<tld>;

        access_log /var/log/nginx/audiobookshelf.access.log;
        error_log /var/log/nginx/audiobookshelf.error.log;

        ssl_certificate      /path/to/certificate;
        ssl_certificate_key  /path/to/key;

        location / {
                     proxy_set_header X-Forwarded-For    $proxy_add_x_forwarded_for;
                     proxy_set_header  X-Forwarded-Proto $scheme;
                     proxy_set_header  Host              $host;
                     proxy_set_header Upgrade            $http_upgrade;
                     proxy_set_header Connection         "upgrade";

                     proxy_http_version                  1.1;

                     proxy_pass                          http://<URL_to_forward_to>;
                     proxy_redirect                      http:// https://;
                   }
}

Apache Reverse Proxy

Add this to the site config file on your Apache server after you have changed the relevant parts in the <> brackets, and inserted your certificate paths.

For this to work you must enable at least the following mods using a2enmod:

ssl
proxy_module
proxy_wstunnel_module
rewrite_module

<IfModule mod_ssl.c>
<VirtualHost *:443>
    ServerName <sub>.<domain>.<tld>

    ErrorLog ${APACHE_LOG_DIR}/error.log
    CustomLog ${APACHE_LOG_DIR}/access.log combined

    ProxyPreserveHost On
    ProxyPass / http://localhost:<audiobookshelf_port>/
    RewriteEngine on
    RewriteCond %{HTTP:Upgrade} websocket [NC]
    RewriteCond %{HTTP:Connection} upgrade [NC]
    RewriteRule ^/?(.*) "ws://localhost:<audiobookshelf_port>/$1" [P,L]

    # unless you're doing something special this should be generated by a
    # tool like certbot by let's encrypt
    SSLCertificateFile /path/to/cert/file
    SSLCertificateKeyFile /path/to/key/file
</VirtualHost>
</IfModule>

SWAG Reverse Proxy

See this solution

Synology Reverse Proxy

Open Control Panel > Application Portal
Change to the Reverse Proxy tab
Select the proxy rule for which you want to enable Websockets and click on Edit
Change to the "Custom Header" tab
Click Create > WebSocket
Click Save

from @silentArtifact

Traefik Reverse Proxy

Middleware relating to CORS will cause the app to report Unknown Error when logging in. To prevent this don't apply any of the following headers to the router for this site:

accessControlAllowMethods
accessControlAllowOriginList
accessControlMaxAge

From @Dondochaka and @BeastleeUK

Example Caddyfile - Caddy Reverse Proxy

subdomain.domain.com {
        encode gzip zstd
        reverse_proxy <LOCAL_IP>:<PORT>
}

Run from source

See discussion

Contributing / How to Support

See the incomplete "How to Support" page

BCNelson/audiobookshelf