Skip to content

Latest commit

 

History

57 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Homepage Config

My personal configuration files for gethomepage/homepage.

Setup

Prerequisites

  • Docker and a user-defined Docker network (docker network create my-network)
  • A docker-socket-proxy container on the same network (referenced as dockersocket:2375 in docker.yaml)
  • A .env.homepage file with the required environment variables

Run

docker run \
  -d \
  --name homepage \
  --net my-network \
  --env-file /path/to/.env.homepage \
  -e TZ="America/Edmonton" \
  -p 3000:3000 \
  -v /path/to/config:/app/config:rw \
  -v /path/to/icons:/app/icons:rw \
  -v /path/to/images:/app/images:rw \
  -v /mnt:/mnt:ro \
  ghcr.io/gethomepage/homepage:latest

The /mnt bind mount is required for the disk widgets in widgets.yaml to read Unraid array and cache disk usage.

Environment Variables

{{HOMEPAGE_VAR_*}} placeholders are substituted at build time from environment variables.

.env.homepage
HOMEPAGE_VAR_DOMAIN_NAME=example.com
HOMEPAGE_VAR_ROUTER_IP=192.168.0.1
HOMEPAGE_VAR_UNRAID_API_KEY="XXXXXXXXXXXXX"
HOMEPAGE_VAR_TAILSCALE_DEVICE_ID="XXXXXXXXXXXXX"
HOMEPAGE_VAR_TAILSCALE_API_KEY="XXXXXXXXXXXXX"
etc.

See .env.homepage.sample for the full list of variables.

Theme

config/custom.css contains a Dracula theme based on homepage-dracula. settings.yaml must have color: gray uncommented, or colour must be manually chosen, for it to apply.

The background image (images/dracula-solid.png) is mounted from the local images/ directory.


Screenshot

Homepage Example

Credits

About

Personal collection of config files for gethomepage/homepage

Topics

Resources

Security policy

Stars

29 stars

Watchers

2 watching

Forks

Releases

Packages

Contributors

Languages