Use ghcr where possible (#18274)

2025-07-23 17:27:19 +00:00 · 2021-06-22 17:26:39 +02:00 · 2021-06-22 17:26:39 +02:00 · 6699c0d49f
commit 6699c0d49f
parent 6b3e7ef36b
11 changed files with 24 additions and 20 deletions
--- a/_config.yml
+++ b/_config.yml
@ -175,6 +175,10 @@ toc:

 # Configuration for installation pages
 installation:
+  container:
+    base: "ghcr.io/home-assistant/home-assistant"
+    raspberrypi3: "ghcr.io/home-assistant/raspberrypi3-homeassistant"
+    raspberrypi4: "ghcr.io/home-assistant/raspberrypi4-homeassistant"
  versions:
    python: "3.8"
  types:
--- a/source/_includes/common-tasks/beta_version.md
+++ b/source/_includes/common-tasks/beta_version.md
@ -41,7 +41,7 @@ If you would like to test next release before anyone else, you can install the b
 {% elsif page.installation == "container" %}

 ```bash
-docker pull homeassistant/home-assistant:beta
+docker pull {{ site.installation.container.base }}:beta
 ```

 **[You then need to recreate the container with the new image.](/installation/linux#install-home-assistant-container)**
--- a/source/_includes/common-tasks/development_version.md
+++ b/source/_includes/common-tasks/development_version.md
@ -31,7 +31,7 @@ If you want to stay on the bleeding-edge Home Assistant Core development branch,
 {% elsif page.installation == "container" %}

 ```bash
-docker pull homeassistant/home-assistant:dev
+docker pull {{ site.installation.container.base }}:dev
 ```

 **[You then need to recreate the container with the new image.](/installation/linux#install-home-assistant-container)**
--- a/source/_includes/common-tasks/specific_version.md
+++ b/source/_includes/common-tasks/specific_version.md
@ -13,7 +13,7 @@ ha core update --version {{current_version}}
 {% elsif page.installation == "container" %}

 ```bash
-docker pull homeassistant/home-assistant:{{current_version}}
+docker pull {{ site.installation.container.base }}:{{current_version}}
 ```

 **[You then need to recreate the container with the new image.](/installation/linux#install-home-assistant-container)**
--- a/source/_includes/common-tasks/update.md
+++ b/source/_includes/common-tasks/update.md
@ -44,13 +44,13 @@ To update Home Assistant Core when you run Home Assistant {{ page.installation_n
    **First start with pulling the new container.**

    ```bash
-    docker pull homeassistant/home-assistant:stable
+    docker pull {{ site.installation.container.base }}:stable
    ```

    You can also use specific containers for your hardware. Like Raspberry Pi 4:

    ```bash
-    docker pull homeassistant/raspberrypi4-homeassistant:stable
+    docker pull {{ site.installation.container.raspberrypi4 }}:stable
    ```

    **[You then need to recreate the container with the new image.](/installation/linux#install-home-assistant-container)**
--- a/source/_includes/installation/container.md
+++ b/source/_includes/installation/container.md
@ -17,17 +17,17 @@ Installation with Docker is straightforward. Adjust the following command so tha
 {% if page.installation_type == 'raspberrypi' %}
 #### Raspberry pi 3

-  {% include installation/container/cli.md image="homeassistant/raspberrypi3-homeassistant:stable" %}
+  {% include installation/container/cli.md image=site.installation.container.raspberrypi3 %}

 #### Raspberry pi 4

-  {% include installation/container/cli.md image="homeassistant/raspberrypi4-homeassistant:stable" %}
+  {% include installation/container/cli.md image=site.installation.container.raspberrypi4 %}

 {% elsif page.installation_type == 'alternative' %}
  {% include installation/container/alternative.md %}

 {% else %}
-  {% include installation/container/cli.md image="homeassistant/home-assistant:stable" %}
+  {% include installation/container/cli.md %}
 {% endif %}

 Once the Home Assistant Container is running Home Assistant should be accessible using `http://<host>:8123` (replace <host> with the hostname or IP of the system). You can continue with onboarding.
@ -67,13 +67,13 @@ As the Docker command becomes more complex, switching to `docker-compose` can be
 {% if page.installation_type == 'raspberrypi' %}
 #### Raspberry pi 3

-  {% include installation/container/compose.md image="homeassistant/raspberrypi3-homeassistant:stable" %}
+  {% include installation/container/compose.md image=site.installation.container.raspberrypi3 %}

 #### Raspberry pi 4

-  {% include installation/container/compose.md image="homeassistant/raspberrypi4-homeassistant:stable" %}
+  {% include installation/container/compose.md image=site.installation.container.raspberrypi4 %}
 {% else %}
-  {% include installation/container/compose.md image="homeassistant/home-assistant:stable" %}
+  {% include installation/container/compose.md %}
 {% endif %}

 Start it by running:
--- a/source/_includes/installation/container/alternative.md
+++ b/source/_includes/installation/container/alternative.md
@ -42,7 +42,7 @@ Adjust the following Terminal command as follows :
 Run it in Terminal.  

 ```bash
-sudo docker run --restart always -d --name homeassistant -v /PATH_TO_YOUR_CONFIG:/config --device=/PATH_TO_YOUR_USB_STICK -e TZ=Australia/Melbourne --net=host homeassistant/home-assistant:stable
+sudo docker run --restart always -d --name homeassistant -v /PATH_TO_YOUR_CONFIG:/config --device=/PATH_TO_YOUR_USB_STICK -e TZ=Australia/Melbourne --net=host {{ site.installation.container.base }}:stable
 ```

 Complete the remainder of the Z-Wave configuration by [following the instructions here.](/docs/z-wave/installation)
@ -104,7 +104,7 @@ If you want to use a USB Bluetooth adapter or Z-Wave USB stick with Home Assista
 - Run Docker command:

  ```bash
-  docker run --init --name homeassistant --net=host --privileged -itd -v /share/CACHEDEV1_DATA/Public/homeassistant/config:/config -e TZ=Europe/London --device /dev/ttyACM0 homeassistant/home-assistant:stable
+  docker run --init --name homeassistant --net=host --privileged -itd -v /share/CACHEDEV1_DATA/Public/homeassistant/config:/config -e TZ=Europe/London --device /dev/ttyACM0 {{ site.installation.container.base }}:stable
  ```
  
  `-v` is your configuration path
@ -125,7 +125,7 @@ That will tell Home Assistant where to look for our Z-Wave radio.
 - Run Docker command:

  ```bash
-  docker run --init --name homeassistant --net=host --privileged -itd -v /share/CACHEDEV1_DATA/Public/homeassistant/config:/config -e TZ=Europe/London -v /dev/bus/usb:/dev/bus/usb -v /var/run/dbus:/var/run/dbus homeassistant/home-assistant:stable
+  docker run --init --name homeassistant --net=host --privileged -itd -v /share/CACHEDEV1_DATA/Public/homeassistant/config:/config -e TZ=Europe/London -v /dev/bus/usb:/dev/bus/usb -v /var/run/dbus:/var/run/dbus {{ site.installation.container.base }}:stable
  ```
  
  First `-v` is your configuration path
--- a/source/_includes/installation/container/cli.md
+++ b/source/_includes/installation/container/cli.md
@ -10,7 +10,7 @@
      -v /etc/localtime:/etc/localtime:ro \
      -v /PATH_TO_YOUR_CONFIG:/config \
      --network=host \
-      {{ include.image }}
+      {{ include.image | default: site.installation.container.base }}:{{ include.tag | default: 'stable' }}
    ```

 - title: Update
@ -39,7 +39,7 @@
      -v /PATH_TO_YOUR_CONFIG:/config \
      -v /etc/localtime:/etc/localtime:ro \
      --network=host \
-      {{ include.image }}
+      {{ include.image | default: site.installation.container.base }}:{{ include.tag | default: 'stable' }}
    ```

 {% endtabbed_block %}
--- a/source/_includes/installation/container/compose.md
+++ b/source/_includes/installation/container/compose.md
@ -3,7 +3,7 @@
  services:
    homeassistant:
      container_name: homeassistant
-      image: {{ include.image }}
+      image: "{{ include.image | default: site.installation.container.base }}:{{ include.tag | default: 'stable' }}"
      volumes:
        - /PATH_TO_YOUR_CONFIG:/config
        - /etc/localtime:/etc/localtime:ro
--- a/source/_integrations/dsmr.markdown
+++ b/source/_integrations/dsmr.markdown
@ -136,7 +136,7 @@ or
 Docker users have to allow Docker access to the device by adding `--device /dev/ttyUSB21:/dev/ttyUSB21` to the run command:

 ```hass
-$ docker run --device /dev/ttyUSB0:/dev/ttyUSB0 -d --name="home-assistant" -v /home/USERNAME/hass:/config -v /etc/localtime:/etc/localtime:ro --net=host homeassistant/home-assistant
+$ docker run --device /dev/ttyUSB0:/dev/ttyUSB0 -d --name="home-assistant" -v /home/USERNAME/hass:/config -v /etc/localtime:/etc/localtime:ro --net=host {{ site.installation.container.base }}
 ```

 ### Options
--- a/source/more-info/local-media/setup-media.markdown
+++ b/source/more-info/local-media/setup-media.markdown
@ -26,7 +26,7 @@ docker run -d --name="home-assistant" \
  -v /PATH_TO_YOUR_CONFIG:/config \
  -v /etc/localtime:/etc/localtime:ro \
  --net=host \
-  homeassistant/home-assistant:stable
+  {{ site.installation.container.base }}:stable
 ```

 You'll need to change it to this:
@ -37,7 +37,7 @@ docker run -d --name="home-assistant" \
  -v /PATH_TO_YOUR_MEDIA:/media \
  -v /etc/localtime:/etc/localtime:ro \
  --net=host \
-  homeassistant/home-assistant:stable
+  {{ site.installation.container.base }}:stable
 ```

 If you are using Docker compose, you can add a volume to your composition file