From 7a23b178e0a830db73302beeb83874a6da261159 Mon Sep 17 00:00:00 2001 From: Heavybullets8 Date: Tue, 16 Aug 2022 20:23:26 -0600 Subject: [PATCH] update readme --- README.md | 36 ++++++++++++++++++------------------ 1 file changed, 18 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index 864b7e92..0ef62f6b 100644 --- a/README.md +++ b/README.md @@ -34,24 +34,8 @@ | -p | -p | None | Prune old/unused docker images | | --self-update | --self-update | None | Updates HeavyScript prior to running any other commands | -
-
-## 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 +### 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 @@ -75,6 +59,22 @@ bash heavy_script.sh --self-update -b 10 -i portainer -i arch -i sonarr -i radar > `--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 ``` @@ -177,7 +177,7 @@ bash heavyscript.sh --self-update -b 10 -supr | 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 -rsup` | 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 -rsup` | +| `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. |