Script to create an iocage jail on TrueNAS and install Uptime-Kuma

This script will work with TrueNAS CORE 13.0

You will need to create

• 1 Dataset named uptimekuma in your pool. e.g. /mnt/mypool/uptimekuma

If this is not present, a directory /uptimekuma will be created in $POOL_PATH. You will want to create the dataset, otherwise a directory will just be created. Datasets make it easy to do snapshots etc...

Download the repository to a convenient directory on your TrueNAS system by changing to that directory and running git clone https://github.com/tschettervictor/truenas-iocage-uptimekuma. Then change into the new truenas-iocage-uptimekuma directory and create a file called uptimekuma-config with your favorite text editor. In its minimal form, it would look like this:

JAIL_IP="192.168.1.199"
DEFAULT_GW_IP="192.168.1.1"
POOL_PATH="/mnt/mypool"

Many of the options are self-explanatory, and all should be adjusted to suit your needs, but only a few are mandatory. The mandatory options are:

• JAIL_IP is the IP address for your jail. You can optionally add the netmask in CIDR notation (e.g., 192.168.1.199/24). If not specified, the netmask defaults to 24 bits. Values of less than 8 bits or more than 30 bits are invalid.
• DEFAULT_GW_IP is the address for your default gateway
• POOL_PATH is the path for your data pool.

In addition, there are some other options which have sensible defaults, but can be adjusted if needed. These are:

• JAIL_NAME: The name of the jail, defaults to "uptimekuma"
• INTERFACE: The network interface to use for the jail. Defaults to vnet0.
• JAIL_INTERFACES: Defaults to vnet0:bridge0, but you can use this option to select a different network bridge if desired. This is an advanced option; you're on your own here.
• VNET: Whether to use the iocage virtual network stack. Defaults to on.

Once you've downloaded the script and prepared the configuration file, run this script (script uptimekuma.log ./uptimekuma-jail.sh). The script will run for maybe a minute. When it finishes, your jail will be created and uptimekuma will be installed.

Reinstall is supported providing the POOL_PATH is properly set, and the data is present.

• The uptimekuma database file is located in /usr/local/uptime-kuma/data