Update readme tutorial

As requested by Debug78 on the FreeNAS forum (PM) some more more thorough instructions
This commit is contained in:
Kjeld Schouten-Lebbing 2020-03-07 17:39:37 +01:00 committed by GitHub
parent 30f01cf4d6
commit 35302bf90a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -13,9 +13,13 @@ If something goes wrong with Jackett, you just use:
## Install ## Install
- Get into FreeNAS using the in-gui console or SSH.
Run the following commands to install jailman:
- `git clone https://github.com/Ornias1993/jailman.git` - `git clone https://github.com/Ornias1993/jailman.git`
- `cp config.yml.ex. config.yml` - `cd jailman`
- edit config.yml to reflect your personal settings - `cp config.yml.example config.yml`
- edit config.yml to reflect your personal settings (optional, see "use")
- Run one of the commands under "use"
Thats all. Thats all.
@ -29,12 +33,22 @@ For supported jails, please see this readme or config.yml.example
- Install: - Install:
`jailman.sh -i $jailname` `jailman.sh -i $jailname`
Example:
`jailman.sh -i sonarr`
- ReInstall: - ReInstall:
`jailman.sh -r $jailname` `jailman.sh -r $jailname`
Example:
`jailman.sh -r sonarr`
- Destroy - Destroy
`jailman.sh -d $jailname` `jailman.sh -d $jailname`
Example:
`jailman.sh -d sonarr`
You can also do multiple jails in one pass:
Example:
`jailman.sh -i sonarr radarr lidarr`
This installs the jail, creates the config dataset if needed, installs all packages and sets them up for you. This installs the jail, creates the config dataset if needed, installs all packages and sets them up for you.
Only thing you need to do is do the setup of the packages in their respective GUI. Only thing you need to do is do the setup of the packages in their respective GUI.
@ -80,4 +94,4 @@ https://github.com/SystemRage/py-kms
### LICENCE ### LICENCE
This work is dual licenced under GPLv2 and BSD-2 clause This work is dual licenced under GPLv2 and BSD-2 clause