diff --git a/compose/.apps/homepage/homepage.aarch64.yml b/compose/.apps/homepage/homepage.aarch64.yml new file mode 100644 index 0000000000..32dcae28fa --- /dev/null +++ b/compose/.apps/homepage/homepage.aarch64.yml @@ -0,0 +1,3 @@ +services: + homepage: + image: ghcr.io/gethomepage/homepage:${HOMEPAGE_TAG} diff --git a/compose/.apps/homepage/homepage.armv6.yml b/compose/.apps/homepage/homepage.armv6.yml new file mode 100644 index 0000000000..32dcae28fa --- /dev/null +++ b/compose/.apps/homepage/homepage.armv6.yml @@ -0,0 +1,3 @@ +services: + homepage: + image: ghcr.io/gethomepage/homepage:${HOMEPAGE_TAG} diff --git a/compose/.apps/homepage/homepage.armv7.yml b/compose/.apps/homepage/homepage.armv7.yml new file mode 100644 index 0000000000..32dcae28fa --- /dev/null +++ b/compose/.apps/homepage/homepage.armv7.yml @@ -0,0 +1,3 @@ +services: + homepage: + image: ghcr.io/gethomepage/homepage:${HOMEPAGE_TAG} diff --git a/compose/.apps/homepage/homepage.hostname.yml b/compose/.apps/homepage/homepage.hostname.yml new file mode 100644 index 0000000000..9f59109100 --- /dev/null +++ b/compose/.apps/homepage/homepage.hostname.yml @@ -0,0 +1,3 @@ +services: + homepage: + hostname: ${DOCKERHOSTNAME} diff --git a/compose/.apps/homepage/homepage.labels.yml b/compose/.apps/homepage/homepage.labels.yml new file mode 100644 index 0000000000..afdc3dfbce --- /dev/null +++ b/compose/.apps/homepage/homepage.labels.yml @@ -0,0 +1,12 @@ +services: + homepage: + labels: + com.dockstarter.appinfo.deprecated: "false" + com.dockstarter.appinfo.description: "A highly customizable application dashboard with integrations for over 100 services" + com.dockstarter.appinfo.nicename: "homepage" + com.dockstarter.appvars.homepage_enabled: "false" + com.dockstarter.appvars.homepage_network_mode: "host" + com.dockstarter.appvars.homepage_port_3000: "3000" + com.dockstarter.appvars.homepage_restart: "unless-stopped" + com.dockstarter.appvars.homepage_tag: "latest" + com.dockstarter.appvars.homepage_docker_intergrate: "/var/run/docker.sock" diff --git a/compose/.apps/homepage/homepage.netmode.yml b/compose/.apps/homepage/homepage.netmode.yml new file mode 100644 index 0000000000..5fab23067f --- /dev/null +++ b/compose/.apps/homepage/homepage.netmode.yml @@ -0,0 +1,3 @@ +services: + homepage: + network_mode: ${HOMEPAGE_NETWORK_MODE} diff --git a/compose/.apps/homepage/homepage.ports.yml b/compose/.apps/homepage/homepage.ports.yml new file mode 100644 index 0000000000..44e41f7868 --- /dev/null +++ b/compose/.apps/homepage/homepage.ports.yml @@ -0,0 +1,4 @@ +services: + homepage: + ports: + - ${HOMEPAGE_PORT_3000}:3000 diff --git a/compose/.apps/homepage/homepage.x86_64.yml b/compose/.apps/homepage/homepage.x86_64.yml new file mode 100644 index 0000000000..32dcae28fa --- /dev/null +++ b/compose/.apps/homepage/homepage.x86_64.yml @@ -0,0 +1,3 @@ +services: + homepage: + image: ghcr.io/gethomepage/homepage:${HOMEPAGE_TAG} diff --git a/compose/.apps/homepage/homepage.yml b/compose/.apps/homepage/homepage.yml new file mode 100644 index 0000000000..30be01071d --- /dev/null +++ b/compose/.apps/homepage/homepage.yml @@ -0,0 +1,18 @@ +services: + homepage: + container_name: homepage + environment: + - PGID=${PGID} + - PUID=${PUID} + - TZ=${TZ} + logging: + driver: json-file + options: + max-file: ${DOCKERLOGGING_MAXFILE} + max-size: ${DOCKERLOGGING_MAXSIZE} + restart: ${HOMEPAGE_RESTART} + volumes: + - /etc/localtime:/etc/localtime:ro + - ${HOMEPAGE_DOCEKR_INTERGRATE}:/var/run/docker.sock + - ${DOCKERCONFDIR}/homepage:/app/config + - ${DOCKERSTORAGEDIR}:/storage diff --git a/docs/apps/homepage.md b/docs/apps/homepage.md new file mode 100644 index 0000000000..73affe3165 --- /dev/null +++ b/docs/apps/homepage.md @@ -0,0 +1,28 @@ +# Homepage + +[![Image Size](https://ghcr-badge.egpl.dev/gethomepage/homepage/size?color=%2344cc11&tag=latest&label=image+size&trim=)](https://github.com/gethomepage/homepage/pkgs/container/homepage) +[![GitHub Stars](https://img.shields.io/github/stars/gethomepage/homepage?style=flat-square&color=607D8B&label=github%20stars&logo=github)](https://github.com/bastienwirtz/Homepage) +[![Compose Templates](https://img.shields.io/static/v1?style=flat-square&color=607D8B&label=compose&message=templates)](https://github.com/GhostWriters/DockSTARTer/tree/master/compose/.apps/homepage) + +## Description + +[Homepage](https://github.com/bastienwirtz/Homepage) is a modern, fully static, fast, secure fully proxied, highly customizable application dashboard with integrations for over 100 services and translations into multiple languages. Easily configured via YAML files or through docker label discovery. . + +## Install/Setup + +Refer to the following pages for detailed instructions: + +- [Homepage Docker Installation](https://gethomepage.dev/latest/installation/docker/) +- [Homepage Configs](https://gethomepage.dev/latest/configs/) + +Docker integration is enabled in the setting label by default, you can disable by remove the `HOMEPAGE_DOCEKR_INTERGRATE` enviroment variable. + +### Using Environment Secrets + +#### You can also include environment variables in your config files to protect sensitive information + +Note: + +- Environment variables must start with HOMEPAGE_VAR_ or HOMEPAGE_FILE_ +- The value of env var HOMEPAGE_VAR_XXX will replace {{HOMEPAGE_VAR_XXX}} in any config +- The value of env var HOMEPAGE_FILE_XXX must be a file path, the contents of which will be used to replace {{HOMEPAGE_FILE_XXX}} in any config diff --git a/mkdocs.yml b/mkdocs.yml index 244384e7d7..34f0f8fcf9 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -157,6 +157,7 @@ nav: - apps/heimdall.md - apps/homeassistant.md - apps/homebridge.md + - apps/homepage.md - apps/homer.md - apps/htpcmanager.md - apps/httpserver.md