Heimdall/readme.md

234 lines
9.4 KiB
Markdown
Raw Normal View History

2018-06-16 12:06:25 +00:00
# Heimdall
[![Heimdall_Banner](https://i.imgur.com/iuV8w3y.png)](https://heimdall.site)
2018-02-09 14:04:18 +00:00
2018-02-17 23:09:21 +00:00
[![Discord](https://img.shields.io/discord/354974912613449730.svg)](https://discord.gg/CCjHKn4)
[![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/heimdall.svg)](https://hub.docker.com/r/linuxserver/heimdall/)
[![firsttimersonly](https://img.shields.io/badge/first--timers--only-friendly-blue.svg)](https://www.firsttimersonly.com/)
2018-02-18 19:04:19 +00:00
[![Paypal](https://heimdall.site/img/paypaldonate.svg)](https://paypal.me/pools/c/81ZR4dfBGo)
2018-02-17 23:09:21 +00:00
___
2018-02-25 20:26:33 +00:00
Visit the website - https://heimdall.site
___
2018-06-09 16:14:05 +00:00
## About
2018-02-12 13:04:01 +00:00
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.
2018-02-06 11:11:25 +00:00
2018-02-12 13:04:01 +00:00
Heimdall is an elegant solution to organise all your web applications. Its dedicated to this purpose so you wont lose your links in a sea of bookmarks.
2018-02-06 11:11:25 +00:00
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.
2018-01-26 14:35:01 +00:00
![Heimdall demo animation](https://i.imgur.com/MrC4QpN.gif)
2018-02-09 14:05:46 +00:00
2018-02-04 18:04:02 +00:00
## Video
2018-02-11 00:50:13 +00:00
If you want to see a quick video of it in use, go to https://youtu.be/GXnnMAxPzMc
2018-02-04 18:04:02 +00:00
2018-02-08 22:51:12 +00:00
## 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.
2018-02-08 22:51:12 +00:00
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.
2018-02-08 22:51:12 +00:00
**Enhanced**
2018-03-12 03:47:31 +00:00
- CouchPotato
2018-06-08 20:39:57 +00:00
- Deluge
2018-02-08 22:51:12 +00:00
- NZBGet
2018-02-12 16:10:47 +00:00
- Pihole
- PlexPy
- Proxmox
- Runeaudio
2018-02-08 22:51:12 +00:00
- Sabnzbd
2018-03-13 20:01:44 +00:00
- Tautulli
2018-06-09 16:14:05 +00:00
- Traefik
2018-03-02 04:41:28 +00:00
- Transmission
2018-02-08 22:51:12 +00:00
2018-02-12 10:02:34 +00:00
**Foundation**
2018-03-17 05:46:12 +00:00
- AirSonic
2018-09-13 07:44:05 +00:00
- Bazarr
2018-10-12 19:59:19 +00:00
- Bitwarden
2018-06-04 23:10:22 +00:00
- Booksonic
2018-07-18 20:17:03 +00:00
- BookStack
2018-03-21 15:24:14 +00:00
- Cardigann
- DokuWiki
2018-02-08 22:51:12 +00:00
- Duplicati
- Emby
2018-07-19 18:54:24 +00:00
- FreshRSS
- Gitea
2018-03-25 04:37:07 +00:00
- Grafana
2018-02-19 19:18:46 +00:00
- Graylog
2018-06-04 23:11:11 +00:00
- Headphones
- Jdownloader
2018-03-13 19:32:54 +00:00
- Krusader
2018-06-04 23:12:02 +00:00
- LibreNMS
2018-02-19 19:18:46 +00:00
- Lidarr
- McMyAdmin
- Medusa
2018-10-12 19:32:34 +00:00
- Monica
2018-06-04 23:12:24 +00:00
- MusicBrainz
2018-06-04 23:13:08 +00:00
- Mylar
- NZBhydra & NZBhydra2
2018-02-19 19:18:46 +00:00
- Netdata
2018-02-09 20:41:50 +00:00
- Nextcloud
2018-02-19 19:18:46 +00:00
- Ombi
- OpenHAB
2018-03-17 06:03:43 +00:00
- OpenMediaVault
2018-02-08 22:51:12 +00:00
- Plex
- Plexrequests
2018-02-08 22:51:12 +00:00
- Portainer
2018-02-19 19:18:46 +00:00
- Radarr
2018-06-04 23:13:30 +00:00
- Rancher
- SickRage
2018-02-19 19:18:46 +00:00
- Sonarr
- TT-RSS
2018-07-18 19:46:27 +00:00
- TVheadend
2018-02-19 19:18:46 +00:00
- UniFI
2018-05-03 20:56:24 +00:00
- unRAID
- pfSense
2018-03-21 15:03:40 +00:00
- pyLoad
2018-06-05 16:17:17 +00:00
- rTorrent/Flood
- rTorrent/ruTorrent
2018-04-04 05:24:07 +00:00
- Syncthing
2018-03-18 13:09:10 +00:00
- Watcher3
2018-03-17 05:17:33 +00:00
- WebTools
2018-02-08 22:51:12 +00:00
2018-02-06 11:19:16 +00:00
## Installing
Apart from the Laravel dependencies, namely PHP >= 7.0.0, OpenSSL PHP Extension, PDO PHP Extension, Mbstring PHP Extension, Tokenizer PHP Extension and XML PHP Extension, the only other thing Heimdall needs is sqlite support.
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`
2018-02-06 11:19:16 +00:00
2018-10-16 17:58:33 +00:00
There is also a multi-arch Docker which supports x86-64, armhf and arm64, instructions on how to use them at
2018-02-12 15:32:19 +00:00
2018-10-16 17:58:33 +00:00
- https://hub.docker.com/r/linuxserver/heimdall/
2018-02-12 13:56:01 +00:00
2018-10-12 10:13:51 +00:00
## 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.
2018-04-06 08:13:30 +00:00
## 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.`
2018-02-07 22:20:18 +00:00
## 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/`.
2018-02-07 22:20:18 +00:00
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.
2018-02-07 22:20:18 +00:00
When you are finished, create a pull request.
2018-02-07 22:20:18 +00:00
Currently added languages are
- English
- German
- Finnish
- French
- Swedish
- Spanish
2018-02-12 12:11:04 +00:00
- Turkish
2018-02-07 22:20:18 +00:00
2018-02-03 16:27:56 +00:00
## 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`.
2018-02-03 16:27:56 +00:00
#### 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:
2018-02-03 16:27:56 +00:00
```
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
2018-02-03 16:27:56 +00:00
### Nginx
If you are using Nginx, the following directive in your site configuration will direct all requests to the `index.php` front controller:
2018-02-03 16:27:56 +00:00
```
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`.
2018-02-04 23:34:51 +00:00
Therefore, if your fonts aren't showing because you have a location for `/web`, add the following
2018-02-04 23:34:51 +00:00
```
2018-02-04 23:35:22 +00:00
location /webfonts {
try_files $uri $uri/;
2018-02-04 23:34:51 +00:00
}
```
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.
2018-02-03 16:27:56 +00:00
2018-02-12 20:22:27 +00:00
### Reverse proxy
2018-06-09 16:14:05 +00:00
If you'd like to reverse proxy this app, we recommend using our letsencrypt/nginx docker image: [Letsencrypt/Nginx](https://hub.docker.com/r/linuxserver/letsencrypt/)
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`
2018-02-12 20:22:27 +00:00
```
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
### 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.
2018-02-15 08:22:14 +00:00
## Support
https://discord.gg/CCjHKn4 or through GitHub issues
2018-02-15 08:22:14 +00:00
2018-02-17 23:09:21 +00:00
## Donate
If you would like to show your appreciation, feel free to use the link below.
2018-02-17 23:15:07 +00:00
[![PayPal](https://heimdall.site/img/paypaldonate.svg)](https://paypal.me/pools/c/81ZR4dfBGo)
2018-02-17 23:09:21 +00:00
2018-02-05 18:13:24 +00:00
## Credits
- PHP Framework - [Laravel](https://laravel.com/)
- Icons - [FontAwesome 5](https://fontawesome.com/)
- JavaScript - [jQuery](https://jquery.com/)
2018-02-05 18:13:24 +00:00
- Colour picker - [Huebee](http://huebee.buzz/)
2018-02-12 22:23:14 +00:00
- Background image - [pexels](https://www.pexels.com)
2018-02-10 23:39:30 +00:00
- Everyone at Linuxserver.io that has helped with the app and let's not forget IronicBadger for the following question that started it all:
2018-02-10 23:36:09 +00:00
```
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 ?
```
2018-02-05 18:13:24 +00:00
2018-01-26 14:35:01 +00:00
## License
2018-01-26 14:42:09 +00:00
This app is open-sourced software licensed under the [MIT license](https://opensource.org/licenses/MIT).