WebUI Console

HomeVault provides a WebUI console that you can use to perform administrative functions on your server, such as:

Adding, removing or configuring application modules
Initializing, configuring and managing the backup system.

You can access the WebUI console for HomeVault from any computer on the same local network as the server. After setting up Tailscale and Traefik (both are set up as part of the Base Module) you will also be able to access the WebUI console through your server's Tailscale IP as well as using your custom domain, such as https://vault.yourdomain.com

All operations available via the WebUI console can also be performed using HomeVault's setup script.

Initial Setup

Before you can access the WebUI console, is a one-time installation requirement. This section will guide you through the steps needed to perform this installation.

Step 1: Open a Terminal on the Server

If your server has a keyboard and monitor attached, you can perform log in and skip to step 2.

If your server is headless (no keyboard or monitor), you will need to open a remote Terminal. I recommend using a program called Termius. You may use any other SSH client if you prefer.

Using Termius:

From the Hosts tab, click on the New Host button at the top.
Under Address, enter the IP address of your server
Give the connection a friendly name under Label
Enter your Username and Password under Credentials
Click Connect

Step 2: Setup your Workspace

From a Terminal on the server where you want to install the WebUI console, you will create a workspace and download HomeVault's setup script, using the following commands:

mkdir -p ~/homevault/workspace
cd ~/homevault/workspace
curl -fsSL https://github.com/thedebuggedlife/homevault-deployment/releases/latest/download/setup.zip | busybox unzip -n -
chmod +x hv

Step 3: Install the WebUI Console

While still in the Terminal, from your workspace folder (i.e. ~/homevault/workspace) you will install the WebUI console using the following command:

./hv webui install

This command will take a couple minutes to complete. As part of this process, a few dependencies of the WebUI console may need to be installed on your server.

Optional: Bookmark the WebUI Console Address

Once the installation of the WebUI console completes, the address that you can use to access it will be displayed in the Terminal. For example:

Terminal output after installing the WebUI console

If you are using Termius, you can use CMD + Click (in Mac) or CTRL + Click (in Windows) to open the WebUI console using your default browser.

Once you've opened the WebUI console, I recommend adding a bookmark, so you don't have to remember the IP address of you server on the local network.

Logging In

When you first open the WebUI console on your browser, you will see the Log In page. You will need to enter the username and password of an account with administrator privileges on the server.

[!info] You may log into the WebUI console using any administrator account. However, because the WebUI console runs with the identity of the user that performed the installation, you will be asked for that user's password when performing administrative operations.

After logging into the WebUI console, the first page you'll see is a Dashboard showing you a high level status of your HomeVault server:

Application Modules

Select the Modules section on the navigation panel to view a list of application modules that are available on your HomeVault server. You can expand any module to see the status of all Docker containers that are associated with that specific module:

Adding or Removing Modules

You can install additional application modules, or remove existing ones, using the Add Modules and Remove Modules buttons at the top of the screen.

Deployment

After selecting the modules you would like to add (or remove), you will be taken to the Deployment Configuration section, where you will be able to configure the modules being installed. Some configuration options may be pre-populated with recommended defaults.

When you click on Continue you will be taken to the Review Configuration step, which will show an overview of the configuration values that were provided.

When ready, click on Begin Deployment. While deployment is in progress, you will see the output of the installer in real time. In most deployments, you will be required to provide the password for the account that was used to install the WebUI console:

Backups

The WebUI console also provides sections to configure and manage backups of your HomeVault server.

Repository

Select the Repository section under Backups in the navigation panel to view and/or configure the location where the snapshots should be stored.

HomeVault uses restic to perform backups of application and user data in your server. You can check out more information on how to configure a repository in restic's online documentation.

Snapshots

In the Snapshots section, you will be able to see a list of snapshots that have been created, whether manually or via scheduled backups. From this section you can start a manual backup operation as well, using the button at the top of the page.

You can delete any given snapshot by clicking on the trash icon at the end of their row.

Scheduling

In the Scheduling section, you can configure automatic backups that will run at any specified interval. You can also configure a retention policy that will be used to automatically delete older snapshots. Adjusting the retention policy configuration can help reduce the total amount of storage used in your repository, which is especially useful if using a cloud provider such as S3 or Backblaze.