From cc84349d6d30bd1da86249551d212d84aed582ca Mon Sep 17 00:00:00 2001 From: Mark Cooper Date: Sat, 25 Sep 2021 16:23:57 -0500 Subject: [PATCH] Adding linux and ppa install to readme --- package.json | 3 +-- readme.md | 63 +++++++++++++++++++++++++++++++++++++++++++++++++--- 2 files changed, 61 insertions(+), 5 deletions(-) diff --git a/package.json b/package.json index 804aef70..b696b048 100644 --- a/package.json +++ b/package.json @@ -6,8 +6,7 @@ "scripts": { "dev": "node index.js", "start": "node index.js", - "client": "cd client && npm install && npm run generate-client", - "generate-client": "cd client && npm run generate", + "client": "cd client && npm install && npm run generate", "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-linux": "chmod -R 775 build && build/linuxpackager" diff --git a/readme.md b/readme.md index 953b9591..794150fb 100644 --- a/readme.md +++ b/readme.md @@ -66,13 +66,70 @@ Will save the title as `Hackers` and the subtitle as `Heroes of the Computer Rev ## Installation -Built to run in Docker for now (also on Unraid server Community Apps) +### Docker Install +Available in Unraid Community Apps ```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 :/audiobooks \ + -v :/config \ + -v :/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 git clone https://github.com/advplyr/audiobookshelf.git