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

update readme

Browse Source 
will update with a longer, proper readme later.
This commit is contained in:
Heavybullets8 2022-05-10 04:53:19 +00:00 committed by GitHub
parent b4e5b45045
commit 9d2f21d31f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 3 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@ -2,11 +2,13 @@
Script that can: Update Truenas SCALE applications, Mount and unmount PVC storage, Prune Docker images. Script that can: Update Truenas SCALE applications, Mount and unmount PVC storage, Prune Docker images.
## These arguments NEED to be ran in a specific order, you can go from TOP to BOTTOM, see example below
- -m | Initiates mounting feature, choose between unmounting and mounting PVC data" - -m | Initiates mounting feature, choose between unmounting and mounting PVC data"
- -r | Opens a menu to restore a HeavyScript backup that was taken on you ix-applications pool" - -r | Opens a menu to restore a HeavyScript backup that was taken on you ix-applications pool"
- -b | Back-up your ix-applications dataset, specify a number after -b" - -b | Back-up your ix-applications dataset, specify a number after -b"
- -i | Add application to ignore list, one by one, see example below." - -i | Add application to ignore list, one by one, see example below."
- -R | Roll-back applications if they fail to update
- -S | Shutdown applications prior to updating
- -v | verbose output
- -t | Set a custom timeout in seconds for -u or -U: This is the ammount of time the script will wait for an application to go from DEPLOYING to ACTIVE" - -t | Set a custom timeout in seconds for -u or -U: This is the ammount of time the script will wait for an application to go from DEPLOYING to ACTIVE"
- -t | Set a custom timeout in seconds for -m: Amount of time script will wait for applications to stop, before timing out" - -t | Set a custom timeout in seconds for -m: Amount of time script will wait for applications to stop, before timing out"
- -s | sync catalog" - -s | sync catalog"