# heavy_script
## Website
[HeavySetup - Further In-Depth Explanation](https://heavysetup.info/scripts/heavyscript/about/)
## Table of contents:
* [Arguments](#arguments)
* [Examples](#examples)
* [How to Install](#how-to-install)
* [How to Update](#how-to-update)
* [Creating a Cron Job](#creating-a-cron-job)
* [Additional Information](#additional-information)
## The Menu
> Access this with `bash heavy_script.sh`
## Update Arguments
| Flag | Example | Parameter | Description |
|--------------- |------------------------ |----------------- |---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| -U | -U
-U 5 | None or Integer | Update applications, ignoring major version changes
_Optionally, you can supply a number after the argument to update multiple applications at once_ |
| -u | -u
-u 5 | None or Integer | Update applications, do NOT update if there was a major version change
_Optionally, you can supply a number after the argument to update multiple applications at once_ |
| -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_ |
| -r | -r | None | Monitors applications after they update
If the app does not become "ACTIVE" after either:
The custom Timeout, or Default Timeout,
rollback the application. |
| -v | -v | None | Verbose Output
_Look at the bottom of this page for an example_ |
| -S | -S | None | Shutdown the application prior to updating it |
| -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 |
| --self-update | --self-update | None | Updates HeavyScript prior to running any other commands |
### Example
#### Typical Cron Job
```
bash heavy_script.sh --self-update -b 10 -i portainer -i arch -i sonarr -i radarr -t 600 -rsp -u 5
```
> `-b` is set to 10. Up to 10 snapshots of your ix-applications dataset will be saved
> `-i` is set to ignore portainer, arch, sonarr, and radarr. These applications will be ignored when it comes to updates.
> `-t` I set it to 600 seconds, this means the script will wait 600 seconds for the application to become ACTIVE before timing out and continuing to a different application.
> `-r` Will rollback applications if they fail to deploy after updating.
> `-s` will just sync the repositories, ensuring you are downloading the latest updates.
> `-p` Prune docker images.
> `-u` update applications as long as the major version has absolutely no change, if it does have a change it will ask the user to update manually.
>> The `5` after the `-u` means up to 5 applications will be updating and monitored at one time
> `--self-update` Will update the script prior to running anything else.
## Other Utilities
> All of these can ALSO be accessed with the HeavyScript menu, that you can access simply by not providing an argument `bash heavy_script.sh`
| Flag | Example | Parameter | Description |
|----------------- |----------------- |----------- |---------------------------------------------------------------------------------------------- |
| --mount | --mount | None | Initiates mounting feature, choose between unmounting and mounting PVC data |
| --restore | --restore | None | Opens a menu to restore a heavy_script backup that was taken on your ix-applications dataset |
| --delete-backup | --delete-backup | None | Opens a menu to delete backups on your system |
| --dns | --dns | None | list all of your applications DNS names and their web ports |
| --cmd | --cmd | None | Open a shell for one of your applications |
### Examples
#### Mounting PVC Data
```
bash /mnt/tank/scripts/heavy_script.sh -t 300 --mount
```
#### Restoring ix-applications dataset
```
bash /mnt/tank/scripts/heavy_script/heavy_script.sh --restore
```
#### Deleting Backups
```
bash /mnt/tank/scripts/heavy_script/heavy_script.sh --delete-backup
```
#### List All DNS Names
```
bash /mnt/tank/scripts/heavy_script/heavy_script.sh --dns
```
#### My personal Cron Job
```
bash /mnt/speed/scripts/heavy_script/heavy_script.sh --self-update -b 10 -rsp -u 10
```
## How to Install
### Create a Scripts Dataset
I created a `scripts` dataset on my Truenas SCALE system, this is where all my scripts will remain.
### Open a Terminal
**Change Directory to your scripts folder**
```
cd /mnt/speed/scripts
```
**Git Clone Heavy_Script**
```
git clone https://github.com/Heavybullets8/heavy_script.git
```
**Change Directory to Heavy_Script folder**
```
cd heavy_script
```
From here, you can just run Heavy_Script with `bash heavy_script.sh -ARGUMENTS`
> Note: `chmod +x` is NOT required. Doing this will break the `git pull` (or self update) function. Just run the script with `bash heavy_script.sh`
## How to Update
### Manually
#### Open a Terminal
**Change Directory to your heavy_script folder**
```
cd /mnt/speed/scripts/heavy_script
```
**git pull**
```
git pull
```
### Update with the scripts built-in option
```
bash heavyscript.sh --self-update -b 10 -supr
```
> The important argument here is the `--self-update`, you can still use all of your same arguments with this option.
## Creating a Cron Job
1. TrueNAS SCALE GUI
2. System Settings
3. Advanced
4. Cron Jobs
1. Click Add
| Name | Value | Reason |
|------------------------ |------------------------------------------------------------------------------------------------------------------- |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `Description` | HeavyScript git pull and Update apps | This is up to you, put whatever you think is a good description in here |
| `Command` | `bash /PATH/TO/HEAVY_SCRIPT_DIRECTORY/heavy_script.sh --self-update -b 10 -rsp -u 10` | This is the command you will be running on your schedule I personally use: `bash /mnt/speed/scripts/heavy_script/heavy_script.sh --self-update -b 10 -rsp -u 10` |
| `Run As User` | `root` | Running the script as `root` is REQUIRED. You cannot access all of the kubernetes functions without this user. |
| `Schedule` | Up to you, I run mine everyday at `0400` | Again up to you |
| `Hide Standard Output` | `False` or Unticked | I like to receive an email report of how the script ran, what apps updated etc. |
| `Hide Standard Error` | `False` or Unticked | I want to see any errors that occur |
| `Enabled` | `True` or Ticked | This will Enable the script to run on your schedule |
### Additional Information
#### Verbose vs Non-Verbose
- Verbose used `bash heavy_script.sh -b 5 -Srupv`
- Non-Verbose used `bash heavy_script.sh -b 5 -Srup`
| Verbose | Non-Verbose |
|--------- |------------- |
|  |  |