audiobookshelf/readme.md

193 lines
6.5 KiB
Markdown
Raw Normal View History

2021-10-09 21:54:45 +02:00
<br />
<div align="center">
<img alt="Audiobookshelf Banner" src="https://github.com/advplyr/audiobookshelf/raw/master/images/banner.svg" width="600">
2021-10-09 21:54:45 +02:00
<p align="center">
<br />
<a href="https://audiobookshelf.org/docs">Documentation</a>
·
2022-12-24 18:29:58 +01:00
<a href="https://audiobookshelf.org/guides">User Guides</a>
2021-10-09 21:54:45 +02:00
·
2021-12-23 02:18:32 +01:00
<a href="https://audiobookshelf.org/support">Support</a>
2021-10-09 21:54:45 +02:00
</p>
</div>
# About
2021-09-26 19:08:48 +02:00
Audiobookshelf is a self-hosted audiobook and podcast server.
2021-10-09 21:54:45 +02:00
### Features
2021-09-04 21:35:25 +02:00
2022-01-15 02:10:17 +01:00
* Fully **open-source**, including the [android & iOS app](https://github.com/advplyr/audiobookshelf-app) *(in beta)*
* Stream all audio formats on the fly
* Search and add podcasts to download episodes w/ auto-download
2021-10-09 21:54:45 +02:00
* 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
2021-10-09 21:54:45 +02:00
* Backup your metadata + automated daily backups
2022-02-27 18:02:33 +01:00
* Progressive Web App (PWA)
* Chromecast support on the web app and android app
2022-02-27 18:02:33 +01:00
* Fetch metadata and cover art from several sources
2022-10-15 22:42:52 +02:00
* Chapter editor and chapter lookup (using [Audnexus API](https://audnex.us/))
* Merge your audio files into a single m4b
* Embed metadata and cover image into your audio files (using [Tone](https://github.com/sandreas/tone))
2022-04-24 18:14:30 +02:00
* Basic ebook support and e-reader *(experimental)*
2022-02-15 00:45:37 +01:00
Is there a feature you are looking for? [Suggest it](https://github.com/advplyr/audiobookshelf/issues/new/choose)
2021-10-09 21:54:45 +02:00
2022-12-24 18:32:40 +01:00
Join us on [Discord](https://discord.gg/pJsjuNCKRq) or [Matrix](https://matrix.to/#/#audiobookshelf:matrix.org)
2022-02-15 00:45:37 +01:00
2022-02-15 00:46:40 +01:00
### Android App (beta)
2022-02-15 00:45:37 +01:00
Try it out on the [Google Play Store](https://play.google.com/store/apps/details?id=com.audiobookshelf.app)
2022-12-24 18:29:58 +01:00
### iOS App (beta)
2022-02-15 00:45:37 +01:00
Available using Test Flight: https://testflight.apple.com/join/wiic7QIW - [Join the discussion](https://github.com/advplyr/audiobookshelf-app/discussions/60)
2022-12-24 18:29:58 +01:00
### Build your own tools & clients
Check out the [API documentation](https://api.audiobookshelf.org/)
2022-02-15 00:46:40 +01:00
<br />
2022-01-08 22:07:52 +01:00
2023-03-10 23:23:07 +01:00
<img alt="Library Screenshot" src="https://github.com/advplyr/audiobookshelf/raw/master/images/DemoLibrary.png" />
2022-02-12 00:18:56 +01:00
<br />
# Organizing your audiobooks
2021-08-20 02:21:04 +02:00
2021-12-16 02:48:24 +01:00
#### Directory structure and folder names are important to Audiobookshelf!
2021-09-27 00:20:41 +02:00
2022-12-24 18:29:58 +01:00
See [documentation](https://audiobookshelf.org/docs#book-directory-structure) for supported directory structure, folder naming conventions, and audio file metadata usage.
2021-08-20 02:21:04 +02:00
<br />
# Installation
2022-12-24 18:29:58 +01:00
See [install docs](https://www.audiobookshelf.org/docs)
2021-09-26 00:58:06 +02:00
2022-12-24 18:32:40 +01:00
<br />
2022-02-12 00:18:56 +01:00
# Reverse Proxy Set Up
#### Important! Audiobookshelf requires a websocket connection.
2022-12-24 20:32:45 +01:00
#### Note: Subfolder paths (e.g. /audiobooks) are not supported yet. See [issue](https://github.com/advplyr/audiobookshelf/issues/385)
### NGINX Proxy Manager
Toggle websockets support.
<img alt="NGINX Web socket" src="https://user-images.githubusercontent.com/67830747/153679106-b2a7f5b9-0702-48c6-9740-b26b401986e9.png" />
2021-10-24 23:05:58 +02:00
### NGINX Reverse Proxy
2021-10-24 23:05:58 +02:00
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.
```bash
2021-10-24 02:13:29 +02:00
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
2021-10-24 23:05:58 +02:00
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`
```bash
<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>
```
2021-11-01 21:40:39 +01:00
### SWAG Reverse Proxy
[See this solution](https://forums.unraid.net/topic/112698-support-audiobookshelf/?do=findComment&comment=1049637)
### Synology Reverse Proxy
1. Open Control Panel > Application Portal
2. Change to the Reverse Proxy tab
3. Select the proxy rule for which you want to enable Websockets and click on Edit
4. Change to the "Custom Header" tab
5. Click Create > WebSocket
6. Click Save
[from @silentArtifact](https://github.com/advplyr/audiobookshelf/issues/241#issuecomment-1036732329)
### [Traefik Reverse Proxy](https://doc.traefik.io/traefik/)
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:
<ul>
<li>accessControlAllowMethods</li>
<li>accessControlAllowOriginList</li>
<li>accessControlMaxAge</li>
</ul>
From [@Dondochaka](https://discord.com/channels/942908292873723984/942914154254176257/945074590374318170) and [@BeastleeUK](https://discord.com/channels/942908292873723984/942914154254176257/970366039294611506)
2022-02-12 00:18:56 +01:00
<br />
### Example Caddyfile - [Caddy Reverse Proxy](https://caddyserver.com/docs/caddyfile/directives/reverse_proxy)
```
subdomain.domain.com {
encode gzip zstd
2022-12-25 18:32:12 +01:00
reverse_proxy <LOCAL_IP>:<PORT>
}
```
# Run from source
2021-10-24 23:05:58 +02:00
2022-01-15 02:10:17 +01:00
[See discussion](https://github.com/advplyr/audiobookshelf/discussions/259#discussioncomment-1869729)
# Contributing / How to Support
2021-12-16 02:48:24 +01:00
[See the incomplete "How to Support" page](https://www.audiobookshelf.org/support)