helium-helper/README.md

# Helium Bowser installer & updater
## Purpose
This script was initially designed to just update my Helium browser but over time and interest it got more functional and universal. It includes functions to install, update, remove, add launcher, etc... It's supposed to run in user space and is (Linux) distro independent I suppose.

With "little" tinkering it should be possible to apply this script to install, update & configure many kinds of releases from source, like Debian packages, AppImages, binaries, etc...
## Usage
### Help
```sh
./helium_helper.sh -h
```
---
### First Install
To initally install Helium browser via this script, download `helium_helper.sh` and make it executable:
```sh
wget https://lab.c95.org/fr4nz/helium-helper/raw/branch/main/helium_helper.sh && chmod +x helium_helper.sh
```
Run script with install parameter _-i_
- Default install directory = `$HOME/.apps/Helium`
```sh
./helium_helper.sh -i
```

**OPTIONAL** :  Add alias to `.shellrc` | _working in zsh, bash & fish_
- Default alias = `update-helium`
```sh
./helium_helper.sh -a
```

---
### Updating
**From launcher** (if added during install or by running `./helium_helper.sh -l`)

Checking for the latest version and updating can simply be done for the browser as well as the script by right clicking the app icon and choosing either update option, which will be run by `helium_launcher_update.sh`. This will backup all files and configuration and write a log.

**Terminal**

Updating can also be done by running:
- Update Helium Browser
```sh
./helium_helper.sh -u
```
- Update Helium Helper
```sh
./helium_helper.sh -S
```
---
### Backing up
Backing up, by default, pulls all important files, folders & configuration and compresses an archive, which is stored in `$HOME/.apps/Helium/assets`
- Default backup
```sh
./helium_helper.sh -b
```
- Backup to custom path
```sh
./helium_helper.sh -b </PATH/TO/DESTINATION>
```
**NOTE:** The backup path specified won't be overridden within the script yet. Working on it...

**Since this script is interactive, it doesn't keep logs.**
## Overview
### Helium_Helper.sh
- Interactive installer, updater & configuration script
- Installs to `$HOME/.apps/Helium`  |  changeable in line 32 `INSTALL_PATH` 
- Assumes: 
    - Presence of `$HOME/.apps/Helium` when updating  |  changeable in line 32 `INSTALL_PATH`
    - Executable named `Helium.AppImage`
- Keeps backup archives from
    - `Helium.AppImage`
    - `helium_helper.sh`
    - `helium_launcher_update.sh`
    - `Helium.desktop`
    - `net.imput.helium`
- Adds desktop launcher to `$HOME/.local/share/applications`
- Adds options to launcher which are run by `helium_launcher_updater.sh`
    - Update Helium
    - Update Script
    - View Log
- Run `helium_helper.sh -h` for help
---
### Helium_Launcher_Update.sh
- Update Helium from launcher
- Assumes: 
    - Presence of `$HOME/.apps/Helium` when updating  |  changeable in line 21 `INSTALL_PATH`
    - Executable named `Helium.AppImage`
- Loggs to `$HOME/.apps/Helium/assets/logs`
- Keeps backup archives from
    - `Helium.AppImage`
    - `helium_helper.sh`
    - `helium_launcher_update.sh`
    - `Helium.desktop`
    - `net.imput.helium`
- Run `helium_launcher_update.sh -h` for help
&nbsp;