\n $\"Audiobookshelf$ \n\n

\n
\n Documentation\n ·\n User Guides\n ·\n Support\n

\n\n# About\n\nAudiobookshelf is a self-hosted audiobook and podcast server.\n\n### Features\n\n* Fully **open-source**, including the [android & iOS app](https://github.com/advplyr/audiobookshelf-app) *(in beta)*\n* Stream all audio formats on the fly\n* Search and add podcasts to download episodes w/ auto-download\n* Multi-user support w/ custom permissions\n* Keeps progress per user and syncs across devices\n* Auto-detects library updates, no need to re-scan\n* Upload books and podcasts w/ bulk upload drag and drop folders\n* Backup your metadata + automated daily backups\n* Progressive Web App (PWA)\n* Chromecast support on the web app and android app\n* Fetch metadata and cover art from several sources\n* Chapter editor and chapter lookup (using [Audnexus API](https://audnex.us/))\n* Merge your audio files into a single m4b\n* Embed metadata and cover image into your audio files (using [Tone](https://github.com/sandreas/tone))\n* Basic ebook support and e-reader *(experimental)*\n\nIs there a feature you are looking for? [Suggest it](https://github.com/advplyr/audiobookshelf/issues/new/choose)\n\nJoin us on [Discord](https://discord.gg/pJsjuNCKRq) or [Matrix](https://matrix.to/#/#audiobookshelf:matrix.org)\n\n### Android App (beta)\nTry it out on the [Google Play Store](https://play.google.com/store/apps/details?id=com.audiobookshelf.app)\n\n### iOS App (beta)\nAvailable using Test Flight: https://testflight.apple.com/join/wiic7QIW - [Join the discussion](https://github.com/advplyr/audiobookshelf-app/discussions/60)\n\n### Build your own tools & clients\nCheck out the [API documentation](https://api.audiobookshelf.org/)\n\n
\n\n $\"Library$ \n\n
\n\n# Organizing your audiobooks\n\n#### Directory structure and folder names are important to Audiobookshelf!\n\n See [documentation](https://audiobookshelf.org/docs#book-directory-structure) for supported directory structure, folder naming conventions, and audio file metadata usage.\n\n
\n\n# Installation\n\nSee [install docs](https://www.audiobookshelf.org/docs)\n\n
\n\n# Reverse Proxy Set Up\n\n#### Important! Audiobookshelf requires a websocket connection.\n\n#### Note: Subfolder paths (e.g. /audiobooks) are not supported yet. See [issue](https://github.com/advplyr/audiobookshelf/issues/385)\n\n### NGINX Proxy Manager\n\nToggle websockets support.\n\n $\"NGINX$ \n\n### NGINX Reverse Proxy\n\nAdd 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.\n\n\n```bash\nserver\n{\n listen 443 ssl;\n server_name _{..;\n\n access_log /var/log/nginx/audiobookshelf.access.log;\n error_log /var/log/nginx/audiobookshelf.error.log;\n\n ssl_certificate /path/to/certificate;\n ssl_certificate_key /path/to/key;\n\n location / {\n proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;\n proxy_set_header X-Forwarded-Proto $scheme;\n proxy_set_header Host $host;\n proxy_set_header Upgrade $http_upgrade;\n proxy_set_header Connection \"upgrade\";\n\n proxy_http_version 1.1;\n\n proxy_pass http://;\n proxy_redirect http:// https://;\n }\n}\n```\n\n### Apache Reverse Proxy\n\nAdd 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.\n\nFor this to work you must enable at least the following mods using `a2enmod`:\n - `ssl`\n - `proxy_module`\n - `proxy_wstunnel_module`\n - `rewrite_module`\n\n```bash\n\n\n ServerName _{..\n\n ErrorLog ${APACHE_LOG_DIR}/error.log\n CustomLog ${APACHE_LOG_DIR}/access.log combined\n\n ProxyPreserveHost On\n ProxyPass / http://localhost:/\n RewriteEngine on\n RewriteCond %{HTTP:Upgrade} websocket [NC]\n RewriteCond %{HTTP:Connection} upgrade [NC]\n RewriteRule ^/?(.*) \"ws://localhost:/$1\" [P,L]\n\n # unless you're doing something special this should be generated by a\n # tool like certbot by let's encrypt\n SSLCertificateFile /path/to/cert/file\n SSLCertificateKeyFile /path/to/key/file\n}\n\n```\n\n\n### SWAG Reverse Proxy\n\n[See this solution](https://forums.unraid.net/topic/112698-support-audiobookshelf/?do=findComment&comment=1049637)\n\n### Synology Reverse Proxy\n\n1. Open Control Panel > Application Portal\n2. Change to the Reverse Proxy tab\n3. Select the proxy rule for which you want to enable Websockets and click on Edit\n4. Change to the \"Custom Header\" tab\n5. Click Create > WebSocket\n6. Click Save\n\n[from @silentArtifact](https://github.com/advplyr/audiobookshelf/issues/241#issuecomment-1036732329)\n\n### [Traefik Reverse Proxy](https://doc.traefik.io/traefik/)\n\nMiddleware 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:\n\n\n accessControlAllowMethods
\n accessControlAllowOriginList
\n accessControlMaxAge
\n
\n\nFrom [@Dondochaka](https://discord.com/channels/942908292873723984/942914154254176257/945074590374318170) and [@BeastleeUK](https://discord.com/channels/942908292873723984/942914154254176257/970366039294611506)\n
\n\n### Example Caddyfile - [Caddy Reverse Proxy](https://caddyserver.com/docs/caddyfile/directives/reverse_proxy)\n\n```\nsubdomain.domain.com {\n encode gzip zstd\n reverse_proxy :\n}\n```\n\n\n# Run from source\n\n[See discussion](https://github.com/advplyr/audiobookshelf/discussions/259#discussioncomment-1869729)\n\n# Contributing / How to Support\n\n[See the incomplete \"How to Support\" page](https://www.audiobookshelf.org/support)\n","has_starred","hub_user","immutable_tags_settings",{"_249":11,"_250":251},"enabled","rules",[252],".*","is_automated","permissions",{"_256":21,"_257":11,"_258":11},"read","write","admin","user","storage_size",139979748502,"isOrg","reponame","tag","sha256:aefa335129fdb9f56d660b5201e1eec95f8bd6789cded04bcba97059cb167aff","canDeleteTags","isHubSbxKitsEnabled","currentTab","tagAttestations","displaySecurityMetadata","showSbxLogoOverride","routes/_layout.layers.$namespace.$reponame.$tag.(images).($imageUrlDigest)._index",{"_27":28,"_206":-7,"_204":-7,"_205":-7,"_29":274,"_35":265,"_278":-7,"_279":11},{"_31":32,"_33":34,"_35":36,"_37":38,"_39":40,"_41":275,"_67":68,"_69":34,"_70":71,"_72":73,"_74":75,"_76":77,"_78":50,"_79":68,"_80":59,"_81":21},[276,277],{"_44":45,"_35":46,"_47":48,"_49":50,"_51":52,"_53":54,"_55":48,"_56":-5,"_57":38,"_58":59,"_60":-5},{"_44":62,"_35":63,"_47":48,"_49":64,"_51":65,"_53":54,"_55":48,"_56":-5,"_57":66,"_58":59,"_60":-5},"imageWithLayers","hasPermissionToViewRepoSettings","actionData","errors"]}

advplyr/audiobookshelf:latest