kopia lustrzana https://github.com/linuxserver/docker-documentation
Bot Updating Documentation
LinuxServer-CI
rodzic
9b9e9a7411
commit
782df3697d
|
|
@ -1,8 +1,18 @@
|
|||
# linuxserver/heimdall
|
||||
# [linuxserver/heimdall](https://github.com/linuxserver/docker-heimdall)
|
||||
|
||||
[](https://github.com/linuxserver/docker-heimdall) [](https://github.com/linuxserver/docker-heimdall/releases) [](https://github.com/linuxserver/docker-heimdall/packages) [](https://gitlab.com/Linuxserver.io/docker-heimdall/container_registry) [](https://microbadger.com/images/linuxserver/heimdall) [](https://hub.docker.com/r/linuxserver/heimdall) [](https://hub.docker.com/r/linuxserver/heimdall) [](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-heimdall/job/master/) [](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/heimdall/latest/index.html)
|
||||
[](https://github.com/linuxserver/docker-heimdall)
|
||||
[](https://github.com/linuxserver/docker-heimdall/releases)
|
||||
[](https://github.com/linuxserver/docker-heimdall/packages)
|
||||
[](https://gitlab.com/Linuxserver.io/docker-heimdall/container_registry)
|
||||
[](https://microbadger.com/images/linuxserver/heimdall "Get your own version badge on microbadger.com")
|
||||
[](https://hub.docker.com/r/linuxserver/heimdall)
|
||||
[](https://hub.docker.com/r/linuxserver/heimdall)
|
||||
[](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-heimdall/job/master/)
|
||||
[](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/heimdall/latest/index.html)
|
||||
|
||||
[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.
|
||||
[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.
|
||||
|
||||
## Supported Architectures
|
||||
|
||||
|
|
@ -13,7 +23,7 @@ Simply pulling `linuxserver/heimdall` should retrieve the correct image for your
|
|||
The architectures supported by this image are:
|
||||
|
||||
| Architecture | Tag |
|
||||
| :---: | :--- |
|
||||
| :----: | --- |
|
||||
| x86-64 | amd64-latest |
|
||||
| arm64 | arm64v8-latest |
|
||||
| armhf | arm32v7-latest |
|
||||
|
|
@ -23,7 +33,7 @@ The architectures supported by this image are:
|
|||
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 |
|
||||
| :---: | :--- |
|
||||
| :----: | --- |
|
||||
| latest | Stable Heimdall releases. |
|
||||
| development | Latest commit from the github master branch. |
|
||||
|
||||
|
|
@ -33,7 +43,7 @@ Here are some example snippets to help you get started creating a container from
|
|||
|
||||
### docker
|
||||
|
||||
```text
|
||||
```
|
||||
docker create \
|
||||
--name=heimdall \
|
||||
-e PUID=1000 \
|
||||
|
|
@ -46,6 +56,7 @@ docker create \
|
|||
linuxserver/heimdall
|
||||
```
|
||||
|
||||
|
||||
### docker-compose
|
||||
|
||||
Compatible with docker-compose v2 schemas.
|
||||
|
|
@ -71,36 +82,39 @@ services:
|
|||
|
||||
## Parameters
|
||||
|
||||
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.
|
||||
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.
|
||||
|
||||
### Ports \(`-p`\)
|
||||
### Ports (`-p`)
|
||||
|
||||
| Parameter | Function |
|
||||
| :---: | :--- |
|
||||
| :----: | --- |
|
||||
| `80` | http gui |
|
||||
| `443` | https gui |
|
||||
|
||||
### Environment Variables \(`-e`\)
|
||||
|
||||
### Environment Variables (`-e`)
|
||||
|
||||
| Env | Function |
|
||||
| :---: | :--- |
|
||||
| :----: | --- |
|
||||
| `PUID=1000` | for UserID - see below for explanation |
|
||||
| `PGID=1000` | for GroupID - see below for explanation |
|
||||
| `TZ=Europe/London` | Specify a timezone to use EG Europe/London |
|
||||
|
||||
### Volume Mappings \(`-v`\)
|
||||
### Volume Mappings (`-v`)
|
||||
|
||||
| Volume | Function |
|
||||
| :---: | :--- |
|
||||
| :----: | --- |
|
||||
| `/config` | Contains all relevant configuration files. |
|
||||
|
||||
## Environment variables from files \(Docker secrets\)
|
||||
|
||||
|
||||
## Environment variables from files (Docker secrets)
|
||||
|
||||
You can set any environment variable from a file by using a special prepend `FILE__`.
|
||||
|
||||
As an example:
|
||||
|
||||
```text
|
||||
```
|
||||
-e FILE__PASSWORD=/run/secrets/mysecretpassword
|
||||
```
|
||||
|
||||
|
|
@ -108,34 +122,38 @@ Will set the environment variable `PASSWORD` based on the contents of the `/run/
|
|||
|
||||
## Umask for running applications
|
||||
|
||||
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.
|
||||
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.
|
||||
|
||||
|
||||
## User / Group Identifiers
|
||||
|
||||
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`.
|
||||
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`.
|
||||
|
||||
Ensure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic.
|
||||
|
||||
In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as below:
|
||||
|
||||
```text
|
||||
```
|
||||
$ id username
|
||||
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
|
||||
```
|
||||
|
||||
## Application Setup
|
||||
|
||||
Access the web gui at [http://SERVERIP:PORT](http://SERVERIP:PORT)
|
||||
Access the web gui at http://SERVERIP:PORT
|
||||
|
||||
|
||||
### Adding password protection
|
||||
|
||||
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 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.
|
||||
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.
|
||||
|
||||
|
||||
## Docker Mods
|
||||
[](https://mods.linuxserver.io/?mod=heimdall "view available mods for this container.")
|
||||
|
||||
[](https://mods.linuxserver.io/?mod=heimdall)
|
||||
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) can be accessed via the dynamic badge above.
|
||||
|
||||
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\) can be accessed via the dynamic badge above.
|
||||
|
||||
## Support Info
|
||||
|
||||
|
|
@ -165,10 +183,9 @@ We publish various [Docker Mods](https://github.com/linuxserver/docker-mods) to
|
|||
* **04.11.18:** - Add php7-zip.
|
||||
* **31.10.18:** - Add queue service.
|
||||
* **17.10.18:** - Symlink avatars folder.
|
||||
* **16.10.18:** - Updated fastcgi\_params for user login support.
|
||||
* **16.10.18:** - Updated fastcgi_params for user login support.
|
||||
* **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.
|
||||
|
||||
|
|
|
|||
Ładowanie…
Reference in New Issue