gregdotca/homelabapi repository overview

HomelabAPI is a self-hosted API that you can use to consolidate all of your homelab notifications and other outputs. This allows you to use HomelabAPI as your central input/output hub, and if you ever want to change where your homelab outputs go, it's just a matter of updating your HomelabAPI configuration.

For example, let's say that you have all of your Home Assistant, Synology, and Tailscale notifications routed through HomelabAPI, and you have HomelabAPI configured to send all notifications to Pushover. Now let's say that you want to move your notifications from Pushover to Telegram. Instead of having to go into each of your homelab services and reconfigure where notifications get sent, all you have to do is update HomelabAPI to send to Telegram instead of Pushover, and that's it. One single update and you're done!

If you don't have many outputs being sent from your homelab, HomelabAPI may not be for you. However, if you're like me and have dozens of homelab outputs, you may want to give it a try. Plus it's another service to host in your homelab, how great is that?

For more information please visit our website⁠.

⁠Supported Architectures

Our Docker image supports the architectures listed in the table below. When pulling our image, your system's architecture will automatically be detected and the proper image will be downloaded.

⁠Accessing HomelabAPI

After running docker-compose up, HomelabAPI will be available at http://ip-address:8090.

⁠Usage

Sample docker-compose.yml

---
services:

  homelabapi:
    image: gregdotca/homelabapi:latest
    container_name: homelabapi
    environment:
      - TZ=America/Vancouver
    ports:
      - "8090:80"
    restart: unless-stopped
    volumes:
      - ./config.yaml:/code/app/config.yaml

⁠Parameters & Environment Variables

⁠Updating The Container

To update your HomelabAPI container, simply run docker-compose pull && docker-compose up -d