An Application dashboard and launcher
Clone or download
Latest commit ac7446f Nov 14, 2018

readme.md

Heimdall

Heimdall_Banner

Discord Docker Pulls firsttimersonly Paypal


Visit the website - https://heimdall.site


About

As the name suggests Heimdall Application Dashboard is a dashboard for all your web applications. It doesn't need to be limited to applications though, you can add links to anything you like.

Heimdall is an elegant solution to organise all your web applications. It’s dedicated to this purpose so you won’t lose your links in a sea of bookmarks.

Why not use it as your browser start page? It even has the ability to include a search bar using either Google, Bing or DuckDuckGo.

Heimdall demo animation

Video

If you want to see a quick video of it in use, go to https://youtu.be/GXnnMAxPzMc

Supported applications

You can use the app to link to any site or application, but Foundation apps will auto fill in the icon for the app and supply a default color for the tile. In addition Enhanced apps allow you provide details to an apps API, allowing you to view live stats directly on the dashboad. For example, the NZBGet and Sabnzbd Enhanced apps will display the queue size and download speed while something is downloading.

Supported applications are recognized by the title of the application as entered in the title field when adding an application. For example, to add a link to pfSense, begin by typing "p" in the title field and then select "pfSense" from the list of supported applications.

enhancedapps

foundationapps

Installing

Apart from the Laravel dependencies, namely PHP >= 7.1.3, OpenSSL PHP Extension, PDO PHP Extension, Mbstring PHP Extension, Tokenizer PHP Extension, XML PHP Extension, Ctype PHP Extension and JSON PHP Extension, the only other thing Heimdall needs is sqlite support and zip support (php-zip).

If you find you can't change the background make sure php_fileinfo is enabled in your php.ini. I believe it should be by default, but one user came across the issue on a windows system.

Installation is as simple as cloning the repository somewhere, or downloading and extracting the zip/tar and pointing your httpd document root to the /public folder. For simple testing you could just go to the folder and type php artisan serve

There is also a multi-arch Docker which supports x86-64, armhf and arm64, instructions on how to use them at

New background image not being set

If you are using the docker image or a default php install you may find images over 2MB wont get set as the background image, you just need to change the upload_max_filesize in the php.ini.

If you are using the linuxserver.io docker image simply edit /path/to/config/php/php-local.ini and add upload_max_filesize = 30M to the end.

Docker and enhanced apps

If you are running the docker and the EnhancedApps you are using are also in dockers, you may need to use the docker networking addresses to communicate with them.

You can do this by using http(s)://docker_name:port in the config section. Instead of the name you can use the internal docker ip, this usually starts with 172.

Languages

The app has been translated into several languages; however, the quality of the translations could do with work. If you would like to improve them, or help with other translations, they are stored in /resources/lang/.

To create a new language translation, make a new folder with the ISO 3166-1 alpha-2 code as the name, copy app.php from /resources/lang/en/app.php into your new folder and replace the English strings.

When you are finished, create a pull request.

Currently added languages are

  • English
  • German
  • Finnish
  • French
  • Swedish
  • Spanish
  • Turkish

Web Server Configuration

Apache

A .htaccess file ships with the app, however, a lot of apache installations disallow .htaccess files by default. You will notice this due to some links not working like /settings.

Fixes & work around options

- Apache global allow .htaccess

Find the AllowOverride None line in your apache configuration and change this to AllowOverride All

- Apache vhost configuration allow .htaccess

In the apache vhost configuration in the <Directory /> block add AllowOverride All

- Add .htaccess content in apache configuration

You can add the full .htaccess into your apache configuration, this way you do not need to allow .htaccess files. You can even shorten the content of the .htaccess when inserting it into the apache configuration to:

Options +FollowSymLinks
RewriteEngine On

RewriteCond %{REQUEST_FILENAME} !-d
RewriteCond %{REQUEST_FILENAME} !-f
RewriteRule ^ index.php [L]

More info

More info about AllowOverride can be found here: https://httpd.apache.org/docs/2.4/mod/core.html#allowoverride

Nginx

If you are using Nginx, the following directive in your site configuration will direct all requests to the index.php front controller:

location / {
    try_files $uri $uri/ /index.php?$query_string;
}

Someone was using the same nginx setup to both run this and reverse proxy Plex, Plex is served from /web so their location was interfering with the /webfonts.

Therefore, if your fonts aren't showing because you have a location for /web, add the following

location /webfonts {
    try_files $uri $uri/;
}

If there are any other locations which might interfere with any of the folders in the /public folder, you might have to do the same for those as well, but it's a super fringe case.

Reverse proxy

If you'd like to reverse proxy this app, we recommend using our letsencrypt/nginx docker image: Letsencrypt/Nginx You can either reverse proxy from the root location, or from a subdomain (subfolder method is currently not supported). For HTTPS proxy, make sure you use the HTTPS port of Heimdall webserver, otherwise some links may break. You can add security through .htpasswd

location / {
    auth_basic "Restricted";
    auth_basic_user_file /config/nginx/.htpasswd;
    include /config/nginx/proxy.conf;
    proxy_pass https://heimdall:443;
}

If you are using HTTPS and things aren't working try adding FORCE_HTTPS=true to the end of your .env file or proxy to the https version of the app.

Self-signed certificates and local CAs

Per default Heimdall uses the standard certificate bundle file (ca-certificates.crt) to verify HTTPS sites and will ignore additional certificates placed in /etc/ssl/certs. If you wish to use enhanced apps with HTTPS sites that use a self-signed certificate or certs signed with your own local CA, you can override the default bundle:

  • Create a unified certificate .pem file that contains all CAs and certificates that Heimdall has to verify. For example, if you use both LetsEncrypt and a local CA for your internal apps, concatenate the LetsEncrypt intermediate CA (export via browser) and your local CA cert.pem (or any number of self-signed certs) into one heimdall.pem file.
  • Place the heimdall.pem into the container (if you use Docker), for example by placing it in the path that you mapped to /config. Make sure that the Heimdall user has read access (chmod a+r).
  • Set the openssl.cafile setting in /config/php/php-local.ini to your cert bundle:
# /config/php/php-local.ini
openssl.cafile = /config/heimdall.pem

Restart the container and the enhanced apps should now be able to access your local HTTP websites. This configuration will survive updating or recreating the Heimdall container.

Support

https://discord.gg/CCjHKn4 or through GitHub issues

Donate

If you would like to show your appreciation, feel free to use the link below.

PayPal

Credits

  • PHP Framework - Laravel
  • Icons - FontAwesome 5
  • JavaScript - jQuery
  • Colour picker - Huebee
  • Background image - pexels
  • Everyone at Linuxserver.io that has helped with the app and let's not forget IronicBadger for the following question that started it all:
you know, i would love something like this landing page for all my servers apps
that gives me the ability to pin favourites
and / or search
@Stark @Kode do either of you think you'd be able to rustle something like this up ?

License

This app is open-sourced software licensed under the MIT license.