-
-
Notifications
You must be signed in to change notification settings - Fork 38
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
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
b1a8b9e
Software title: Homepage
igorpecovnik cfc896f
Replace check_if_installed
igorpecovnik 20d2dfe
Merge branch 'main' into homepage
igorpecovnik 4449494
Merge branch 'main' into homepage
igorpecovnik 698bcb8
Update with allowing connection from safe locations
igorpecovnik File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 | ||
``` |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 | ||
} |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.