julian/scale-catalog
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs changes

Browse Source
This commit is contained in:
Kjeld Schouten-Lebbing 2022-06-16 12:15:31 +02:00
parent 4fa845679e
commit c67849a393
No known key found for this signature in database
GPG Key ID: 3D586240A9175B99
2 changed files with 13 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
README.md
View File

@ -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 | | -u | -u | None | Update applications, do NOT update if there was a major version change |
| -b | -b 14 | Integer | Backup `ix-appliactions` dataset<br>_Creates backups up to the number you've chosen_ | | -b | -b 14 | Integer | Backup `ix-appliactions` dataset<br>_Creates backups up to the number you've chosen_ |
| -i | -i nextcloud -i sonarr | String | Applications listed will be ignored during updating<br>_List one application after another as shown in the example_ | | -i | -i nextcloud -i sonarr | String | Applications listed will be ignored during updating<br>_List one application after another as shown in the example_ |
| -v | -v | None | Verbose Output<br>_Look at the bottom of this page for an example_ | | -v | -v | None | Verbose Output<br>_ |
| -t | -t 150 | Integer | Set a custom timeout to be used with either:<br>`-m` <br>_Time the script will wait for application to be "STOPPED"_<br>or<br>`-(u\|U)` <br>_Time the script will wait for application to be either "STOPPED" or "ACTIVE"_ | | -t | -t 150 | Integer | Set a custom timeout to be used with either:<br>`-m` <br>_Time the script will wait for application to be "STOPPED"_<br>or<br>`-(u\|U)` <br>_Time the script will wait for application to be either "STOPPED" or "ACTIVE"_ |
| -s | -s | None | Sync Catalogs prior to updating | | -s | -s | None | Sync Catalogs prior to updating |
| -p | -p | None | Prune old/unused docker images | | -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 ## 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. 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 ### Open a Terminal
**Change Directory to your scripts folder** **Change Directory to your scripts folder**
@ -76,18 +86,6 @@ TrueTool updates itself automatically.
<br > <br >
### 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
```
<br >
<br >
## Creating a Cron Job ## Creating a Cron Job
1. TrueNAS SCALE GUI 1. TrueNAS SCALE GUI

2
truetool.sh
View File

@ -126,7 +126,7 @@ title
[[ "$enableUpdate" == "true" ]] && updater "$@" [[ "$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 if [[ "$no_args" == "true" ]]; then
no_args no_args
fi fi