Docker .env HOMEPAGE_VAR_XXX template variable substitution not working

[steve-king]

Description

Sorry to post this, I realise this has been a recurring issue and a point of frustration.

I have searched through all previous discussions on this topic and tried everything I can think of, but have not managed to find a solution.

homepage version

v0.8.13 (986a181, May 6, 2024)

Installation method

Docker

Configuration

compose.yaml:

networks:
  homelab:
    name: homelab
    external: true
services:
  homepage:
    container_name: homepage
    image: ghcr.io/gethomepage/homepage:latest
    networks:
      - homelab
    env_file:
      - .env
    environment:
      PUID: $PUID
      PGID: $PGID
    ports:
      - 8080:3000
    volumes:
      - ./config:/app/config 
      - ./images:/app/public/images
    deploy:
      restart_policy:
        condition: unless-stopped
  dockerproxy:
    container_name: dockerproxy
    image: ghcr.io/tecnativa/docker-socket-proxy:latest
    networks:
      - homelab
    environment:
      - CONTAINERS=1 # Allow access to viewing containers
      - SERVICES=1 # Allow access to viewing services (necessary when using Docker Swarm)
      - TASKS=1 # Allow access to viewing tasks (necessary when using Docker Swarm)
      - POST=0 # Disallow any POST operations (effectively read-only)
    ports:
      - 127.0.0.1:2375:2375
    volumes:
      - /var/run/docker.sock:/var/run/docker.sock:ro # Mounted as read-only
    restart: unless-stopped

.env

PUID=1000
PGID=1000

# ---
HOMEPAGE_VAR_EMAIL=XXX
HOMEPAGE_VAR_USERNAME=XXX
HOMEPAGE_VAR_PASSWORD=XXX
HOMEPAGE_VAR_PORTAINER_TOKEN=XXX

services.yaml:

- Services:
    - Nginx:
        href: http://nginxproxy.homelab.lan
        description: Nginx Proxy Manager
        icon: nginx-proxy-manager
        server: homelab
        container: nginxproxy
        statusStyle: "dot"
        widget:
            type: npm
            url: http://nginxproxy:81
            # username: XXX
            # password: XXX
            username: {{ HOMEPAGE_VAR_EMAIL }}
            password: {{ HOMEPAGE_VAR_PASSWORD }}
    - Adguard Home:
        href: http://adguard.homelab.lan
        description: DNS server
        icon: adguard-home
        server: homelab
        container: adguard
        statusStyle: "dot"
        widget:
            type: adguard
            url: http://adguard:3000
            # username: XXX
            # password: XXX
            username: {{ HOMEPAGE_VAR_USERNAME }}
            password: {{ HOMEPAGE_VAR_PASSWORD }}
    - Portainer:
        href: http://portainer.homelab.lan
        description: Container management
        icon: portainer
        server: homelab
        container: portainer
        statusStyle: "dot"
        widget:
            type: portainer
            url: http://portainer:9000
            env: 14
            key: {{ HOMEPAGE_VAR_PORTAINER_TOKEN }}
            # key: XXX

Container Logs

[2024-05-07T11:32:04.901Z] error: <credentialedProxyHandler> HTTP Error 401 calling http://portainer:9000/api/endpoints/14/docker/containers/json?all=1
[2024-05-07T11:32:05.325Z] error: <credentialedProxyHandler> HTTP Error 401 calling http://portainer:9000/api/endpoints/14/docker/containers/json?all=1
[2024-05-07T11:32:09.450Z] error: <credentialedProxyHandler> HTTP Error 401 calling http://portainer:9000/api/endpoints/14/docker/containers/json?all=1

All environment variables are present when running docker exec homepage env:

PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin
HOSTNAME=905adec29027
HOMEPAGE_VAR_USERNAME=XXX
HOMEPAGE_VAR_PASSWORD=XXX
HOMEPAGE_VAR_PORTAINER_TOKEN=XXX
PUID=1000
PGID=1000
HOMEPAGE_VAR_EMAIL=XXX
NODE_VERSION=18.20.2
YARN_VERSION=1.22.19
NODE_ENV=production
PORT=3000
HOME=/root

Browser Logs

