Three ways to run FireBin

If you already run Home Assistant, you can install FireBin as an add-on. Home Assistant runs it as a container for you, so there is no compose file and nothing to manage in a terminal.

You will need

• • Home Assistant OS or Supervised (the versions with the Add-on Store). Home Assistant Container does not have add-ons; use Docker Compose above instead.

1. 1. Add the FireBin add-on repository

   In Home Assistant, go to Settings → Add-ons → Add-on Store. Open the menu (top right, three dots) → Repositories, and paste:

   https://github.com/FireBall1725/firebin

2. 2. Install FireBin

   FireBin now appears near the bottom of the store. Open it and press Install. It bundles its own database, so there is nothing else to set up.

3. 3. Start it

   Press Start. Turn on Start on boot and Watchdog so it stays running and restarts itself.

4. 4. Open it

   Open the add-on's Web UI (the Open Web UI button), or browse to your Home Assistant address on port 3000. Register the first account to become the admin.

For a homelab or server already running Kubernetes. The database is run by the CloudNativePG operator; the API and web app are ordinary Deployments. This one assumes you know your way around kubectl.

You will need

• • A Kubernetes cluster and kubectl.
• • An ingress controller (for the last step), or use kubectl port-forward to try it first.

1. 1. Install the CloudNativePG operator

   Once per cluster. This installs the operator that runs Postgres for you:

   kubectl apply --server-side -f \
     https://raw.githubusercontent.com/cloudnative-pg/cloudnative-pg/release-1.24/releases/cnpg-1.24.1.yaml

2. 2. Apply FireBin

   Save this as firebin.yaml, replace the two paste-... values and the ingress host, then kubectl apply -f firebin.yaml:

   apiVersion: v1
   kind: Namespace
   metadata:
     name: firebin
   ---
   # The database, run by the CloudNativePG operator.
   apiVersion: postgresql.cnpg.io/v1
   kind: Cluster
   metadata:
     name: firebin-db
     namespace: firebin
   spec:
     instances: 1
     storage:
       size: 5Gi
     bootstrap:
       initdb:
         database: firebin
         owner: firebin
   ---
   apiVersion: v1
   kind: Secret
   metadata:
     name: firebin-secrets
     namespace: firebin
   type: Opaque
   stringData:
     jwt-secret: paste-a-long-random-string-here
   ---
   apiVersion: apps/v1
   kind: Deployment
   metadata:
     name: firebin-api
     namespace: firebin
   spec:
     replicas: 1
     selector: { matchLabels: { app: firebin-api } }
     template:
       metadata: { labels: { app: firebin-api } }
       spec:
         containers:
           - name: api
             image: ghcr.io/fireball1725/firebin-api:latest
             ports: [{ containerPort: 8080 }]
             env:
               # CloudNativePG writes the db user/password into <cluster>-app.
               - name: DB_USER
                 valueFrom: { secretKeyRef: { name: firebin-db-app, key: username } }
               - name: DB_PASS
                 valueFrom: { secretKeyRef: { name: firebin-db-app, key: password } }
               - name: DATABASE_URL
                 value: postgres://$(DB_USER):$(DB_PASS)@firebin-db-rw:5432/firebin?sslmode=require
               - name: JWT_SECRET
                 valueFrom: { secretKeyRef: { name: firebin-secrets, key: jwt-secret } }
   ---
   apiVersion: v1
   kind: Service
   metadata:
     name: firebin-api
     namespace: firebin
   spec:
     selector: { app: firebin-api }
     ports: [{ port: 8080, targetPort: 8080 }]
   ---
   apiVersion: apps/v1
   kind: Deployment
   metadata:
     name: firebin-web
     namespace: firebin
   spec:
     replicas: 1
     selector: { matchLabels: { app: firebin-web } }
     template:
       metadata: { labels: { app: firebin-web } }
       spec:
         containers:
           - name: web
             image: ghcr.io/fireball1725/firebin-web:latest
             ports: [{ containerPort: 3000 }]
   ---
   apiVersion: v1
   kind: Service
   metadata:
     name: firebin-web
     namespace: firebin
   spec:
     selector: { app: firebin-web }
     ports: [{ port: 80, targetPort: 3000 }]
   ---
   apiVersion: networking.k8s.io/v1
   kind: Ingress
   metadata:
     name: firebin
     namespace: firebin
   spec:
     rules:
       - host: firebin.example.com
         http:
           paths:
             - path: /
               pathType: Prefix
               backend:
                 service:
                   name: firebin-web
                   port: { number: 80 }

3. 3. Open it

   Point firebin.example.com at your ingress and open it, or try it first with a port-forward:

   kubectl -n firebin port-forward svc/firebin-web 8080:80
   # then open http://localhost:8080

The CloudNativePG cluster handles its own backups and failover once you configure them; see the CloudNativePG docs for scheduled backups to object storage.