mirror of
https://github.com/linuxserver/docker-heimdall.git
synced 2026-02-19 10:58:24 +09:00
Bot Updating Templated Files
This commit is contained in:
40
README.md
40
README.md
@@ -14,12 +14,6 @@ Find us at:
|
||||
* [Blog](https://blog.linuxserver.io) - all the things you can do with our containers including How-To guides, opinions and much more!
|
||||
* [Podcast](https://anchor.fm/linuxserverio) - on hiatus. Coming back soon (late 2018).
|
||||
|
||||
# PSA: Changes are happening
|
||||
|
||||
From August 2018 onwards, Linuxserver are in the midst of switching to a new CI platform which will enable us to build and release multiple architectures under a single repo. To this end, existing images for `arm64` and `armhf` builds are being deprecated. They are replaced by a manifest file in each container which automatically pulls the correct image for your architecture. You'll also be able to pull based on a specific architecture tag.
|
||||
|
||||
TLDR: Multi-arch support is changing from multiple repos to one repo per container image.
|
||||
|
||||
# [linuxserver/heimdall](https://github.com/linuxserver/docker-heimdall)
|
||||
[](https://discord.gg/YWrKVTn)
|
||||
[](https://microbadger.com/images/linuxserver/heimdall "Get your own version badge on microbadger.com")
|
||||
@@ -37,7 +31,7 @@ Why not use it as your browser start page? It even has the ability to include a
|
||||
|
||||
## Supported Architectures
|
||||
|
||||
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).
|
||||
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/).
|
||||
|
||||
Simply pulling `linuxserver/heimdall` should retrieve the correct image for your arch, but you can also pull specific arch images via tags.
|
||||
|
||||
@@ -59,8 +53,8 @@ Here are some example snippets to help you get started creating a container.
|
||||
```
|
||||
docker create \
|
||||
--name=heimdall \
|
||||
-e PUID=1001 \
|
||||
-e PGID=1001 \
|
||||
-e PUID=1000 \
|
||||
-e PGID=1000 \
|
||||
-e TZ=Europe/London \
|
||||
-p 80:80 \
|
||||
-p 443:443 \
|
||||
@@ -87,15 +81,14 @@ services:
|
||||
image: linuxserver/heimdall
|
||||
container_name: heimdall
|
||||
environment:
|
||||
- PUID=1001
|
||||
- PGID=1001
|
||||
- PUID=1000
|
||||
- PGID=1000
|
||||
- TZ=Europe/London
|
||||
volumes:
|
||||
- </path/to/appdata/config>:/config
|
||||
ports:
|
||||
- 80:80
|
||||
- 443:443
|
||||
mem_limit: 4096m
|
||||
restart: unless-stopped
|
||||
```
|
||||
|
||||
@@ -107,8 +100,8 @@ Container images are configured using parameters passed at runtime (such as thos
|
||||
| :----: | --- |
|
||||
| `-p 80` | http gui |
|
||||
| `-p 443` | https gui |
|
||||
| `-e PUID=1001` | for UserID - see below for explanation |
|
||||
| `-e PGID=1001` | for GroupID - see below for explanation |
|
||||
| `-e PUID=1000` | for UserID - see below for explanation |
|
||||
| `-e PGID=1000` | for GroupID - see below for explanation |
|
||||
| `-e TZ=Europe/London` | Specify a timezone to use EG Europe/London |
|
||||
| `-v /config` | Contains all relevant configuration files. |
|
||||
|
||||
@@ -118,11 +111,11 @@ When using volumes (`-v` flags) permissions issues can arise between the host OS
|
||||
|
||||
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=1001` and `PGID=1001`, to find yours use `id user` as below:
|
||||
In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as below:
|
||||
|
||||
```
|
||||
$ id username
|
||||
uid=1001(dockeruser) gid=1001(dockergroup) groups=1001(dockergroup)
|
||||
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
|
||||
```
|
||||
|
||||
|
||||
@@ -161,9 +154,20 @@ Below are the instructions for updating containers:
|
||||
* Start the new container: `docker start heimdall`
|
||||
* You can also remove the old dangling images: `docker image prune`
|
||||
|
||||
### Via Taisun auto-updater (especially useful if you don't remember the original parameters)
|
||||
* Pull the latest image at its tag and replace it with the same env variables in one shot:
|
||||
```
|
||||
docker run --rm \
|
||||
-v /var/run/docker.sock:/var/run/docker.sock taisun/updater \
|
||||
--oneshot heimdall
|
||||
```
|
||||
* You can also remove the old dangling images: `docker image prune`
|
||||
|
||||
### Via Docker Compose
|
||||
* Update the image: `docker-compose pull linuxserver/heimdall`
|
||||
* Let compose update containers as necessary: `docker-compose up -d`
|
||||
* Update all images: `docker-compose pull`
|
||||
* or update a single image: `docker-compose pull heimdall`
|
||||
* Let compose update all containers as necessary: `docker-compose up -d`
|
||||
* or update a single container: `docker-compose up -d heimdall`
|
||||
* You can also remove the old dangling images: `docker image prune`
|
||||
|
||||
## Versions
|
||||
|
||||
Reference in New Issue
Block a user