Extras: Heimdall - dibrz/ARMBand GitHub Wiki

  1. Intro
  2. URL
  3. Initial Setup
    1. Domain
    2. Install
    3. Login
  4. Customizing
    1. Adding Items
    2. Organizing
    3. Tags
    4. Settings
  5. Supported Applications

1. Intro

Heimdall is a dashboard for all your web applications and any other links you like to add. It can be set as your browser's start page, with the ability to include a search bar using either Google, Bing, or DuckDuckGo.

alt text

2. URL

To access Heimdall, visit https://heimdall.yourdomain.com

3. Initial Setup

i. Domain

See Adding a Subdomain on how to add the subdomain heimdall to your DNS provider.

Note: You can skip this step if you are using Cloudflare with Cloudbox.

ii. Install

Run the following commands:

cd ~/cloudbox/
sudo ansible-playbook cloudbox.yml --tags heimdall

iii. Login

Login settings are preset out of the box (user / passwd as set in settings.yml).

4. Customizing

You are not limited to just the applications on your server with Heimdall. You can use it for anything, including all your bookmarks and your favorite search engine.

i. Adding Items

  1. You can add items to Heimdall by clicking the items tab follow by the add button.

  2. Many of the applications that you may use have logos and hex colors filled in. You are able to change these if needed, however, not all of your applications will have these and you will have to do it manually.

  3. In the picture above, you will see a spot to login at the bottom. This is not used for every application as some will require just an API key. This allows you to have a quick glance at the service, pictured below.

ii. Organizing

  1. Clicking this switch allows you reorganize your tabs. This is very helpful after adding a whole bunch, in no certain order.

  2. You now be able to drag and drop. You will also see a pin tab, which will disappear when you exit out.

  3. This allows you to add and remove items very fast, while saving them for later.

  4. If for any reason your tabs are not showing current information you can refresh with the refresh button.

iii. Tags

Have a lot of stuff? Want to organize each service? The tags work much like a folder, where you can place items inside. You can even stack them on top of each other.

  1. Just add a tag like you would a normal application. Then you can assign applications to the tag when setting up or editing them.

  2. The tag is seen with a tag symbol on the right.

iv. Settings

In the settings menu you can find the options to update, change the background, and even add a search engine to it.

5. Supported Applications

You can add your own applications to Heimdall, but below are the predefined ones. There are two different types. Foundation apps are your basic applications without any api access. Enhanced apps can have additional information to provide a quick glance at them.

Enhanced

  • Couchpotato
  • Tautulli
  • Pihole
  • Sabnzbd
  • NZBGet
  • RuneAudio

Foundation

  • Watcher
  • OpenMediaVault
  • Krusader
  • Airsonic
  • Glances
  • Dokuwiki
  • SickRage
  • Gitea
  • Ombi
  • TT-RSS
  • Graylog
  • NZBHydra
  • NZBHydra2
  • Medusa
  • Deluge
  • rTorrent/ruTorrent
  • OPNSense
  • Netdata
  • Lidarr
  • Sonarr
  • Radarr
  • pFsense
  • UniFI
  • Portainer
  • Plex
  • Emby
  • Duplicati
  • JDownloader
  • openHAB
  • McMyAdmin
  • Plexrequests
  • Traefik
  • Nextcloud

This guide and the Ansible role were initially submitted by Captain-NaCl.