Skip to content

:simple-homebox: Homebox

🛠 Installation

Default Port: 7745

bash -c "$(curl -sL https://github.com/community-scripts/ProxmoxVE/raw/main/ct/homebox.sh)"

bash -c "$(curl -sL https://github.com/asylumexp/Proxmox/raw/main/ct/homebox.sh)"

âš™ Config

homelab/lxc/homebox/.env

# Homebox Configuration
# https://homebox.software/en/installation

# General
HBOX_MODE=production
HBOX_LOG_LEVEL=info
HBOX_LOG_FORMAT=text

# Web
HBOX_WEB_PORT=7745
HBOX_WEB_MAX_UPLOAD_SIZE=10

# Storage
HBOX_STORAGE_DATA=/data

# Options
HBOX_OPTIONS_ALLOW_REGISTRATION=true
HBOX_OPTIONS_ALLOW_ANALYTICS=false

# Service
CONFIG_DIR=/etc/homebox
INSTALL_DIR=/opt/homebox
SERVICE_NAME=homebox

Traefik

homelab/pve/traefik/conf.d/homebox.yaml 
---
http:
 #region routers 
  routers:
    homebox:
      entryPoints:
        - "websecure"
      rule: "Host(`homebox.l.nicholaswilde.io`)"
      middlewares:
        - default-headers@file
        - https-redirectscheme@file
      tls: {}
      service: homebox

#endregion
#region services
  services:
    homebox:
      loadBalancer:
        servers:
          - url: "http://192.168.1.115:7745"
        passHostHeader: true
#endregion

Task List

task: Available tasks for this project:
* create-template:       Create template from existing .env file
* decrypt:               Decrypt sensitive configuration files using SOPS.
* default:               List all available tasks.
* enable:                Enable the application's systemd service.
* encrypt:               Encrypt sensitive configuration files using SOPS.
* export:                Export the task list to `task-list.txt`.
* init:                  Initialize the application's environment and configuration files.
* mklinks:               Create symbolic links for configuration files.
* restart:               Restart the application's systemd service.
* start:                 Start the application's systemd service.
* status:                Check the status of the application's systemd service.
* stop:                  Stop the application's systemd service.
* update:                Update the application or its running containers.
* upgrade:               Upgrade the application by pulling the latest changes and updating.
* verify-secrets:        Checks if the decrypted secret matches the local file
* wh:install:            Install and start the systemd webhook service
* wh:logs:               View the webhook service logs
* wh:status:             Check the status of the systemd webhook service
* wh:test:               Test the webhook listener locally

🔗 References