Homepage Config

A personal collection of example configuration files for gethomepage/homepage. These examples demonstrate how to configure and customize Homepage using environment variables, Docker, and custom themes.

Getting Started

Prerequisites

Before using these configurations, ensure you have the following:

• Docker installed on your system (Install Docker).
• A user-defined Docker network, such as dsn (create one with docker network create dsn).
• A .env.homepage file with required environment variables.

Setup

1. Clone this repository:

   git clone https://github.com/MountainGod2/homepage_config.git
   cd homepage_config

2. Create a .env.homepage file in the appropriate directory. Example:

   HOMEPAGE_VAR_SERVER_IP=192.168.0.100
   HOMEPAGE_VAR_DOMAIN_NAME=example.com
   HOMEPAGE_VAR_CLOUDFLARE_ACCOUNT_ID=XXXX

3. Run the Docker container using the provided commands.

---

Configuration Examples

Docker Run Command

Using a .env.homepage File

docker run \
  -d \
  --name='homepage' \
  --net='dsn' \
  --env-file /path/to/homepage/.secrets/.env.homepage \
  -e TZ="America/Denver" \
  -p '3000:3000/tcp' \
  -v '/path/to/homepage/config:/app/config:rw' \
  -v '/path/to/homepage/icons:/app/icons:rw' \  # Optional mount for local icons
  -v '/path/to/homepage/images:/app/images:rw' \  # Option mount for local background images
  -v '/mnt/':'/mnt':'ro' \  # Optional mount for local disk statistics
  'ghcr.io/gethomepage/homepage:latest'

Setting Environment Variables Inline

docker run \
  -d \
  --name='homepage' \
  --net='dsn' \
  -e 'HOMEPAGE_VAR_SERVER_IP=192.168.0.100' \
  -e 'HOMEPAGE_VAR_DOMAIN_NAME=example.com' \
  -e 'HOMEPAGE_VAR_CLOUDFLARE_ACCOUNT_ID=XXXX' \
  -p '3000:3000/tcp' \
  -v '/path/to/homepage/config:/app/config:rw' \
  -v '/path/to/homepage/icons:/app/icons:rw' \  # Optional mount for local icons
  -v '/path/to/homepage/images:/app/images:rw' \  # Option mount for local background images
  -v '/mnt/':'/mnt':'ro' \  # Optional mount for local disk statistics
  'ghcr.io/gethomepage/homepage:latest'

Environment Variables

Here is a list of key environment variables and their purposes:

Variable	Description
HOMEPAGE_VAR_SERVER_IP	The IP address of the server.
HOMEPAGE_VAR_DOMAIN_NAME	The domain name for the services.
HOMEPAGE_VAR_CLOUDFLARE_ACCOUNT_ID	Cloudflare account ID for integration.
HOMEPAGE_VAR_TAILSCALE_API_KEY	API key for Tailscale integration.
...	...

---

Custom Theme

A custom Dracula theme is included in this repository. To enable it:

1. Copy config/custom.css to your config directory.
2. Update your settings.yaml to include:

   theme: dark
   color: gray
   background: /images/dracula-solid.png

For more themes, check homepage-dracula.

---

Screenshots

---

Credits

• Dracula Theme by Jas-SinghFSU
• Homepage Dashboard by gethomepage

---

Contributing

Contributions are welcome! Please open an issue or submit a pull request for improvements or additional configurations.

---

License

This project is licensed under the MIT License. See the LICENSE file for details.