docker-documentation/images/docker-heimdall.md

193 wiersze
10 KiB
Markdown
Czysty Zwykły widok Historia

2020-07-04 04:40:02 +00:00
# [linuxserver/heimdall](https://github.com/linuxserver/docker-heimdall)
[![GitHub Stars](https://img.shields.io/github/stars/linuxserver/docker-heimdall.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&logo=github)](https://github.com/linuxserver/docker-heimdall)
[![GitHub Release](https://img.shields.io/github/release/linuxserver/docker-heimdall.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&logo=github)](https://github.com/linuxserver/docker-heimdall/releases)
[![GitHub Package Repository](https://img.shields.io/static/v1.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=linuxserver.io&message=GitHub%20Package&logo=github)](https://github.com/linuxserver/docker-heimdall/packages)
2020-12-16 17:09:31 +00:00
[![GitLab Container Registry](https://img.shields.io/static/v1.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=linuxserver.io&message=GitLab%20Registry&logo=gitlab)](https://gitlab.com/linuxserver.io/docker-heimdall/container_registry)
2020-07-04 04:40:02 +00:00
[![MicroBadger Layers](https://img.shields.io/microbadger/layers/linuxserver/heimdall.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge)](https://microbadger.com/images/linuxserver/heimdall "Get your own version badge on microbadger.com")
[![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/heimdall.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=pulls&logo=docker)](https://hub.docker.com/r/linuxserver/heimdall)
[![Docker Stars](https://img.shields.io/docker/stars/linuxserver/heimdall.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=stars&logo=docker)](https://hub.docker.com/r/linuxserver/heimdall)
[![Jenkins Build](https://img.shields.io/jenkins/build?labelColor=555555&logoColor=ffffff&style=for-the-badge&jobUrl=https%3A%2F%2Fci.linuxserver.io%2Fjob%2FDocker-Pipeline-Builders%2Fjob%2Fdocker-heimdall%2Fjob%2Fmaster%2F&logo=jenkins)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-heimdall/job/master/)
2020-11-02 14:39:27 +00:00
[![LSIO CI](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=CI&query=CI&url=https%3A%2F%2Fci-tests.linuxserver.io%2Flinuxserver%2Fheimdall%2Flatest%2Fci-status.yml)](https://ci-tests.linuxserver.io/linuxserver/heimdall/latest/index.html)
2020-07-04 04:40:02 +00:00
[Heimdall](https://heimdall.site) is a way to organise all those links to your most used web sites and web applications in a simple way.
Simplicity is the key to Heimdall.
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.
2019-02-09 00:55:08 +00:00
## Supported Architectures
2019-09-06 23:54:59 +00:00
Our images support multiple architectures such as `x86-64`, `arm64` and `armhf`. We utilise the docker manifest for multi-platform awareness. More information is available from docker [here](https://github.com/docker/distribution/blob/master/docs/spec/manifest-v2-2.md#manifest-list) and our announcement [here](https://blog.linuxserver.io/2019/02/21/the-lsio-pipeline-project/).
2019-02-09 00:55:08 +00:00
2020-11-02 14:39:27 +00:00
Simply pulling `ghcr.io/linuxserver/heimdall` should retrieve the correct image for your arch, but you can also pull specific arch images via tags.
2019-02-09 00:55:08 +00:00
The architectures supported by this image are:
| Architecture | Tag |
2020-07-04 04:40:02 +00:00
| :----: | --- |
2019-02-09 00:55:08 +00:00
| x86-64 | amd64-latest |
| arm64 | arm64v8-latest |
2019-03-24 19:40:58 +00:00
| armhf | arm32v7-latest |
2019-02-09 00:55:08 +00:00
2019-05-10 13:44:51 +00:00
## Version Tags
This image provides various versions that are available via tags. `latest` tag usually provides the latest stable version. Others are considered under development and caution must be exercised when using them.
| Tag | Description |
2020-07-04 04:40:02 +00:00
| :----: | --- |
2019-05-10 13:44:51 +00:00
| latest | Stable Heimdall releases. |
| development | Latest commit from the github master branch. |
2019-02-09 00:55:08 +00:00
## Usage
Here are some example snippets to help you get started creating a container from this image.
2020-10-02 23:55:13 +00:00
### docker-compose ([recommended](https://docs.linuxserver.io/general/docker-compose))
2019-02-09 00:55:08 +00:00
Compatible with docker-compose v2 schemas.
```yaml
---
2020-04-10 23:55:20 +00:00
version: "2.1"
2019-02-09 00:55:08 +00:00
services:
heimdall:
2020-11-02 14:39:27 +00:00
image: ghcr.io/linuxserver/heimdall
2019-02-09 00:55:08 +00:00
container_name: heimdall
environment:
2019-03-02 00:54:52 +00:00
- PUID=1000
- PGID=1000
2019-02-09 00:55:08 +00:00
- TZ=Europe/London
volumes:
- </path/to/appdata/config>:/config
ports:
- 80:80
- 443:443
restart: unless-stopped
```
2020-10-02 23:55:13 +00:00
### docker cli
```
docker run -d \
--name=heimdall \
-e PUID=1000 \
-e PGID=1000 \
-e TZ=Europe/London \
-p 80:80 \
-p 443:443 \
-v </path/to/appdata/config>:/config \
--restart unless-stopped \
2020-11-02 14:39:27 +00:00
ghcr.io/linuxserver/heimdall
2020-10-02 23:55:13 +00:00
```
2019-02-09 00:55:08 +00:00
## Parameters
2020-07-04 04:40:02 +00:00
Docker images are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate `<external>:<internal>` respectively. For example, `-p 8080:80` would expose port `80` from inside the container to be accessible from the host's IP on port `8080` outside the container.
2019-02-09 00:55:08 +00:00
2020-07-04 04:40:02 +00:00
### Ports (`-p`)
2019-02-09 00:55:08 +00:00
| Parameter | Function |
2020-07-04 04:40:02 +00:00
| :----: | --- |
2019-02-09 00:55:08 +00:00
| `80` | http gui |
| `443` | https gui |
2020-07-04 04:40:02 +00:00
### Environment Variables (`-e`)
2019-02-09 00:55:08 +00:00
| Env | Function |
2020-07-04 04:40:02 +00:00
| :----: | --- |
2019-03-02 00:54:52 +00:00
| `PUID=1000` | for UserID - see below for explanation |
| `PGID=1000` | for GroupID - see below for explanation |
2019-02-09 00:55:08 +00:00
| `TZ=Europe/London` | Specify a timezone to use EG Europe/London |
2020-07-04 04:40:02 +00:00
### Volume Mappings (`-v`)
2019-02-09 00:55:08 +00:00
| Volume | Function |
2020-07-04 04:40:02 +00:00
| :----: | --- |
2019-02-09 00:55:08 +00:00
| `/config` | Contains all relevant configuration files. |
2020-07-04 04:40:02 +00:00
## Environment variables from files (Docker secrets)
2020-05-29 23:55:01 +00:00
You can set any environment variable from a file by using a special prepend `FILE__`.
As an example:
2020-07-04 04:40:02 +00:00
```
2020-05-29 23:55:01 +00:00
-e FILE__PASSWORD=/run/secrets/mysecretpassword
```
Will set the environment variable `PASSWORD` based on the contents of the `/run/secrets/mysecretpassword` file.
## Umask for running applications
2020-07-04 04:40:02 +00:00
For all of our images we provide the ability to override the default umask settings for services started within the containers using the optional `-e UMASK=022` setting.
Keep in mind umask is not chmod it subtracts from permissions based on it's value it does not add. Please read up [here](https://en.wikipedia.org/wiki/Umask) before asking for support.
2020-05-01 23:54:59 +00:00
2019-02-09 00:55:08 +00:00
## User / Group Identifiers
2020-07-04 04:40:02 +00:00
When using 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`.
2019-02-09 00:55:08 +00:00
Ensure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic.
2019-03-02 00:54:52 +00:00
In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as below:
2019-02-09 00:55:08 +00:00
2020-07-04 04:40:02 +00:00
```
2019-02-09 00:55:08 +00:00
$ id username
2019-03-02 00:54:52 +00:00
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
2019-02-09 00:55:08 +00:00
```
## Application Setup
2020-07-04 04:40:02 +00:00
Access the web gui at http://SERVERIP:PORT
2019-02-09 00:55:08 +00:00
### Adding password protection
2020-07-04 04:40:02 +00:00
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.
2019-10-04 23:54:59 +00:00
2020-04-10 23:55:20 +00:00
## Docker Mods
2020-10-02 23:55:13 +00:00
[![Docker Mods](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=heimdall&query=%24.mods%5B%27heimdall%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml)](https://mods.linuxserver.io/?mod=heimdall "view available mods for this container.") [![Docker Universal Mods](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=universal&query=%24.mods%5B%27universal%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml)](https://mods.linuxserver.io/?mod=universal "view available universal mods.")
2020-04-10 23:55:20 +00:00
2020-10-02 23:55:13 +00:00
We publish various [Docker Mods](https://github.com/linuxserver/docker-mods) to enable additional functionality within the containers. The list of Mods available for this image (if any) as well as universal mods that can be applied to any one of our images can be accessed via the dynamic badges above.
2020-04-10 23:55:20 +00:00
2019-02-09 00:55:08 +00:00
## Support Info
2019-09-06 23:54:59 +00:00
* Shell access whilst the container is running:
2019-02-09 00:55:08 +00:00
* `docker exec -it heimdall /bin/bash`
2019-09-06 23:54:59 +00:00
* To monitor the logs of the container in realtime:
2019-02-09 00:55:08 +00:00
* `docker logs -f heimdall`
2019-09-06 23:54:59 +00:00
* Container version number
2019-02-09 00:55:08 +00:00
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' heimdall`
* Image version number
2020-11-02 14:39:27 +00:00
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' ghcr.io/linuxserver/heimdall`
2019-02-09 00:55:08 +00:00
## Versions
2020-08-17 14:53:37 +00:00
* **17.08.20:** - Add php7-curl.
2020-06-03 14:26:07 +00:00
* **01.06.20:** - Rebasing to alpine 3.12.
2020-01-18 04:35:18 +00:00
* **17.01.20:** - Use nginx from baseimage.
2019-12-20 22:00:39 +00:00
* **19.12.19:** - Rebasing to alpine 3.11.
2019-07-17 21:57:10 +00:00
* **16.07.19:** - Save laravel.log to /config/log/heimdall.
2019-06-30 19:24:14 +00:00
* **28.06.19:** - Rebasing to alpine 3.10.
2019-05-10 13:44:51 +00:00
* **01.04.19:** - Fix permission detect logic.
* **26.03.19:** - Install Heimdall during container start to prevent delayed start due to overlayfs bug with recursive chown.
2019-03-24 19:40:58 +00:00
* **23.03.19:** - Switching to new Base images, shift to arm32v7 tag.
2019-05-10 13:44:51 +00:00
* **15.03.19:** - Clarify docker image tags in readme.
2019-02-24 05:24:05 +00:00
* **22.02.19:** - Rebasing to alpine 3.9.
2019-05-10 13:44:51 +00:00
* **16.01.18:** - Generate random app key in .env for new installs.
* **20.11.18:** - Upgrade baseimage packages during build.
2019-02-09 00:55:08 +00:00
* **04.11.18:** - Add php7-zip.
* **31.10.18:** - Add queue service.
* **17.10.18:** - Symlink avatars folder.
2020-07-04 04:40:02 +00:00
* **16.10.18:** - Updated fastcgi_params for user login support.
2019-02-09 00:55:08 +00:00
* **07.10.18:** - Symlink `.env` rather than copy. It now resides under `/config/www`
* **30.09.18:** - Multi-arch image. Move `.env` to `/config`.
* **05.09.18:** - Rebase to alpine linux 3.8.
* **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
* **12.02.18:** - Initial Release.