Skip to content

System Dashboard (Homepage)

Homepage serves as the central portal for service monitoring and navigation.

ID: 110
IP Address: <DASHBOARD_IP>
Software: gethomepage/homepage


1. Instance Specification

LXC Container details for the dashboard host:

Component Specification Description
vCPU 1 Core Minimal processing load
RAM 512 MB Static allocation
Storage 8 GB local-lvm
Network Static IPv4 CIDR: <DASHBOARD_IP>/24

2. Deployment Procedure

A. Environment Setup

  1. Create a Debian 12 LXC following the specifications in Section 1.
  2. Update the system and install Docker:
apt update && apt upgrade -y
curl -fsSL https://get.docker.com -o get-docker.sh
sh get-docker.sh

B. Configuration Structure

Create the required directory hierarchy:

mkdir -p /opt/homepage/config
cd /opt/homepage

C. Docker Compose Configuration

Define the service in docker-compose.yml:

version: "3"
services:
  homepage:
    image: ghcr.io/gethomepage/homepage:latest
    container_name: homepage
    ports:
      - 3005:3000
    volumes:
      - ./config:/app/config
      - /var/run/docker.sock:/var/run/docker.sock # Optional: Docker integration
    restart: always

Execute docker compose up -d to start the service.


3. Configuration Management

Functional settings are managed via YAML files in /opt/homepage/config/:

  • services.yaml: Define links and service status monitoring targets.
  • widgets.yaml: Configure system information widgets (CPU/RAM).
  • bookmarks.yaml: Manage external links and references.

4. Access and Verification

  • External URL: http://<DASHBOARD_IP>:3005
  • Internal Port: 3000 (Mapped to 3005)

Status Verification

  1. Confirm the container state is "Healthy".
  2. Verify service availability via the web interface.