From 5ef18187f99c46e316f0b7b942bf0fab01aec96d Mon Sep 17 00:00:00 2001 From: LinuxServer-CI Date: Sun, 1 May 2022 02:58:43 -0500 Subject: [PATCH] Bot Updating Templated Files --- README.md | 34 +++++++++++++++++----------------- 1 file changed, 17 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index 9a9ee53..a1c19f3 100644 --- a/README.md +++ b/README.md @@ -48,26 +48,26 @@ 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) and our announcement [here](https://blog.linuxserver.io/2019/02/21/the-lsio-pipeline-project/). +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 `lscr.io/linuxserver/heimdall` should retrieve the correct image for your arch, but you can also pull specific arch images via tags. +Simply pulling `lscr.io/linuxserver/heimdall:js` should retrieve the correct image for your arch, but you can also pull specific arch images via tags. The architectures supported by this image are: -| Architecture | Tag | -| :----: | --- | -| x86-64 | amd64-latest | -| arm64 | arm64v8-latest | -| armhf | arm32v7-latest | +| Architecture | Available | Tag | +| :----: | :----: | ---- | +| x86-64 | ✅ | amd64-\ | +| arm64 | ✅ | arm64v8-\ | +| armhf| ✅ | arm32v7-\ | ## 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. +This image provides various versions that are available via tags. Please read the descriptions carefully and exercise caution when using unstable or development tags. -| Tag | Description | -| :----: | --- | -| latest | Stable Heimdall releases. | -| development | Latest commit from the github master branch. | +| Tag | Available | Description | +| :----: | :----: |--- | +| latest | ✅ | Stable Heimdall releases. | +| development | ✅ | Latest commit from the github master branch. | ## Application Setup @@ -89,7 +89,7 @@ Here are some example snippets to help you get started creating a container. version: "2.1" services: heimdall: - image: lscr.io/linuxserver/heimdall + image: lscr.io/linuxserver/heimdall:js container_name: heimdall environment: - PUID=1000 @@ -113,7 +113,7 @@ docker run -d \ -p 3000:3000 \ -v /path/to/appdata/config:/config \ --restart unless-stopped \ - lscr.io/linuxserver/heimdall + lscr.io/linuxserver/heimdall:js ``` ## Parameters @@ -171,7 +171,7 @@ We publish various [Docker Mods](https://github.com/linuxserver/docker-mods) to * container version number * `docker inspect -f '{{ index .Config.Labels "build_version" }}' heimdall` * image version number - * `docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/heimdall` + * `docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/heimdall:js` ## Updating Info @@ -189,7 +189,7 @@ Below are the instructions for updating containers: ### Via Docker Run -* Update the image: `docker pull lscr.io/linuxserver/heimdall` +* Update the image: `docker pull lscr.io/linuxserver/heimdall:js` * Stop the running container: `docker stop heimdall` * Delete the container: `docker rm heimdall` * Recreate a new container with the same docker run parameters as instructed above (if mapped correctly to a host folder, your `/config` folder and settings will be preserved) @@ -224,7 +224,7 @@ cd docker-heimdall docker build \ --no-cache \ --pull \ - -t lscr.io/linuxserver/heimdall:latest . + -t lscr.io/linuxserver/heimdall:js . ``` The ARM variants can be built on x86_64 hardware using `multiarch/qemu-user-static`