Initial curated DockDeck source from 26772208f608782e88c736dc70878e7b5abd3916
This commit is contained in:
Public Source Publisher committed
commit
3c61fba98f
146 files changed
+45229
No files matched your search
@@ -0,0 +1,34 @@
|
||||
<?xml version="1.0"?>
|
||||
<Container version="2">
|
||||
<Name>DockDeck</Name>
|
||||
<Repository>dockdeck:local</Repository>
|
||||
<Network>bridge</Network>
|
||||
<Shell>sh</Shell>
|
||||
<Privileged>false</Privileged>
|
||||
<Support>https://gitea.itworx.tech/Jens/DockDeck-Public/issues</Support>
|
||||
<Project>https://gitea.itworx.tech/Jens/DockDeck-Public</Project>
|
||||
<Overview>DockDeck is a premium, read-only personal start dashboard for Unraid. This single-container profile uses the existing AppOps inventory API and never mounts the Docker socket.</Overview>
|
||||
<Category>Tools:Status:</Category>
|
||||
<WebUI>http://[IP]:[PORT:1218]</WebUI>
|
||||
<Icon>http://[IP]:[PORT:1218]/itworx-app-icon.png</Icon>
|
||||
<ExtraParams>--read-only --security-opt=no-new-privileges:true</ExtraParams>
|
||||
<PostArgs/>
|
||||
<CPUset/>
|
||||
<DateInstalled/>
|
||||
<DonateText/>
|
||||
<DonateLink/>
|
||||
<Requires>A read-only AppOps endpoint and an operator password hash generated with the included helper.</Requires>
|
||||
<Config Name="WebUI" Target="3000" Default="1218" Mode="tcp" Description="DockDeck WebUI" Type="Port" Display="always" Required="true" Mask="false">1218</Config>
|
||||
<Config Name="App data" Target="/data" Default="/path/to/dockdeck/data" Mode="rw" Description="Persistent database and integration settings" Type="Path" Display="always" Required="true" Mask="false">/path/to/dockdeck/data</Config>
|
||||
<Config Name="Template metadata" Target="/unraid-templates" Default="/path/to/sanitized/unraid-templates" Mode="ro" Description="Sanitized Unraid template metadata" Type="Path" Display="advanced" Required="true" Mask="false">/path/to/sanitized/unraid-templates</Config>
|
||||
<Config Name="Unraid runtime" Target="/unraid-runtime" Default="/var/local/emhttp" Mode="ro" Description="Read-only array and parity status" Type="Path" Display="advanced" Required="true" Mask="false">/var/local/emhttp</Config>
|
||||
<Config Name="Hardware sensors" Target="/host-hwmon" Default="/sys/class/hwmon" Mode="ro" Description="Read-only host temperature sensors" Type="Path" Display="advanced" Required="true" Mask="false">/sys/class/hwmon</Config>
|
||||
<Config Name="CPU information" Target="/host-proc/cpuinfo" Default="/proc/cpuinfo" Mode="ro" Description="Read-only host CPU capacity" Type="Path" Display="advanced" Required="true" Mask="false">/proc/cpuinfo</Config>
|
||||
<Config Name="Memory information" Target="/host-proc/meminfo" Default="/proc/meminfo" Mode="ro" Description="Read-only host memory capacity" Type="Path" Display="advanced" Required="true" Mask="false">/proc/meminfo</Config>
|
||||
<Config Name="Integration settings file" Target="INTEGRATION_ENV_PATH" Default="/data/integrations.env" Mode="" Description="Persistent server-side integration settings" Type="Variable" Display="advanced" Required="true" Mask="false">/data/integrations.env</Config>
|
||||
<Config Name="Operator username" Target="DOCKDECK_OPERATOR_USER" Default="operator" Mode="" Description="Required login name for every route except health" Type="Variable" Display="always" Required="true" Mask="false">operator</Config>
|
||||
<Config Name="Operator password hash" Target="DOCKDECK_OPERATOR_PASSWORD_HASH" Default="" Mode="" Description="Required salt:hash value from scripts/hash-operator-password.mjs; never enter plaintext" Type="Variable" Display="always" Required="true" Mask="true"></Config>
|
||||
<Config Name="AppOps URL" Target="APPOPS_URL" Default="http://appops.local:1216" Mode="" Description="Read-only inventory API URL" Type="Variable" Display="always" Required="true" Mask="false">http://appops.local:1216</Config>
|
||||
<Config Name="Unraid host" Target="UNRAID_HOST" Default="host.local" Mode="" Description="Unraid hostname or LAN address" Type="Variable" Display="always" Required="true" Mask="false">host.local</Config>
|
||||
<Config Name="Unraid URL" Target="UNRAID_URL" Default="http://host.local" Mode="" Description="Unraid WebUI address" Type="Variable" Display="always" Required="true" Mask="false">http://host.local</Config>
|
||||
</Container>
|
||||
@@ -0,0 +1,48 @@
|
||||
#!/bin/sh
|
||||
|
||||
set -eu
|
||||
|
||||
container_name="${1:-DockDeck}"
|
||||
icon_url="${2:-}"
|
||||
template_path="/boot/config/plugins/dockerMan/templates-user/my-${container_name}.xml"
|
||||
persistent_dir="/var/lib/docker/unraid/images"
|
||||
runtime_dir="/usr/local/emhttp/state/plugins/dynamix.docker.manager/images"
|
||||
|
||||
fail() {
|
||||
printf 'DockDeck icon refresh failed: %s\n' "$1" >&2
|
||||
exit 1
|
||||
}
|
||||
|
||||
[ "$(id -u)" -eq 0 ] || fail "run this helper as root on the Unraid host"
|
||||
|
||||
case "$container_name" in
|
||||
"" | *[!A-Za-z0-9_.-]*) fail "invalid container name" ;;
|
||||
esac
|
||||
|
||||
if [ -z "$icon_url" ] && [ -f "$template_path" ]; then
|
||||
icon_url="$(sed -n 's#.*<Icon>\(.*\)</Icon>.*#\1#p' "$template_path" | head -n 1)"
|
||||
fi
|
||||
|
||||
case "$icon_url" in
|
||||
http://* | https://*) ;;
|
||||
*) fail "provide an HTTP(S) icon URL or a user template containing <Icon>" ;;
|
||||
esac
|
||||
|
||||
temporary_icon="$(mktemp /tmp/dockdeck-icon.XXXXXX)"
|
||||
trap 'rm -f "$temporary_icon"' EXIT HUP INT TERM
|
||||
|
||||
curl --fail --silent --show-error --location \
|
||||
--connect-timeout 5 --max-time 20 \
|
||||
"$icon_url" --output "$temporary_icon"
|
||||
|
||||
[ "$(file -b --mime-type "$temporary_icon")" = "image/png" ] || \
|
||||
fail "the downloaded asset is not a real PNG"
|
||||
|
||||
mkdir -p "$persistent_dir" "$runtime_dir"
|
||||
install -m 0644 -o root -g root \
|
||||
"$temporary_icon" "$persistent_dir/${container_name}-icon.png"
|
||||
install -m 0644 -o root -g root \
|
||||
"$temporary_icon" "$runtime_dir/${container_name}-icon.png"
|
||||
|
||||
printf 'Refreshed both Unraid icon caches for %s from %s\n' \
|
||||
"$container_name" "$icon_url"
|
||||
@@ -0,0 +1,61 @@
|
||||
#!/usr/bin/env python3
|
||||
"""Copy only non-sensitive DockDeck metadata from Unraid templates."""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
import argparse
|
||||
from pathlib import Path
|
||||
import xml.etree.ElementTree as ET
|
||||
|
||||
|
||||
ALLOWED_FIELDS = ("Name", "WebUI", "Icon")
|
||||
|
||||
|
||||
def sanitize(source_dir: Path, destination_dir: Path) -> int:
|
||||
destination_dir.mkdir(parents=True, exist_ok=True)
|
||||
written = 0
|
||||
|
||||
for source in sorted(source_dir.glob("*.xml")):
|
||||
try:
|
||||
root = ET.parse(source).getroot()
|
||||
except (ET.ParseError, OSError):
|
||||
continue
|
||||
|
||||
output = ET.Element("Container")
|
||||
for field in ALLOWED_FIELDS:
|
||||
value = root.findtext(field)
|
||||
if value:
|
||||
ET.SubElement(output, field).text = value.strip()
|
||||
|
||||
if output.findtext("Name"):
|
||||
destination = destination_dir / source.name
|
||||
ET.ElementTree(output).write(
|
||||
destination,
|
||||
encoding="utf-8",
|
||||
xml_declaration=True,
|
||||
)
|
||||
destination.chmod(0o644)
|
||||
written_tags = {
|
||||
child.tag for child in ET.parse(destination).getroot()
|
||||
}
|
||||
if not written_tags.issubset(ALLOWED_FIELDS):
|
||||
destination.unlink(missing_ok=True)
|
||||
raise RuntimeError(
|
||||
f"Unexpected field in sanitized template: {source.name}"
|
||||
)
|
||||
written += 1
|
||||
|
||||
return written
|
||||
|
||||
|
||||
def main() -> None:
|
||||
parser = argparse.ArgumentParser()
|
||||
parser.add_argument("source", type=Path)
|
||||
parser.add_argument("destination", type=Path)
|
||||
args = parser.parse_args()
|
||||
count = sanitize(args.source, args.destination)
|
||||
print(f"Sanitized and verified {count} Unraid templates")
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
main()
|
||||
Reference in new issue
Block a user