From f9bf846b3095eae23b22f24a33ea83172aeebf81 Mon Sep 17 00:00:00 2001 From: advplyr Date: Sun, 24 Oct 2021 16:05:58 -0500 Subject: [PATCH] readme and version update --- client/package.json | 2 +- package.json | 2 +- readme.md | 36 ++++++++++++++++++------------------ 3 files changed, 20 insertions(+), 20 deletions(-) diff --git a/client/package.json b/client/package.json index ce10fb01..6d4b3a2e 100644 --- a/client/package.json +++ b/client/package.json @@ -1,6 +1,6 @@ { "name": "audiobookshelf-client", - "version": "1.5.0", + "version": "1.5.1", "description": "Audiobook manager and player", "main": "index.js", "scripts": { diff --git a/package.json b/package.json index 0ede2cdf..64086520 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "audiobookshelf", - "version": "1.5.0", + "version": "1.5.1", "description": "Self-hosted audiobook server for managing and playing audiobooks", "main": "index.js", "scripts": { diff --git a/readme.md b/readme.md index 54f802d1..e7eaf279 100644 --- a/readme.md +++ b/readme.md @@ -39,8 +39,6 @@ Android app is in beta, try it out on the [Google Play Store](https://play.googl See [documentation](https://audiobookshelf.org/docs) for supported directory structure, folder naming conventions, and audio file metadata usage. - - ## Installation ** Default username is "root" with no password @@ -103,23 +101,11 @@ System Service: `/lib/systemd/system/audiobookshelf.service` Ffmpeg static build: `/usr/lib/audiobookshelf-ffmpeg/` -## Run from source +## Reverse Proxy Set Up -Note: you will need `npm`, `node12`, and `ffmpeg` to run this project locally +### NGINX Reverse Proxy -```bash -git clone https://github.com/advplyr/audiobookshelf.git -cd audiobookshelf - -# All paths default to root directory. Config path is the database. -# Directories will be created if they don't exist -# Paths are relative to the root directory, so "../Audiobooks" would be a valid path -npm run prod -- -p [PORT] --audiobooks [AUDIOBOOKS_PATH] --config [CONFIG_PATH] --metadata [METADATA_PATH] -``` - -### 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 the path to you certificates. +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 @@ -151,7 +137,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 the path to you certificates. +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` @@ -181,6 +168,19 @@ For this to work you must enable at least the following mods using `a2enmod`: ``` +## 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 +cd audiobookshelf + +# All paths default to root directory. Config path is the database. +# Directories will be created if they don't exist +# Paths are relative to the root directory, so "../Audiobooks" would be a valid path +npm run prod -- -p [PORT] --audiobooks [AUDIOBOOKS_PATH] --config [CONFIG_PATH] --metadata [METADATA_PATH] +``` ## Contributing