feat(hosting): getlibreportal as a first-class LibrePortal app (phase E)
Redo the download/website host as a normal app under containers/ (dogfooded — the
project hosts its own downloads on LibrePortal), instead of the bespoke repo-root
thing. Modeled on speedtest: standard getlibreportal.{config,sh,svg} +
docker-compose.yml (tagged template) so it plugs into the app scan + install
dispatch (installGetlibreportal) like every other app. nginx serves ./data (the
app data dir) — no special /web.
- getlibreportal.config: features category, public (login=false — it's a download
host), no backup (regenerable), healthcheck on.
- docker-compose.yml: nginx:alpine, ./data:ro docroot + ./nginx.conf, traefik tags.
- nginx.conf: install.sh + latest.json no-cache; tarball/.sha256/.minisig immutable.
- publish.sh: assembles the docroot (built site + install.sh + dist/<channel>) into
a target data dir; run on a full repo checkout (site/ + dist/ are host-side).
- exec bits set on the run-directly scripts (make_release.sh, install.sh, publish.sh).
- .gitattributes: dropped the stray 'getlibreportal export-ignore' (the no-slash
pattern would also have excluded containers/getlibreportal — the app must ship);
data/ gitignored.
Verified: app discovered by the site catalog (32 apps), installGetlibreportal matches
the dispatch name, and the full release->publish flow yields a docroot with the
website + install.sh + the signed/checksummed stable channel. The actual app-install
run + DNS/TLS for get.libreportal.org are operational steps (need a real host).
Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
Signed-off-by: librelad <librelad@digitalangels.vip>
This commit is contained in:
librelad
parent
b9daae36e6
commit
63b53c7751
3
.gitignore
vendored
3
.gitignore
vendored
@ -13,3 +13,6 @@ npm-debug.log*
|
||||
|
||||
# Release build output (scripts/release/make_release.sh).
|
||||
/dist/
|
||||
|
||||
# getlibreportal assembled docroot (built by containers/getlibreportal/publish.sh).
|
||||
containers/getlibreportal/data/
|
||||
|
||||
41
containers/getlibreportal/docker-compose.yml
Normal file
41
containers/getlibreportal/docker-compose.yml
Normal file
@ -0,0 +1,41 @@
|
||||
networks:
|
||||
DOCKER_NETWORK_DATA: #LIBREPORTAL|DOCKER_NETWORK_TAG|DOCKER_NETWORK_DATA
|
||||
external: true
|
||||
|
||||
services:
|
||||
getlibreportal-service: #LIBREPORTAL|SERVICE_TAG_1|getlibreportal-service
|
||||
container_name: getlibreportal-service
|
||||
image: nginx:alpine
|
||||
restart: unless-stopped
|
||||
hostname: getlibreportal
|
||||
# ./data is the docroot (website + install.sh + release channels), assembled
|
||||
# by publish.sh. Read-only into nginx. ./nginx.conf sets content-types/caching.
|
||||
volumes:
|
||||
- ./data:/usr/share/nginx/html:ro
|
||||
- ./nginx.conf:/etc/nginx/conf.d/default.conf:ro
|
||||
# GLUETUN_OFF_BEGIN
|
||||
ports:
|
||||
- "PORTS_DATA_1" #LIBREPORTAL|PORTS_TAG_1|PORTS_DATA_1
|
||||
# GLUETUN_OFF_END
|
||||
labels:
|
||||
libreportal.category: "CATEGORY_DATA" #LIBREPORTAL|CATEGORY_TAG|CATEGORY_DATA
|
||||
libreportal.title: "TITLE_DATA" #LIBREPORTAL|TITLE_TAG|TITLE_DATA
|
||||
traefik.enable: TRAEFIK_ENABLE_DATA #LIBREPORTAL|TRAEFIK_ENABLE_TAG|TRAEFIK_ENABLE_DATA
|
||||
# TRAEFIK_PORT_1_BEGIN
|
||||
traefik.http.routers.getlibreportal-service.entrypoints: web,websecure
|
||||
traefik.http.routers.getlibreportal-service.rule: Host(`DOMAINSUBNAME_DATA_1`) #LIBREPORTAL|DOMAINSUBNAME_TAG_1|DOMAINSUBNAME_DATA_1
|
||||
traefik.http.routers.getlibreportal-service.tls: true
|
||||
traefik.http.routers.getlibreportal-service.tls.certresolver: production
|
||||
traefik.http.services.getlibreportal-service.loadbalancer.server.port: PORT_INTERNAL_DATA_1 #LIBREPORTAL|PORT_INTERNAL_TAG_1|PORT_INTERNAL_DATA_1
|
||||
traefik.http.routers.getlibreportal-service.middlewares: MIDDLEWARE_DATA_1 #LIBREPORTAL|MIDDLEWARE_TAG_1|MIDDLEWARE_DATA_1
|
||||
# TRAEFIK_PORT_1_END
|
||||
healthcheck:
|
||||
disable: HEALTHCHECK_DATA #LIBREPORTAL|HEALTHCHECK_TAG|HEALTHCHECK_DATA
|
||||
# GLUETUN_OFF_BEGIN
|
||||
networks:
|
||||
DOCKER_NETWORK_DATA: #LIBREPORTAL|DOCKER_NETWORK_TAG|DOCKER_NETWORK_DATA
|
||||
ipv4_address: IP_DATA_1 #LIBREPORTAL|IP_TAG_1|IP_DATA_1
|
||||
# GLUETUN_OFF_END
|
||||
# GLUETUN_ON_BEGIN
|
||||
# network_mode: "container:gluetun-service"
|
||||
# GLUETUN_ON_END
|
||||
46
containers/getlibreportal/getlibreportal.config
Normal file
46
containers/getlibreportal/getlibreportal.config
Normal file
@ -0,0 +1,46 @@
|
||||
#
|
||||
# =============================================================================
|
||||
# GENERAL CONFIGURATION
|
||||
# =============================================================================
|
||||
# APP_NAME = name of application for use in scripts
|
||||
# COMPOSE_FILE = default for no app_name in docker-compose file name, app if there is
|
||||
# BACKUP = if true, include this application in backup operations
|
||||
# HEALTHCHECK = if true, default docker health checks for that container will be enabled
|
||||
# AUTHELIA = if true, use Authelia authentication, if false turned off.
|
||||
# HEADSCALE = options : false, local, remote (see general config). e.g false or local,remote
|
||||
#
|
||||
CFG_GETLIBREPORTAL_APP_NAME=getlibreportal
|
||||
CFG_GETLIBREPORTAL_BACKUP=false
|
||||
CFG_GETLIBREPORTAL_BACKUP_STRATEGY=auto
|
||||
CFG_GETLIBREPORTAL_COMPOSE_FILE=default
|
||||
CFG_GETLIBREPORTAL_HEALTHCHECK=true
|
||||
CFG_GETLIBREPORTAL_AUTHELIA=false
|
||||
CFG_GETLIBREPORTAL_HEADSCALE=false
|
||||
#
|
||||
# =============================================================================
|
||||
# METADATA
|
||||
# =============================================================================
|
||||
CFG_GETLIBREPORTAL_CATEGORY="features"
|
||||
CFG_GETLIBREPORTAL_TITLE="LibrePortal Downloads"
|
||||
CFG_GETLIBREPORTAL_DESCRIPTION="Website + signed-release host"
|
||||
CFG_GETLIBREPORTAL_LONG_DESCRIPTION="Serves the LibrePortal website, the install.sh bootstrap, and signed/checksummed release artifacts — i.e. the get.libreportal.org host. Populate its docroot with containers/getlibreportal/publish.sh."
|
||||
CFG_GETLIBREPORTAL_URL="https://get.libreportal.org"
|
||||
CFG_GETLIBREPORTAL_ACTIONS="configure|install|restart|shutdown|uninstall"
|
||||
#
|
||||
# =============================================================================
|
||||
# NETWORK CONFIGURATION
|
||||
# =============================================================================
|
||||
# DOMAIN = number of domain from the general config, useful when using multiple domains
|
||||
# WHITELIST = if true only allow whitelisted ips on traefik, if false allow all
|
||||
#
|
||||
CFG_GETLIBREPORTAL_DOMAIN=1
|
||||
CFG_GETLIBREPORTAL_WHITELIST=false
|
||||
CFG_GETLIBREPORTAL_NETWORK=default
|
||||
#
|
||||
# =============================================================================
|
||||
# PORT CONFIGURATION
|
||||
# =============================================================================
|
||||
# PORT_ = app|name|external:internal|access|protocol|login|traefik|webui|title|path|slug
|
||||
# login MUST stay false — this is a public download host (no basic-auth).
|
||||
#
|
||||
CFG_GETLIBREPORTAL_PORT_1="getlibreportal-service|webui|random:80|public|tcp|false|true|true|Downloads|/|getlibreportal"
|
||||
108
containers/getlibreportal/getlibreportal.sh
Normal file
108
containers/getlibreportal/getlibreportal.sh
Normal file
@ -0,0 +1,108 @@
|
||||
#!/bin/bash
|
||||
|
||||
# Category : Features
|
||||
# Description : getlibreportal - Website + signed-release host (c/u/s/r/i):
|
||||
|
||||
installGetlibreportal()
|
||||
{
|
||||
local config_variables="$1"
|
||||
|
||||
if [[ "$getlibreportal" == *[cCtTuUsSrRiI]* ]]; then
|
||||
dockerConfigSetupToContainer silent getlibreportal;
|
||||
local app_name=$CFG_GETLIBREPORTAL_APP_NAME
|
||||
initializeAppVariables $app_name;
|
||||
fi
|
||||
|
||||
if [[ "$getlibreportal" == *[cC]* ]]; then
|
||||
editAppConfig $app_name;
|
||||
fi
|
||||
|
||||
if [[ "$getlibreportal" == *[uU]* ]]; then
|
||||
dockerUninstallApp $app_name;
|
||||
fi
|
||||
|
||||
if [[ "$getlibreportal" == *[sS]* ]]; then
|
||||
dockerComposeDown $app_name;
|
||||
fi
|
||||
|
||||
if [[ "$getlibreportal" == *[rR]* ]]; then
|
||||
dockerComposeRestart $app_name;
|
||||
fi
|
||||
|
||||
if [[ "$getlibreportal" == *[iI]* ]]; then
|
||||
isHeader "Install $app_name"
|
||||
|
||||
((menu_number++))
|
||||
echo ""
|
||||
echo "---- $menu_number. Setting up install folder and config file for $app_name."
|
||||
echo ""
|
||||
|
||||
dockerConfigSetupToContainer "loud" "$app_name" "install" "$config_variables";
|
||||
isSuccessful "Install folders and Config files have been setup for $app_name."
|
||||
|
||||
((menu_number++))
|
||||
echo ""
|
||||
echo "---- $menu_number. Setting up the $app_name docker-compose.yml file."
|
||||
echo ""
|
||||
|
||||
dockerComposeSetupFile $app_name;
|
||||
|
||||
((menu_number++))
|
||||
echo ""
|
||||
echo "---- $menu_number. Updating file permissions before starting."
|
||||
echo ""
|
||||
|
||||
fixPermissionsBeforeStart $app_name;
|
||||
|
||||
((menu_number++))
|
||||
echo ""
|
||||
echo "---- $menu_number. Running the docker-compose.yml to install and start $app_name"
|
||||
echo ""
|
||||
|
||||
dockerComposeUpdateAndStartApp $app_name install;
|
||||
|
||||
((menu_number++))
|
||||
echo ""
|
||||
echo "---- $menu_number. Running Application specific updates (if required)"
|
||||
echo ""
|
||||
|
||||
appUpdateSpecifics $app_name;
|
||||
|
||||
((menu_number++))
|
||||
echo ""
|
||||
echo "---- $menu_number. Running Headscale setup (if required)"
|
||||
echo ""
|
||||
|
||||
setupHeadscale $app_name;
|
||||
|
||||
((menu_number++))
|
||||
echo ""
|
||||
echo "---- $menu_number. Adding $app_name to the Apps Database table."
|
||||
echo ""
|
||||
|
||||
databaseInstallApp $app_name;
|
||||
|
||||
((menu_number++))
|
||||
echo ""
|
||||
echo "---- $menu_number. Updating WebUI config file."
|
||||
echo ""
|
||||
|
||||
webuiContainerSetup $app_name install;
|
||||
|
||||
((menu_number++))
|
||||
echo ""
|
||||
echo "---- $menu_number. Populate the docroot, then browse $app_name."
|
||||
echo ""
|
||||
echo " The container serves an EMPTY docroot until you publish content."
|
||||
echo " From a full repo checkout (build/release machine) run:"
|
||||
echo " containers/getlibreportal/publish.sh $containers_dir$app_name/data"
|
||||
echo " (builds the site + copies install.sh + the dist/<channel> releases)."
|
||||
echo ""
|
||||
|
||||
menuShowFinalMessages $app_name;
|
||||
|
||||
menu_number=0
|
||||
cd
|
||||
fi
|
||||
getlibreportal=n
|
||||
}
|
||||
5
containers/getlibreportal/getlibreportal.svg
Normal file
5
containers/getlibreportal/getlibreportal.svg
Normal file
@ -0,0 +1,5 @@
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="1.8" stroke-linecap="round" stroke-linejoin="round">
|
||||
<path d="M7 18a4 4 0 0 1-.5-7.97A5.5 5.5 0 0 1 17 9.5a3.5 3.5 0 0 1 .5 7"/>
|
||||
<path d="M12 11v6"/>
|
||||
<path d="m9 14 3 3 3-3"/>
|
||||
</svg>
|
||||
|
After Width: | Height: | Size: 297 B |
27
containers/getlibreportal/nginx.conf
Normal file
27
containers/getlibreportal/nginx.conf
Normal file
@ -0,0 +1,27 @@
|
||||
server {
|
||||
listen 80;
|
||||
server_name _;
|
||||
root /usr/share/nginx/html;
|
||||
index index.html;
|
||||
|
||||
# The bootstrap installer: served as a shell script, never cached, so
|
||||
# `curl … | sudo bash` always gets the current one.
|
||||
location = /install.sh {
|
||||
default_type text/x-shellscript;
|
||||
add_header Cache-Control "no-cache, must-revalidate";
|
||||
}
|
||||
|
||||
# Channel manifests change every release — don't cache.
|
||||
location ~ /latest\.json$ {
|
||||
default_type application/json;
|
||||
add_header Cache-Control "no-cache, must-revalidate";
|
||||
}
|
||||
|
||||
# Release artifacts are immutable (version-pinned names) — cache hard.
|
||||
location ~ \.tar\.gz$ { default_type application/gzip; add_header Cache-Control "public, max-age=31536000, immutable"; }
|
||||
location ~ \.sha256$ { default_type text/plain; add_header Cache-Control "public, max-age=31536000, immutable"; }
|
||||
location ~ \.minisig$ { default_type text/plain; add_header Cache-Control "public, max-age=31536000, immutable"; }
|
||||
|
||||
# The static website.
|
||||
location / { try_files $uri $uri/ =404; }
|
||||
}
|
||||
51
containers/getlibreportal/publish.sh
Normal file
51
containers/getlibreportal/publish.sh
Normal file
@ -0,0 +1,51 @@
|
||||
#!/usr/bin/env bash
|
||||
#
|
||||
# Assemble the getlibreportal docroot — the website + install.sh + release
|
||||
# channels — into the served data dir. Run on a FULL repo checkout (build/release
|
||||
# machine), since it needs ../../site and ../../dist (both export-ignored, i.e.
|
||||
# not in release tarballs).
|
||||
#
|
||||
# Usage: publish.sh [TARGET_DIR]
|
||||
# TARGET_DIR defaults to ./data (next to this script). On a host where the app
|
||||
# is installed, pass its live data dir, e.g.:
|
||||
# containers/getlibreportal/publish.sh /libreportal-containers/getlibreportal/data
|
||||
#
|
||||
# Layout produced:
|
||||
# <target>/ ← built website (repo: site/)
|
||||
# <target>/install.sh ← bootstrap installer (repo: install.sh)
|
||||
# <target>/<channel>/… ← release manifests + tarballs (repo: dist/<channel>/)
|
||||
set -euo pipefail
|
||||
|
||||
HERE="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
|
||||
ROOT="$(cd "$HERE/../.." && pwd)" # repo root (containers/getlibreportal -> ../../)
|
||||
TARGET="${1:-$HERE/data}"
|
||||
|
||||
echo "Assembling getlibreportal docroot -> $TARGET"
|
||||
mkdir -p "$TARGET"
|
||||
# Clean only the things we manage (keep the dir itself / its mount).
|
||||
rm -rf "${TARGET:?}"/* "${TARGET:?}"/.??* 2>/dev/null || true
|
||||
|
||||
# 1. Website (optional — skip cleanly without the toolchain).
|
||||
if [[ -d "$ROOT/site" ]] && command -v npm >/dev/null 2>&1; then
|
||||
( cd "$ROOT/site" && npm install --silent && npm run build )
|
||||
cp -a "$ROOT/site/dist/." "$TARGET/" 2>/dev/null || true
|
||||
echo " ✓ website"
|
||||
else
|
||||
echo " ! site build skipped (no site/ or no npm) — install.sh + releases still published"
|
||||
fi
|
||||
|
||||
# 2. Bootstrap installer.
|
||||
if [[ -f "$ROOT/install.sh" ]]; then cp -f "$ROOT/install.sh" "$TARGET/install.sh"; echo " ✓ install.sh"; fi
|
||||
|
||||
# 3. Release channels (from scripts/release/make_release.sh).
|
||||
if [[ -d "$ROOT/dist" ]]; then
|
||||
for ch in "$ROOT/dist"/*/; do
|
||||
[[ -d "$ch" ]] || continue
|
||||
n="$(basename "$ch")"; mkdir -p "$TARGET/$n"; cp -f "$ch"/* "$TARGET/$n/" 2>/dev/null || true
|
||||
echo " ✓ channel $n"
|
||||
done
|
||||
else
|
||||
echo " ! no dist/ — run scripts/release/make_release.sh first"
|
||||
fi
|
||||
|
||||
echo "Done. Restart the container to serve it."
|
||||
Loading…
x
Reference in New Issue
Block a user