Skip to content

Software title: Homepage #293

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Apr 28, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added tools/include/images/HPG001.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
19 changes: 19 additions & 0 deletions tools/include/markdown/HPG001-footer.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
=== "Access to the web interface"

The web interface is accessible via port **3000**:

- URL: `https://<your.IP>:3000`
- Username/Password: none

Configuration: Please reffer to official manual <https://gethomepage.dev/configs/>

=== "Directories"

- Install directory: `/armbian/homepage`
- Site configuration directory: `/armbian/homepage/config`

=== "View logs"

```sh
docker logs -f homepage
```
17 changes: 17 additions & 0 deletions tools/include/markdown/HPG001-header.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
[gethomepage](https://gethomepage.dev/) is a fast, fully static, highly customizable application dashboard built for modern self-hosted environments. With a **fully proxied** architecture and **zero runtime**, it delivers exceptional speed, security, and simplicity for organizing and accessing your services.

It supports **over 100 service integrations** and **multiple languages**, offering live status displays and dynamic resource monitoring out-of-the-box. Configuration is effortless via **YAML files** or automatic **Docker label discovery**, making setup and management seamless.

*Key Features*

- **Static Frontend**: Blazing-fast performance with no server-side runtime.
- **Secure Proxying**: Safely access internal services without direct exposure.
- **Service Integrations**: Native support for Docker, Kubernetes, Grafana, Proxmox, Home Assistant, and more.
- **Easy Configuration**: Manage layout and services with YAML or Docker labels.
- **Internationalization**: Translations available for multiple languages.
- **Flexible Theming**: Personalize with themes, layouts, and styling.
- **Simple Deployment**: Host via Docker, Kubernetes, or any static hosting platform.

---

Whether you're running a small homelab or a full server fleet, **gethomepage** offers a sleek, powerful, and secure way to stay organized.
31 changes: 31 additions & 0 deletions tools/json/config.software.json
Original file line number Diff line number Diff line change
Expand Up @@ -1736,6 +1736,37 @@
"status": "Stable",
"author": "@Tearran",
"condition": ""
},
{
"id": "HPG001",
"description": "Install Homepage startpage / application dashboard",
"short": "Homepage",
"command": [
"module_homepage install"
],
"status": "Stable",
"author": "@igorpecovnik",
"condition": "! module_homepage status"
},
{
"id": "HPG002",
"description": "Remove Homepage",
"command": [
"module_homepage remove"
],
"status": "Stable",
"author": "@igorpecovnik",
"condition": "module_homepage status"
},
{
"id": "HPG003",
"description": "Purge Homepage with data folder",
"command": [
"module_homepage purge"
],
"status": "Stable",
"author": "@igorpecovnik",
"condition": "module_homepage status"
}
]
},
Expand Down
1 change: 1 addition & 0 deletions tools/modules/runtime/config.runtime.sh
Original file line number Diff line number Diff line change
Expand Up @@ -144,6 +144,7 @@ update_sub_submenu_data "Software" "Monitoring" "NAX002" "http://$LOCALIPADD:${m

# Management
update_sub_submenu_data "Software" "Management" "CPT001" "http://$LOCALIPADD:${module_options["module_cockpit,port"]}"
update_sub_submenu_data "Software" "Management" "HPG002" "http://$LOCALIPADD:${module_options["module_homepage,port"]}"

# Downloaders
update_sub_submenu_data "Software" "Downloaders" "DOW002" "http://$LOCALIPADD:${module_options["module_qbittorrent,port"]%% *}" # removing second port from url
Expand Down
88 changes: 88 additions & 0 deletions tools/modules/software/module_homepage.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,88 @@
module_options+=(
["module_homepage,author"]="@armbian"
["module_homepage,maintainer"]="@igorpecovnik"
["module_homepage,feature"]="module_homepage"
["module_homepage,example"]="install remove purge status help"
["module_homepage,desc"]="Install homepage container"
["module_homepage,status"]="Active"
["module_homepage,doc_link"]="https://gethomepage.dev/configs/"
["module_homepage,group"]="Management"
["module_homepage,port"]="3000"
["module_homepage,arch"]=""
)
#
# Module homepage
#
function module_homepage () {
local title="homepage"
local condition=$(which "$title" 2>/dev/null)

if pkg_installed docker-ce; then
local container=$(docker container ls -a | mawk '/homepage?( |$)/{print $1}')
local image=$(docker image ls -a | mawk '/homepage( |$ )/{print $3}')
fi

local commands
IFS=' ' read -r -a commands <<< "${module_options["module_homepage,example"]}"

HOMEPAGE_BASE="${SOFTWARE_FOLDER}/homepage"

case "$1" in
"${commands[0]}")
pkg_installed docker-ce || install_docker
[[ -d "$HOMEPAGE_BASE" ]] || mkdir -p "$HOMEPAGE_BASE" || { echo "Couldn't create storage directory: $HOMEPAGE_BASE"; exit 1; }

docker run -d \
--net=lsio \
--name homepage \
-e PUID=1000 \
-e PGID=1000 \
-e HOMEPAGE_ALLOWED_HOSTS=${LOCALIPADD}:${module_options["module_homepage,port"]},homepage.local:${module_options["module_homepage,port"]},localhost:${module_options["module_homepage,port"]} \
-p 3000:3000 \
-v "${HOMEPAGE_BASE}/config:/app/config" \
-v /var/run/docker.sock:/var/run/docker.sock:ro \
--restart unless-stopped \
ghcr.io/gethomepage/homepage:latest
for i in $(seq 1 20); do
if docker inspect -f '{{ index .Config.Labels "build_version" }}' homepage >/dev/null 2>&1 ; then
break
else
sleep 3
fi
if [ $i -eq 20 ] ; then
echo -e "\nTimed out waiting for ${title} to start, consult your container logs for more info (\`docker logs homepage\`)"
exit 1
fi
done
;;
"${commands[1]}")
[[ "${container}" ]] && docker container rm -f "$container" >/dev/null
[[ "${image}" ]] && docker image rm "$image" >/dev/null
;;
"${commands[2]}")
${module_options["module_homepage,feature"]} ${commands[1]}
[[ -n "${HOMEPAGE_BASE}" && "${HOMEPAGE_BASE}" != "/" ]] && rm -rf "${HOMEPAGE_BASE}"
;;
"${commands[3]}")
if [[ "${container}" && "${image}" ]]; then
return 0
else
return 1
fi
;;
"${commands[4]}")
echo -e "\nUsage: ${module_options["module_homepage,feature"]} <command>"
echo -e "Commands: ${module_options["module_homepage,example"]}"
echo "Available commands:"
echo -e "\tinstall\t- Install $title."
echo -e "\tstatus\t- Installation status $title."
echo -e "\tremove\t- Remove $title."
echo -e "\tpurge\t- Remove $title and delete its data."
echo -e "\thelp\t- Show this help message."
echo
;;
*)
${module_options["module_homepage,feature"]} ${commands[4]}
;;
esac
}