|
| 1 | +[linuxserverurl]: https://linuxserver.io |
| 2 | +[forumurl]: https://forum.linuxserver.io |
| 3 | +[ircurl]: https://www.linuxserver.io/irc/ |
| 4 | +[podcasturl]: https://www.linuxserver.io/podcast/ |
| 5 | +[appurl]: https://github.com/linuxserver/Heimdall |
| 6 | +[hub]: https://hub.docker.com/r/linuxserver/heimdall/ |
| 7 | + |
| 8 | +[][linuxserverurl] |
| 9 | + |
| 10 | +The [LinuxServer.io][linuxserverurl] team brings you another container release featuring easy user mapping and community support. Find us for support at: |
| 11 | +* [forum.linuxserver.io][forumurl] |
| 12 | +* [IRC][ircurl] on freenode at `#linuxserver.io` |
| 13 | +* [Podcast][podcasturl] covers everything to do with getting the most from your Linux Server plus a focus on all things Docker and containerisation! |
| 14 | + |
| 15 | +# linuxserver/heimdall |
| 16 | +[](https://microbadger.com/images/linuxserver/heimdall "Get your own version badge on microbadger.com")[](https://microbadger.com/images/linuxserver/heimdall "Get your own image badge on microbadger.com")[][hub][][hub][](https://ci.linuxserver.io/job/Docker-Builders/job/x86-64/job/x86-64-heimdall/) |
| 17 | + |
| 18 | +Heimdall is a way to organise all those links to your most used web sites and web applications in a simple way. |
| 19 | + |
| 20 | +Simplicity is the key to Heimdall. |
| 21 | + |
| 22 | +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. |
| 23 | + |
| 24 | +[][appurl] |
| 25 | + |
| 26 | +## Usage |
| 27 | + |
| 28 | +``` |
| 29 | +docker create \ |
| 30 | +--name=heimdall \ |
| 31 | +-v <path to data>:/config \ |
| 32 | +-e PGID=<gid> -e PUID=<uid> \ |
| 33 | +-p 80:80 -p 443:443 \ |
| 34 | +-e TZ=<timezone> \ |
| 35 | +linuxserver/heimdall |
| 36 | +``` |
| 37 | + |
| 38 | +## Parameters |
| 39 | + |
| 40 | +`The parameters are split into two halves, separated by a colon, the left hand side representing the host and the right the container side. |
| 41 | +For example with a port -p external:internal - what this shows is the port mapping from internal to external of the container. |
| 42 | +So -p 8080:80 would expose port 80 from inside the container to be accessible from the host's IP on port 8080 |
| 43 | +http://192.168.x.x:8080 would show you what's running INSIDE the container on port 80.` |
| 44 | + |
| 45 | + |
| 46 | +* `-p 80` - The web-services. |
| 47 | +* `-p 443` - The SSL-Based Webservice |
| 48 | +* `-v /config` - Contains your www content and all relevant configuration files. |
| 49 | +* `-e PGID` for GroupID - see below for explanation |
| 50 | +* `-e PUID` for UserID - see below for explanation |
| 51 | +* `-e TZ` - timezone ie. `America/New_York` |
| 52 | + |
| 53 | +It is based on alpine linux with s6 overlay, for shell access whilst the container is running do `docker exec -it heimdall /bin/bash`. |
| 54 | + |
| 55 | +### User / Group Identifiers |
| 56 | + |
| 57 | +Sometimes when using data volumes (`-v` flags) permissions issues can arise between the host OS and the container. We avoid this issue by allowing you to specify the user `PUID` and group `PGID`. Ensure the data volume directory on the host is owned by the same user you specify and it will "just work" ™. |
| 58 | + |
| 59 | +In this instance `PUID=1001` and `PGID=1001`. To find yours use `id user` as below: |
| 60 | + |
| 61 | +``` |
| 62 | + $ id <dockeruser> |
| 63 | + uid=1001(dockeruser) gid=1001(dockergroup) groups=1001(dockergroup) |
| 64 | +``` |
| 65 | + |
| 66 | +## Setting up the application |
| 67 | + |
| 68 | +Access the web gui at http://SERVERIP:PORT |
| 69 | + |
| 70 | +## Adding password protection |
| 71 | + |
| 72 | +This image now supports password protection through htpasswd. Run the following command on your host to generate the htpasswd file `docker exec -it heimdall htpasswd -c /config/nginx/.htpasswd <username>`. Replace <username> with a username of your choice and you will be asked to enter a password. New installs will automatically pick it up and implement password protected access. Existing users updating their image can delete their site config at `/config/nginx/site-confs/default` and restart the container after updating the image. A new site config with htpasswd support will be created in its place. |
| 73 | + |
| 74 | +## Info |
| 75 | + |
| 76 | +* To monitor the logs of the container in realtime `docker logs -f heimdall`. |
| 77 | + |
| 78 | + |
| 79 | +* container version number |
| 80 | + |
| 81 | +`docker inspect -f '{{ index .Config.Labels "build_version" }}' heimdall` |
| 82 | + |
| 83 | +* image version number |
| 84 | + |
| 85 | +`docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/heimdall` |
| 86 | + |
| 87 | +## Versions |
| 88 | + |
| 89 | ++ **06.03.18:** Use password protection if htpasswd is set. Existing users can delete their default site config at /config/nginx/site-confs/default and restart the container, a new default site config with htpasswd support will be created in its place |
| 90 | ++ **12.02.18:** Initial Release. |
0 commit comments