add badges
Signed-off-by: gwg313 <gwg313@pm.me>
This commit is contained in:
parent
0650cb19e9
commit
946b17b68c
GPG key ID:
60FF63B4826B7400
17 changed files with 100 additions and 735 deletions
125
readme.md
125
readme.md
|
|
@ -2,7 +2,7 @@
|
|||
<div align="center">
|
||||
<img alt="Audiobookshelf Banner" src="https://github.com/advplyr/audiobookshelf/raw/master/images/banner.svg" width="600">
|
||||
|
||||
<p align="center">
|
||||
<p align="center">
|
||||
<br />
|
||||
<a href="https://audiobookshelf.org/docs">Documentation</a>
|
||||
·
|
||||
|
|
@ -16,9 +16,15 @@
|
|||
|
||||
Audiobookshelf is a self-hosted audiobook and podcast server.
|
||||
|
||||
### Build Status & Image
|
||||
|
||||
[](https://ci.gwg313.xyz/gwg313/audiobookshelf-rootless)
|
||||
[](https://registry.gwg313.xyz/harbor/projects/1/repositories/audiobookshelf/artifacts-tab?publicAndNotLogged=yes)
|
||||
|
||||
### Features
|
||||
|
||||
- Fully **open-source**, including the [android & iOS app](https://github.com/advplyr/audiobookshelf-app) _(in beta)_
|
||||
- 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
|
||||
- Multi-user support w/ custom permissions
|
||||
|
|
@ -37,25 +43,30 @@ Audiobookshelf is a self-hosted audiobook and podcast server.
|
|||
- Send ebook to device (i.e. Kindle)
|
||||
- Open RSS feeds for podcasts and audiobooks
|
||||
|
||||
Is there a feature you are looking for? [Suggest it](https://github.com/advplyr/audiobookshelf/issues/new/choose)
|
||||
Is there a feature you are looking for?
|
||||
[Suggest it](https://github.com/advplyr/audiobookshelf/issues/new/choose)
|
||||
|
||||
Join us on [Discord](https://discord.gg/HQgCbd6E75)
|
||||
|
||||
### Demo
|
||||
|
||||
Check out the web client demo: https://audiobooks.dev/ (thanks for hosting [@Vito0912](https://github.com/Vito0912)!)
|
||||
Check out the web client demo: https://audiobooks.dev/ (thanks for hosting
|
||||
[@Vito0912](https://github.com/Vito0912)!)
|
||||
|
||||
Username/password: `demo`/`demo` (user account)
|
||||
|
||||
### Android App (beta)
|
||||
|
||||
Try it out on the [Google Play Store](https://play.google.com/store/apps/details?id=com.audiobookshelf.app)
|
||||
Try it out on the
|
||||
[Google Play Store](https://play.google.com/store/apps/details?id=com.audiobookshelf.app)
|
||||
|
||||
### iOS App (beta)
|
||||
|
||||
**Beta is currently full. Apple has a hard limit of 10k beta testers. Updates will be posted in Discord.**
|
||||
**Beta is currently full. Apple has a hard limit of 10k beta testers. Updates
|
||||
will be posted in Discord.**
|
||||
|
||||
Using Test Flight: https://testflight.apple.com/join/wiic7QIW **_(beta is full)_**
|
||||
Using Test Flight: https://testflight.apple.com/join/wiic7QIW **_(beta is
|
||||
full)_**
|
||||
|
||||
### Build your own tools & clients
|
||||
|
||||
|
|
@ -71,7 +82,9 @@ Check out the [API documentation](https://api.audiobookshelf.org/)
|
|||
|
||||
#### Directory structure and folder names are important to Audiobookshelf!
|
||||
|
||||
See [documentation](https://audiobookshelf.org/docs#book-directory-structure) for supported directory structure, folder naming conventions, and audio file metadata usage.
|
||||
See [documentation](https://audiobookshelf.org/docs#book-directory-structure)
|
||||
for supported directory structure, folder naming conventions, and audio file
|
||||
metadata usage.
|
||||
|
||||
<br />
|
||||
|
||||
|
|
@ -95,7 +108,8 @@ 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.
|
||||
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
|
||||
server {
|
||||
|
|
@ -130,7 +144,8 @@ server {
|
|||
|
||||
### 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.
|
||||
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`:
|
||||
|
||||
|
|
@ -164,17 +179,21 @@ For this to work you must enable at least the following mods using `a2enmod`:
|
|||
</IfModule>
|
||||
```
|
||||
|
||||
If using Apache >= 2.4.47 you can use the following, without having to use any of the `RewriteEngine`, `RewriteCond`, or `RewriteRule` directives. For example:
|
||||
If using Apache >= 2.4.47 you can use the following, without having to use any
|
||||
of the `RewriteEngine`, `RewriteCond`, or `RewriteRule` directives. For example:
|
||||
|
||||
```xml
|
||||
<Location /audiobookshelf>
|
||||
ProxyPreserveHost on
|
||||
ProxyPass http://localhost:<audiobookshelf_port>/audiobookshelf upgrade=websocket
|
||||
ProxyPassReverse http://localhost:<audiobookshelf_port>/audiobookshelf
|
||||
</Location>
|
||||
<Location /audiobookshelf>
|
||||
ProxyPreserveHost on
|
||||
ProxyPass http://localhost:<audiobookshelf_port>/audiobookshelf upgrade=websocket
|
||||
ProxyPassReverse http://localhost:<audiobookshelf_port>/audiobookshelf
|
||||
</Location>
|
||||
```
|
||||
|
||||
Some SSL certificates like those signed by Let's Encrypt require ACME validation. To allow Let's Encrypt to write and confirm the ACME challenge, edit your VirtualHost definition to prevent proxying traffic that queries `/.well-known` and instead serve that directly:
|
||||
Some SSL certificates like those signed by Let's Encrypt require ACME
|
||||
validation. To allow Let's Encrypt to write and confirm the ACME challenge, edit
|
||||
your VirtualHost definition to prevent proxying traffic that queries
|
||||
`/.well-known` and instead serve that directly:
|
||||
|
||||
```bash
|
||||
<VirtualHost *:443>
|
||||
|
|
@ -245,7 +264,9 @@ Some SSL certificates like those signed by Let's Encrypt require ACME validation
|
|||
|
||||
### [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:
|
||||
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>
|
||||
|
|
@ -253,7 +274,11 @@ Middleware relating to CORS will cause the app to report Unknown Error when logg
|
|||
<li>accessControlMaxAge</li>
|
||||
</ul>
|
||||
|
||||
From [@Dondochaka](https://discord.com/channels/942908292873723984/942914154254176257/945074590374318170) and [@BeastleeUK](https://discord.com/channels/942908292873723984/942914154254176257/970366039294611506) <br />
|
||||
From
|
||||
[@Dondochaka](https://discord.com/channels/942908292873723984/942914154254176257/945074590374318170)
|
||||
and
|
||||
[@BeastleeUK](https://discord.com/channels/942908292873723984/942914154254176257/970366039294611506)
|
||||
<br />
|
||||
|
||||
### Example Caddyfile - [Caddy Reverse Proxy](https://caddyserver.com/docs/caddyfile/directives/reverse_proxy)
|
||||
|
||||
|
|
@ -304,7 +329,6 @@ backend default_backend
|
|||
|
||||
# Define the server for the default backend
|
||||
server default_server 127.0.0.123:8081
|
||||
|
||||
```
|
||||
|
||||
### pfSense and HAProxy
|
||||
|
|
@ -342,10 +366,13 @@ The `Name` needs to match the `Parameters` above `audiobookshelf`.
|
|||
|
||||
##### Health checking:
|
||||
|
||||
Health checking is enabled by default. `Http check method` of `OPTIONS` is not supported on Audiobookshelf. If Health check fails, data will not be forwared. Need to do one of following:
|
||||
Health checking is enabled by default. `Http check method` of `OPTIONS` is not
|
||||
supported on Audiobookshelf. If Health check fails, data will not be forwared.
|
||||
Need to do one of following:
|
||||
|
||||
- To disable: Change `Health check method` to `none`.
|
||||
- To make Health checking function: Change `Http check method` to `HEAD` or `GET`.
|
||||
- To make Health checking function: Change `Http check method` to `HEAD` or
|
||||
`GET`.
|
||||
|
||||
# Run from source
|
||||
|
||||
|
|
@ -355,18 +382,28 @@ This application is built using [NodeJs](https://nodejs.org/).
|
|||
|
||||
### Localization
|
||||
|
||||
Thank you to [Weblate](https://hosted.weblate.org/engage/audiobookshelf/) for hosting our localization infrastructure pro-bono. If you want to see Audiobookshelf in your language, please help us localize. Additional information on helping with the translations [here](https://www.audiobookshelf.org/faq#how-do-i-help-with-translations). <a href="https://hosted.weblate.org/engage/audiobookshelf/"> <img src="https://hosted.weblate.org/widget/audiobookshelf/abs-web-client/horizontal-auto.svg" alt="Translation status" /> </a>
|
||||
Thank you to [Weblate](https://hosted.weblate.org/engage/audiobookshelf/) for
|
||||
hosting our localization infrastructure pro-bono. If you want to see
|
||||
Audiobookshelf in your language, please help us localize. Additional information
|
||||
on helping with the translations
|
||||
[here](https://www.audiobookshelf.org/faq#how-do-i-help-with-translations).
|
||||
<a href="https://hosted.weblate.org/engage/audiobookshelf/">
|
||||
<img src="https://hosted.weblate.org/widget/audiobookshelf/abs-web-client/horizontal-auto.svg" alt="Translation status" />
|
||||
</a>
|
||||
|
||||
### Dev Container Setup
|
||||
|
||||
The easiest way to begin developing this project is to use a dev container. An introduction to dev containers in VSCode can be found [here](https://code.visualstudio.com/docs/devcontainers/containers).
|
||||
The easiest way to begin developing this project is to use a dev container. An
|
||||
introduction to dev containers in VSCode can be found
|
||||
[here](https://code.visualstudio.com/docs/devcontainers/containers).
|
||||
|
||||
Required Software:
|
||||
|
||||
- [Docker Desktop](https://www.docker.com/products/docker-desktop/)
|
||||
- [VSCode](https://code.visualstudio.com/download)
|
||||
|
||||
_Note, it is possible to use other container software than Docker and IDEs other than VSCode. However, this setup is more complicated and not covered here._
|
||||
_Note, it is possible to use other container software than Docker and IDEs other
|
||||
than VSCode. However, this setup is more complicated and not covered here._
|
||||
|
||||
<div>
|
||||
<details>
|
||||
|
|
@ -413,15 +450,24 @@ sudo snap install code --classic
|
|||
</details>
|
||||
</div>
|
||||
|
||||
After installing these packages, you can now install the [Remote Development](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.vscode-remote-extensionpack) extension for VSCode. After installing this extension open the command pallet (`ctrl+shift+p` or `cmd+shift+p`) and select the command `>Dev Containers: Rebuild and Reopen in Container`. This will cause the development environment container to be built and launched.
|
||||
After installing these packages, you can now install the
|
||||
[Remote Development](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.vscode-remote-extensionpack)
|
||||
extension for VSCode. After installing this extension open the command pallet
|
||||
(`ctrl+shift+p` or `cmd+shift+p`) and select the command
|
||||
`>Dev Containers: Rebuild and Reopen in Container`. This will cause the
|
||||
development environment container to be built and launched.
|
||||
|
||||
You are now ready to start development!
|
||||
|
||||
### Manual Environment Setup
|
||||
|
||||
If you don't want to use the dev container, you can still develop this project. First, you will need to install [NodeJs](https://nodejs.org/) (version 20) and [FFmpeg](https://ffmpeg.org/).
|
||||
If you don't want to use the dev container, you can still develop this project.
|
||||
First, you will need to install [NodeJs](https://nodejs.org/) (version 20) and
|
||||
[FFmpeg](https://ffmpeg.org/).
|
||||
|
||||
Next you will need to create a `dev.js` file in the project's root directory. This contains configuration information and paths unique to your development environment. You can find an example of this file in `.devcontainer/dev.js`.
|
||||
Next you will need to create a `dev.js` file in the project's root directory.
|
||||
This contains configuration information and paths unique to your development
|
||||
environment. You can find an example of this file in `.devcontainer/dev.js`.
|
||||
|
||||
You are now ready to build the client:
|
||||
|
||||
|
|
@ -435,13 +481,28 @@ cd ..
|
|||
|
||||
### Development Commands
|
||||
|
||||
After setting up your development environment, either using the dev container or using your own custom environment, the following commands will help you run the server and client.
|
||||
After setting up your development environment, either using the dev container or
|
||||
using your own custom environment, the following commands will help you run the
|
||||
server and client.
|
||||
|
||||
To run the server, you can use the command `npm run dev`. This will use the client that was built when you ran `npm run generate` in the client directory or when you started the dev container. If you make changes to the server, you will need to restart the server. If you make changes to the client, you will need to run the command `(cd client; npm run generate)` and then restart the server. By default the client runs at `localhost:3333`, though the port can be configured in `dev.js`.
|
||||
To run the server, you can use the command `npm run dev`. This will use the
|
||||
client that was built when you ran `npm run generate` in the client directory or
|
||||
when you started the dev container. If you make changes to the server, you will
|
||||
need to restart the server. If you make changes to the client, you will need to
|
||||
run the command `(cd client; npm run generate)` and then restart the server. By
|
||||
default the client runs at `localhost:3333`, though the port can be configured
|
||||
in `dev.js`.
|
||||
|
||||
You can also build a version of the client that supports live reloading. To do this, start the server, then run the command `(cd client; npm run dev)`. This will run a separate instance of the client at `localhost:3000` that will be automatically updated as you make changes to the client.
|
||||
You can also build a version of the client that supports live reloading. To do
|
||||
this, start the server, then run the command `(cd client; npm run dev)`. This
|
||||
will run a separate instance of the client at `localhost:3000` that will be
|
||||
automatically updated as you make changes to the client.
|
||||
|
||||
If you are using VSCode, this project includes a couple of pre-defined targets to speed up this process. First, if you build the project (`ctrl+shift+b` or `cmd+shift+b`) it will automatically generate the client. Next, there are debug commands for running the server and client. You can view these targets using the debug panel (bring it up with (`ctrl+shift+d` or `cmd+shift+d`):
|
||||
If you are using VSCode, this project includes a couple of pre-defined targets
|
||||
to speed up this process. First, if you build the project (`ctrl+shift+b` or
|
||||
`cmd+shift+b`) it will automatically generate the client. Next, there are debug
|
||||
commands for running the server and client. You can view these targets using the
|
||||
debug panel (bring it up with (`ctrl+shift+d` or `cmd+shift+d`):
|
||||
|
||||
- `Debug server`—Run the server.
|
||||
- `Debug client (nuxt)`—Run the client with live reload.
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue