Blame
| 5b868c | MB Tech | 2025-07-28 01:43:55 | 1 | # Home Page |
| 2 | ||||
| 3 | # Homepage Dashboard Summary |
|||
| 4 | ||||
| 5 | Homepage is a **modern, static, fast, and secure** application dashboard built for **customization and integration**. It supports **over 100 services**, offering: |
|||
| 6 | - **Quick search & bookmarks** |
|||
| 7 | - **Weather integration** |
|||
| 8 | - **Various widgets for better organization** |
|||
| 9 | - **YAML configuration or Docker label discovery** |
|||
| 10 | ||||
| 11 | With translations in multiple languages, Homepage ensures **efficient access and management** of services. |
|||
| 12 | For more details, visit [Homepage](https://gethomepage.dev/). |
|||
| 13 | ||||
| 14 | # Setting Up Homepage with Docker Compose |
|||
| 15 | ||||
| 16 | ## Introduction to Homepage Dashboard |
|||
| 17 | ||||
| 18 | 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/). |
|||
| 19 | ||||
| 20 | ## Docker Compose Configuration for Homepage |
|||
| 21 | ||||
| 22 | This Docker Compose setup deploys Homepage in a Docker container, offering an isolated environment for your homepage. |
|||
| 23 | ||||
| 24 | ### Docker Compose File (`docker-compose.yml`) |
|||
| 25 | ||||
| 26 | ```yaml |
|||
| 27 | services: |
|||
| 28 | homepage: |
|||
| 29 | image: ghcr.io/gethomepage/homepage:latest |
|||
| 30 | container_name: homepage |
|||
| 31 | environment: |
|||
| 32 | HOMEPAGE_ALLOWED_HOSTS: gethomepage.dev # required, may need port. See gethomepage.dev/installation/#homepage_allowed_hosts |
|||
| 33 | PUID: 1000 # optional, your user id |
|||
| 34 | PGID: 1000 # optional, your group id |
|||
| 35 | ports: |
|||
| 36 | - 3000:3000 |
|||
| 37 | volumes: |
|||
| 38 | - /path/to/config:/app/config # Make sure your local config directory exists |
|||
| 39 | - /var/run/docker.sock:/var/run/docker.sock:ro # optional, for docker integrations |
|||
| 40 | restart: unless-stopped |
|||
| 41 | ``` |
|||
| 42 | ||||
| 43 | ## Key Components of the Configuration |
|||
| 44 | ### Service: Homepage |
|||
| 45 | - **Image**: `ghcr.io/gethomepage/homepage:latest` is the Docker image used for Homepage. |
|||
| 46 | - **Ports**: |
|||
| 47 | - `3000:3000` maps port 3000 on the host to port 3000 in the container, where homepage web interface is accessible. |
|||
| 48 | - **Restart Policy**: `unless-stopped` ensures that the Haomepage service restarts automatically unless stopped. |
|||
| 49 | ||||
| 50 | ## Deploying Homepage |
|||
| 51 | ||||
| 52 | 1. Save the Docker Compose configuration in a `docker-compose.yml` file. |
|||
| 53 | 2. Run `docker compose up -d` to start Homepage in detached mode. |
|||
| 54 | 3. Access Homepage by navigating to `http://<host-ip>:3000`. |
|||
| 55 | ||||
| 56 | ## Configuring and Using Homepage |
|||
| 57 | ||||
| 58 | After deployment, Homepage is ready to use through its web interface. |
|||
| 59 | ||||
| 60 | ||||
| 61 | ## Youtube Video |
|||
| 62 | ||||
| 63 | Video coming soon!!! |