diff --git a/README.md b/README.md index 93789fbe..36f877a4 100644 --- a/README.md +++ b/README.md @@ -33,7 +33,7 @@ It also offers a few handy shortcuts for commonly required chores, like: Enablin | -u | -u | None | Update applications, do NOT update if there was a major version change | | -b | -b 14 | Integer | Backup `ix-appliactions` dataset
_Creates backups up to the number you've chosen_ | | -i | -i nextcloud -i sonarr | String | Applications listed will be ignored during updating
_List one application after another as shown in the example_ | -| -v | -v | None | Verbose Output
_Look at the bottom of this page for an example_ | +| -v | -v | None | Verbose Output
_ | | -t | -t 150 | Integer | Set a custom timeout to be used with either:
`-m`
_Time the script will wait for application to be "STOPPED"_
or
`-(u\|U)`
_Time the script will wait for application to be either "STOPPED" or "ACTIVE"_ | | -s | -s | None | Sync Catalogs prior to updating | | -p | -p | None | Prune old/unused docker images | @@ -45,10 +45,20 @@ It also offers a few handy shortcuts for commonly required chores, like: Enablin ## How to Install -### Create a Scripts Dataset +### Choose a folder + +It's important to save the script in a folder that is persistent across TrueNAS System Updates. +This saves you from reinstalling or experiencing an accidental lack-of-backups after an update. + +##### New dataset In this example we created a `scripts` dataset on the Truenas SCALE system, feel free to use another folder. +##### Root folder + +The `/root` folder houses files for the root user. +It's also persistent across updates and hence can be safely used for storing the script. + ### Open a Terminal **Change Directory to your scripts folder** @@ -76,18 +86,6 @@ TrueTool updates itself automatically.
-### Update with your Cron Job - -Here, we will update the script prior to running it, incase there is a bugfix, or any new additions to the script - -**Cron Job Command** -``` -bash /mnt/pool/scripts/truetool/truetool.sh -b 14 -rsup -``` - -
-
- ## Creating a Cron Job 1. TrueNAS SCALE GUI diff --git a/truetool.sh b/truetool.sh index a4881eb3..c73b7411 100755 --- a/truetool.sh +++ b/truetool.sh @@ -126,7 +126,7 @@ title [[ "$enableUpdate" == "true" ]] && updater "$@" -#If no argument is passed, set flag to show menu +# Show menu if menu flag is set if [[ "$no_args" == "true" ]]; then no_args fi