Skip to content

Latest commit

 

History

History
183 lines (127 loc) · 7.9 KB

README.md

File metadata and controls

183 lines (127 loc) · 7.9 KB

HeavyScript

Website

HeavySetup - Further Explanation

Table of contents:


The Menu

image

Access this with heavyscript



Arguments

Update Specific

Flag Example Parameter Description
-U -U
-U 5		 Optional 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		 Optional 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
-S -S Shutdown the application prior to updating it
-i -i nextcloud -i sonarr String Exclude an application from updates
List one application after another as shown in the example
-r -r Monitors applications after they update
If the app does not become "ACTIVE" after the timeout, rollback the application.
-t -t 400 Integer Time in seconds that HeavyScript will wait for an application to no longer be deploying before declaring failure
Default: 500
--ignore-img --ignore-img Ignore container image updates

General

These options can be used in conjunction with the update options above

Alternatively, use these options individually or combined with other arguments

Flag Example Parameter Description
-b -b 14 Integer Backup your ix-applications dataset prior to updating, up to the number specified
-s -s Synchronize catalog information
-p -p Remove unused or old Docker images
--self-update --self-update Update HeavyScript prior to executing other commands

Utilities

All of these can ALSO be accessed with the HeavyScript menu, that you can access simply by not providing an argument heavyscript

Flag Description
--mount Initiates mounting feature, choose between unmounting and mounting PVC data
--restore Opens a menu to restore a HeavyScript backup that was taken on your ix-applications dataset
--delete-backup Opens a menu to delete backups on your system
--dns List all of your applications DNS names and their web ports
--cmd Open a shell for one of your applications
--logs Open logs for one of your applications
--start-app Opens menu to Start one of your applications
--stop-app Opens menu to Stop one of your applications
--restart-app Opens menu to Restart one of your applications
--delete-app Opens menu to Delete one of your applications

Miscellaneous

Flag Example Description
-h -h Displays help message
-v -v Display detailed output


How to Install

One Line Install

curl -s https://raw.githubusercontent.com/Heavybullets8/heavy_script/main/functions/deploy.sh | bash && source "$HOME/.bashrc" 2>/dev/null && source "$HOME/.zshrc" 2>/dev/null

This will:

  • Download HeavyScript, then place you on the latest release
  • Place HeavyScript in /root
  • Make HeavyScript executable
  • Allow you to run HeavyScript from any directory with heavyscript

This does not include Cron Jobs, see the Cron section for more information.

From here, you can just run HeavyScript with heavyscript -ARGUMENTS



How to Update

heavyscript --self-update -b 10 -supr

--self-update will:

  • Update HeavyScript to the latest release, no matter if you're on a branch or tag
  • Lets you use any other arguments you want


Cron Jobs

How to Create a Cron Job

  1. TrueNAS SCALE GUI
  2. System Settings
  3. Advanced
  4. Cron Jobs
    1. Click Add

image

  • Command: bash /root/heavy_script/heavy_script.sh --self-update -b 10 -rsp -u 10

    The bash, as well as the full path to the script is required for cron jobs to work properly.

  • Run as: root

    Running as root is required for the script to work properly.

  • Schedule: I run mine daily at 4:00 AM
  • Hide Standard Output: Unchecked
  • Hide Standard Error: Unchecked

    Keep these both unchecked so you can recive an email.


My Personal Cron Job

bash /root/heavy_script/heavy_script.sh --self-update -b 10 -rsp -u 10


To-Do List

Current Issues

  • Issue 1: "Command to container" and "Logs" functions do not currently support applications with multiple replicas

Improvements

  • Improvement 1: Refactor the code to split up large functions into smaller, more manageable functions
  • Improvement 2: Move frequently used smaller functions to the "utils" folder and ensure all relevant sections of the script utilize them

If you would like to suggest additional items for these lists, please open an issue.



Additional Information

Verbose vs Non-Verbose

  • Verbose used heavyscript -b 5 -Srupv
  • Non-Verbose used heavyscript -b 5 -Srup
Verbose Non-Verbose
image image