thespad/apcupsd_exporter

apcupsd_exporter provides a Prometheus exporter for the apcupsd Network Information Server (NIS).

Supported Architectures

Our images support multiple architectures and simply pulling ghcr.io/thespad/apcupsd_exporter:latest should retrieve the correct image for your arch.

The architectures supported by this image are:

Architecture	Available	Tag
amd64	✅	latest
arm64	✅	latest

Application Setup

Metrics are exposed at /metrics.

See apcupsd_exporter for more information

Usage

Here are some example snippets to help you get started creating a container.

docker-compose (recommended)

Compatible with docker-compose v2 schemas.

---
services:
  apcupsd_exporter:
    image: ghcr.io/thespad/apcupsd_exporter
    container_name: apcupsd_exporter
    environment:
      - PUID=1000
      - PGID=1000
      - TZ=Europe/London
      - APC_HOST=
      - APC_PORT=3551 #optional
    ports:
      - 9162:9162
    restart: unless-stopped

docker cli

docker run -d \
  --name=apcupsd_exporter \
  -e PUID=1000 \
  -e PGID=1000 \
  -e TZ=Europe/London \
  -e APC_HOST= \
  -e APC_PORT=3551 `#optional` \
  -p 9162:9162 \
  --restart unless-stopped \
  ghcr.io/thespad/apcupsd_exporter

Parameters

Container 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.

Parameter	Function
-p 9162	Metrics port
-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 America/New_York
-e APC_HOST=	The hostname or IP of the server where apcupsd NIS is running
-e APC_PORT=3551	The port on which apcupsd NIS is running

Environment variables from files (Docker secrets)

You can set any environment variable from a file by using a special prepend FILE__.

As an example:

-e FILE__PASSWORD=/run/secrets/mysecretpassword

Will set the environment variable PASSWORD based on the contents of the /run/secrets/mysecretpassword file.

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 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.

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:

  $ id username
    uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)

Support Info

• Shell access whilst the container is running: docker exec -it apcupsd_exporter /bin/bash
• To monitor the logs of the container in realtime: docker logs -f apcupsd_exporter

Updating Info

Most of our images are static, versioned, and require an image update and container recreation to update the app inside. We do not recommend or support updating apps inside the container. Please consult the Application Setup section above to see if it is recommended for the image.

Below are the instructions for updating containers:

Via Docker Compose

• Update all images: docker-compose pull
  • or update a single image: docker-compose pull apcupsd_exporter
• Let compose update all containers as necessary: docker-compose up -d
  • or update a single container: docker-compose up -d apcupsd_exporter
• You can also remove the old dangling images: docker image prune

Via Docker Run

• Update the image: docker pull ghcr.io/thespad/apcupsd_exporter
• Stop the running container: docker stop apcupsd_exporter
• Delete the container: docker rm apcupsd_exporter
• 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)
• You can also remove the old dangling images: docker image prune

Image Update Notifications - Diun (Docker Image Update Notifier)

• We recommend Diun for update notifications. Other tools that automatically update containers unattended are not recommended or supported.

Building locally

If you want to make local modifications to these images for development purposes or just to customize the logic:

git clone https://github.com/thespad/docker-apcupsd_exporter.git
cd docker-apcupsd_exporter
docker build \
  --no-cache \
  --pull \
  -t ghcr.io/thespad/apcupsd_exporter:latest .

Versions

• 26.05.24: - Rebase to Alpine 3.20.
• 30.12.23: - Rebase to Alpine 3.19.
• 06.08.23: - Initial Release.