mirror of
https://github.com/advplyr/audiobookshelf.git
synced 2024-12-20 19:06:06 +01:00
Adding linux and ppa install to readme
This commit is contained in:
parent
b5e83d8866
commit
cc84349d6d
@ -6,8 +6,7 @@
|
|||||||
"scripts": {
|
"scripts": {
|
||||||
"dev": "node index.js",
|
"dev": "node index.js",
|
||||||
"start": "node index.js",
|
"start": "node index.js",
|
||||||
"client": "cd client && npm install && npm run generate-client",
|
"client": "cd client && npm install && npm run generate",
|
||||||
"generate-client": "cd client && npm run generate",
|
|
||||||
"prod": "npm run client && npm install && node prod.js",
|
"prod": "npm run client && npm install && node prod.js",
|
||||||
"build-win": "npm run build-prep && pkg -t node12-win-x64 -o ./dist/win/audiobookshelf .",
|
"build-win": "npm run build-prep && pkg -t node12-win-x64 -o ./dist/win/audiobookshelf .",
|
||||||
"build-linux": "chmod -R 775 build && build/linuxpackager"
|
"build-linux": "chmod -R 775 build && build/linuxpackager"
|
||||||
|
63
readme.md
63
readme.md
@ -66,13 +66,70 @@ Will save the title as `Hackers` and the subtitle as `Heroes of the Computer Rev
|
|||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
Built to run in Docker for now (also on Unraid server Community Apps)
|
### Docker Install
|
||||||
|
Available in Unraid Community Apps
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
docker run -d -p 1337:80 -v /audiobooks:/audiobooks -v /config:/config -v /metadata:/metadata --name audiobookshelf --rm advplyr/audiobookshelf
|
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
|
||||||
```
|
```
|
||||||
|
|
||||||
## Running on your local
|
### 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
|
||||||
|
|
||||||
|
A PPA is setup on github [here](https://github.com/advplyr/audiobookshelf-ppa).
|
||||||
|
```bash
|
||||||
|
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
|
||||||
|
|
||||||
|
```bash
|
||||||
|
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
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Debian package
|
||||||
|
|
||||||
|
All other linux distros can just `wget` the `deb` file.
|
||||||
|
|
||||||
|
```bash
|
||||||
|
wget https://advplyr.github.io/audiobookshelf-ppa/audiobookshelf_1.2.1_amd64.deb
|
||||||
|
|
||||||
|
sudo apt install ./audiobookshelf_1.2.1_amd64.deb
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
#### 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
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
git clone https://github.com/advplyr/audiobookshelf.git
|
git clone https://github.com/advplyr/audiobookshelf.git
|
||||||
|
Loading…
Reference in New Issue
Block a user