43 lines
1.1 KiB
Markdown
43 lines
1.1 KiB
Markdown
# Homepage
|
|
|
|
A modern, secure, highly customizable application dashboard.
|
|
|
|
## 📋 Configuration Notes
|
|
|
|
### **Environment Variables**
|
|
The following environment variables are used in the configuration:
|
|
|
|
```bash
|
|
PUID
|
|
PGID
|
|
TZ
|
|
HOMEPAGE_ALLOWED_HOSTS
|
|
```
|
|
|
|
### **Setup Details**
|
|
- **Domain**: configured in `docker-compose.yaml` (uses `${DOMAIN}` variable)
|
|
- **Port**: `3000` (container internal)
|
|
- **Volumes**:
|
|
- `/srv/homelab/volumes/homepage/config`
|
|
- `/var/run/docker.sock` (read-only, for Docker integration)
|
|
- **Networks**: `proxy` (external)
|
|
|
|
### **Important URLs**
|
|
- **Dashboard**: `https://homepage.${DOMAIN}`
|
|
|
|
### **Customizations**
|
|
- **Reverse Proxy**: Traefik with Cloudflare DNS challenge for SSL.
|
|
- **Docker Integration**: Access to Docker socket for container monitoring.
|
|
- **Allowed Hosts**: Restricted to `${DOMAIN}` via environment variable.
|
|
|
|
## 🚀 Deployment
|
|
|
|
Deployed via Docker Compose / Portainer.
|
|
|
|
## 🔧 Service Details
|
|
|
|
- **Container**: `homepage`
|
|
- **Image**: `ghcr.io/gethomepage/homepage:latest`
|
|
- **Health Check**: Native application health monitoring (wget)
|
|
- **Logging**: JSON format, 10MB rotation
|