docker containers/tools and utilities/home page.md ..
@@ 8,3 8,53 @@
With translations in multiple languages, Homepage ensures **efficient access and management** of services.
For more details, visit [Homepage](https://gethomepage.dev/).
+
+
# Setting Up Homepage with Docker Compose
+
+
## Introduction to Homepage Dashboard
+
+
Homepage is a **modern, fully static, fast, and secure** application dashboard designed for **customization and integration**. It supports **over 100 services**, offers **translations into multiple languages**, and is easily configured via **YAML files or Docker label discovery**. It features **quick search, bookmarks, weather support, and various widgets**, making it a handy tool for organizing and accessing services efficiently. You can explore more details [here](https://gethomepage.dev/).
+
+
## Docker Compose Configuration for Homepage
+
+
This Docker Compose setup deploys Homepage in a Docker container, offering an isolated environment for your homepage.
+
+
### Docker Compose File (`docker-compose.yml`)
+
+
```yaml
+
services:
+
homepage:
+
image: ghcr.io/gethomepage/homepage:latest
+
container_name: homepage
+
environment:
+
HOMEPAGE_ALLOWED_HOSTS: gethomepage.dev # required, may need port. See gethomepage.dev/installation/#homepage_allowed_hosts
+
PUID: 1000 # optional, your user id
+
PGID: 1000 # optional, your group id
+
ports:
+
- 3000:3000
+
volumes:
+
- /path/to/config:/app/config # Make sure your local config directory exists
+
- /var/run/docker.sock:/var/run/docker.sock:ro # optional, for docker integrations
+
restart: unless-stopped
+
```
+
+
## Key Components of the Configuration
+
### Service: Homepage
+
- **Image**: `ghcr.io/gethomepage/homepage:latest` is the Docker image used for Homepage.
+
- **Ports**:
+
- `3000:3000` maps port 3000 on the host to port 3000 in the container, where homepage web interface is accessible.
+
- **Restart Policy**: `unless-stopped` ensures that the Haomepage service restarts automatically unless stopped.
+
+
## Deploying Homepage
+
+
1. Save the Docker Compose configuration in a `docker-compose.yml` file.
+
2. Run `docker compose up -d` to start Homepage in detached mode.
+
3. Access Homepage by navigating to `http://<host-ip>:3000`.
+
+
## Configuring and Using Homepage
+
+
After deployment, Homepage is ready to use through its web interface.