index-13ff1c2d6f3e37ec.js:1 
GET http://homelab.lan/api/services/proxy?type=npm&group=Services&service=Nginx&endpoint=nginx%2Fproxy-hosts 400 (Bad Request)
fetcher @ index-13ff1c2d6f3e37ec.js:1
(anonymous) @ _app-b877b7641e51de94.js:1
(anonymous) @ _app-b877b7641e51de94.js:1
(anonymous) @ _app-b877b7641e51de94.js:1
(anonymous) @ _app-b877b7641e51de94.js:1
o @ _app-b877b7641e51de94.js:1
(anonymous) @ _app-b877b7641e51de94.js:1
(anonymous) @ _app-b877b7641e51de94.js:1
A @ _app-b877b7641e51de94.js:1
index-13ff1c2d6f3e37ec.js:1 
GET http://homelab.lan/api/services/proxy?type=adguard&group=Services&service=Adguard+Home&endpoint=stats 403 (Forbidden)
fetcher @ index-13ff1c2d6f3e37ec.js:1
(anonymous) @ _app-b877b7641e51de94.js:1
(anonymous) @ _app-b877b7641e51de94.js:1
(anonymous) @ _app-b877b7641e51de94.js:1
(anonymous) @ _app-b877b7641e51de94.js:1
o @ _app-b877b7641e51de94.js:1
(anonymous) @ _app-b877b7641e51de94.js:1
(anonymous) @ _app-b877b7641e51de94.js:1
A @ _app-b877b7641e51de94.js:1
index-13ff1c2d6f3e37ec.js:1 
GET http://homelab.lan/api/services/proxy?type=portainer&group=Services&service=Portainer&endpoint=docker%2Fcontainers%2Fjson&query=%7B%22all%22%3A1%7D 401 (Unauthorized)

Troubleshooting

When I swap out the {{HOMEPAGE_VAR_XXX}} variables and input strings directly (as per commented lines in services.yaml), everything works correctly.

I have tried:

• completely removing the container
• pulling a fresh image
• Running docker compose up --build --force-recreate

However the problem still occurs.

[glime-ai[bot]]

Thanks for posting a discussion about homepage here on GitHub. Homepage now uses a fancy new AI tool thanks to our friends at Glime, so the answer below is the AI bot's attempt to answer your question. If you feel it's sufficient you can mark the answer and close this post, otherwise feel free to leave it open of course!

Thanks for using Homepage! ❤️

---

Based on the information provided, it seems that the environment variables {{HOMEPAGE_VAR_EMAIL}}, {{HOMEPAGE_VAR_USERNAME}}, {{HOMEPAGE_VAR_PASSWORD}}, and {{HOMEPAGE_VAR_PORTAINER_TOKEN}} are not being correctly parsed or replaced with their actual values when the Homepage application is reading the services.yaml file. This is why you are seeing HTTP error codes such as 401 Unauthorized and 403 Forbidden in your browser logs, and why the services work correctly when you input the credentials directly into the services.yaml file.

To resolve this issue, you should ensure that the environment variables are correctly defined in your Docker environment and that they follow the naming convention required by Homepage. According to the documentation, environment variables must start with HOMEPAGE_VAR_ for direct value replacement or HOMEPAGE_FILE_ if the value is to be read from a file.

Here are the steps you can follow to troubleshoot and fix the issue:

1. Verify that the environment variables HOMEPAGE_VAR_EMAIL, HOMEPAGE_VAR_USERNAME, HOMEPAGE_VAR_PASSWORD, and HOMEPAGE_VAR_PORTAINER_TOKEN are correctly set in your .env file or Docker environment.

2. Ensure that the environment variables are accessible within the container. You can check this by executing a command like printenv within the container to list all environment variables.

3. Review the Homepage documentation on using environment secrets to ensure you are following the correct procedure. The documentation states that the value of the environment variable HOMEPAGE_VAR_XXX will replace {{HOMEPAGE_VAR_XXX}} in any config file.

4. If the issue persists, consider opening a GitHub issue or discussion on the Homepage repository to seek further assistance from the developers.

Please let me know if you need further assistance or if there are any specific error messages or logs that you would like me to look into.

This comment was generated by Glime.

[github-actions[bot]]

This discussion has been automatically closed due to inactivity. See our contributing guidelines for more details.

[github-actions[bot]]

This discussion has been automatically locked since there has not been any recent activity after it was closed. Please open a new discussion for related concerns. See our contributing guidelines for more details.