mirror of
https://github.com/MacRimi/ProxMenux.git
synced 2026-09-29 18:16:43 +00:00
MacRimiandClaude Opus 5
bcabcb618c
Adds the OCI manager: an engine that turns a Docker Compose file into an LXC definition, a catalog of 365 applications drawn from LinuxServer.io and other container image sources, and a per-instance registry recording what each container was built from. Reachable from the main menu. Catalog text is translated like every other string in the project: the taglines go through translate() and land in lang/*.json, so the entries read in all eight languages instead of only English. Translation cache builder: - a failed translation leaves the key absent rather than writing English, which previously made the string count as translated forever - a result identical to a 3+ word source is rejected, catching a provider that silently returns the text it was given - strings that are nothing but glossary terms keep their source spelling instead of being discarded as failures - no backoff between attempts when the provider is deterministic - application names are protected so "HAOS One" survives translation - argos joins the provider list, and the workflow reads the OCI sources Audit & Report: - findings that moved in the wrong direction between runs are reported alongside the ones that improved - an accepted risk can carry a review date and is flagged when it falls due - backup checks explain in plain language what they looked at and what to do next Monitor: - disks can be excluded from periodic reads, and an idle disk says so instead of showing a stale temperature - per-disk identity survives a controller or enclosure change - scheduled Borg backups resolve their SSH key from the repository entry - PVE upgrades log the package list and the resulting dpkg changes The web build no longer copies scripts/ into public/: the documentation links to GitHub, so nothing read that folder. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
510 lines
20 KiB
JSON
510 lines
20 KiB
JSON
{
|
|
"schema_version": "0.5.0",
|
|
"kind": "proxmenux.oci-template",
|
|
"id": "image-wg-easy",
|
|
"status": "laboratory-validated",
|
|
"catalog_ui": {
|
|
"title": {
|
|
"en_US": "WireGuard Easy"
|
|
},
|
|
"tagline": {
|
|
"en_US": "WEB UI to manage WireGuard VPN."
|
|
},
|
|
"description": {
|
|
"en_US": "You have found the easiest way to install & manage WireGuard on any Linux host!"
|
|
},
|
|
"category": "network",
|
|
"category_label": "Network & Firewall",
|
|
"author": "WeejeWel",
|
|
"developer": "WeejeWel",
|
|
"icon": null,
|
|
"thumbnail": null,
|
|
"screenshots": [],
|
|
"architectures": [
|
|
"amd64",
|
|
"arm64"
|
|
],
|
|
"launch": {
|
|
"scheme": "http",
|
|
"port": 51821,
|
|
"path": "/"
|
|
},
|
|
"website": "",
|
|
"documentation": null,
|
|
"repository": "https://ghcr.io/wg-easy/wg-easy",
|
|
"tips": [],
|
|
"mini_changelog": [],
|
|
"display_version": null,
|
|
"updated_at": null
|
|
},
|
|
"source": {
|
|
"provider": "official",
|
|
"repository": "https://ghcr.io/wg-easy/wg-easy",
|
|
"revision": "74665acad9d4730afa34d5ff4890702c94e8b9a39b366b544174b3b765d76f07",
|
|
"image_repository_url": "https://ghcr.io/wg-easy/wg-easy",
|
|
"readme_pushed_at": "2026-09-11T10:43:22Z",
|
|
"compose_sha256": "74665acad9d4730afa34d5ff4890702c94e8b9a39b366b544174b3b765d76f07",
|
|
"generated_at": "2026-09-13T15:58:29+00:00"
|
|
},
|
|
"container_contract": {
|
|
"service_name": "wg-easy",
|
|
"container_name": "wg-easy",
|
|
"image": {
|
|
"reference": "ghcr.io/wg-easy/wg-easy:latest",
|
|
"registry": "ghcr.io",
|
|
"repository": "ghcr.io/wg-easy/wg-easy",
|
|
"tag": "latest",
|
|
"digest": null,
|
|
"pull_policy": "resolve-selected-tag-to-architecture-digest-at-install"
|
|
},
|
|
"environment": [
|
|
{
|
|
"name": "PASSWORD",
|
|
"example": "${GENERATED_PASSWORD}",
|
|
"required": true,
|
|
"sensitive": true,
|
|
"source": "docker-compose"
|
|
},
|
|
{
|
|
"name": "WG_HOST",
|
|
"example": "wg-easy.local",
|
|
"required": true,
|
|
"sensitive": false,
|
|
"source": "docker-compose"
|
|
},
|
|
{
|
|
"name": "WG_PORT",
|
|
"example": "51820",
|
|
"required": true,
|
|
"sensitive": false,
|
|
"source": "docker-compose"
|
|
},
|
|
{
|
|
"name": "WG_DEFAULT_DNS",
|
|
"example": "1.1.1.1",
|
|
"required": true,
|
|
"sensitive": false,
|
|
"source": "docker-compose"
|
|
}
|
|
],
|
|
"volumes": [
|
|
{
|
|
"id": "volume-0",
|
|
"container_path": "/etc/wireguard",
|
|
"compose_source_example": "/DATA/AppData/$AppID/wireguard",
|
|
"read_only": false,
|
|
"required": true,
|
|
"installation_choice": [
|
|
"managed-volume",
|
|
"host-bind"
|
|
],
|
|
"default": "managed-volume",
|
|
"managed_volume": {
|
|
"backup": true,
|
|
"default_size_gb": 8
|
|
}
|
|
}
|
|
],
|
|
"ports": [
|
|
{
|
|
"container_port": 51820,
|
|
"published_example": 51820,
|
|
"protocol": "udp",
|
|
"required": true,
|
|
"proxmox_behavior": "listener-on-dedicated-lxc-address-no-nat"
|
|
},
|
|
{
|
|
"container_port": 51821,
|
|
"published_example": 51821,
|
|
"protocol": "tcp",
|
|
"required": true,
|
|
"proxmox_behavior": "listener-on-dedicated-lxc-address-no-nat"
|
|
}
|
|
],
|
|
"related_services": [],
|
|
"restart": "unless-stopped",
|
|
"stop_grace_period": null,
|
|
"original_compose": "name: wg-easy\nservices:\n wg-easy:\n image: ghcr.io/wg-easy/wg-easy:latest\n restart: unless-stopped\n network_mode: bridge\n environment:\n PASSWORD: ${GENERATED_PASSWORD}\n WG_HOST: wg-easy.local\n WG_PORT: '51820'\n WG_DEFAULT_DNS: 1.1.1.1\n ports:\n - target: 51820\n published: '51820'\n protocol: udp\n - target: 51821\n published: '51821'\n protocol: tcp\n volumes:\n - type: bind\n source: /DATA/AppData/$AppID/wireguard\n target: /etc/wireguard\n cap_add:\n - NET_ADMIN\n - SYS_MODULE\n sysctls:\n - net.ipv4.ip_forward=1\n - net.ipv4.conf.all.src_valid_mark=1\n container_name: wg-easy\n"
|
|
},
|
|
"compose_stack": {
|
|
"project_name": "wg-easy",
|
|
"deployment_model": "one-native-oci-lxc-per-compose-service",
|
|
"user_experience": "single-application-install",
|
|
"main_service": "wg-easy",
|
|
"service_count": 1,
|
|
"services": [
|
|
{
|
|
"name": "wg-easy",
|
|
"image": "ghcr.io/wg-easy/wg-easy:latest",
|
|
"is_main": true,
|
|
"role": "frontend",
|
|
"vmid_offset": 0,
|
|
"depends_on": [],
|
|
"frontend_network": true,
|
|
"private_network": false,
|
|
"compose": {
|
|
"image": "ghcr.io/wg-easy/wg-easy:latest",
|
|
"restart": "unless-stopped",
|
|
"network_mode": "bridge",
|
|
"environment": {
|
|
"PASSWORD": "${GENERATED_PASSWORD}",
|
|
"WG_HOST": "wg-easy.local",
|
|
"WG_PORT": "51820",
|
|
"WG_DEFAULT_DNS": "1.1.1.1"
|
|
},
|
|
"ports": [
|
|
{
|
|
"target": 51820,
|
|
"published": "51820",
|
|
"protocol": "udp"
|
|
},
|
|
{
|
|
"target": 51821,
|
|
"published": "51821",
|
|
"protocol": "tcp"
|
|
}
|
|
],
|
|
"volumes": [
|
|
{
|
|
"type": "bind",
|
|
"source": "/DATA/AppData/$AppID/wireguard",
|
|
"target": "/etc/wireguard"
|
|
}
|
|
],
|
|
"cap_add": [
|
|
"NET_ADMIN",
|
|
"SYS_MODULE"
|
|
],
|
|
"sysctls": [
|
|
"net.ipv4.ip_forward=1",
|
|
"net.ipv4.conf.all.src_valid_mark=1"
|
|
],
|
|
"container_name": "wg-easy"
|
|
}
|
|
}
|
|
],
|
|
"top_level": {
|
|
"name": "wg-easy"
|
|
},
|
|
"networking": {
|
|
"frontend": "selected-proxmox-bridge",
|
|
"private_required": false,
|
|
"private_creation": "automatic-create-if-missing",
|
|
"private_address_allocation": "automatic-static-address-per-service",
|
|
"service_discovery": "private-addresses-with-compose-service-host-aliases",
|
|
"dependency_external_access": "disabled-unless-service-publishes-ports",
|
|
"prompt_user_for_private_network": false
|
|
},
|
|
"storage": [
|
|
{
|
|
"id": "wg-easy-volume-0",
|
|
"service": "wg-easy",
|
|
"container_path": "/etc/wireguard",
|
|
"mode": "managed-volume",
|
|
"user_selectable": false,
|
|
"backup": true,
|
|
"shared_with_other_lxc": false,
|
|
"source_path": null,
|
|
"source_path_prompt": null
|
|
}
|
|
],
|
|
"orchestration": {
|
|
"reserve_vmids_atomically": 1,
|
|
"start_order": [
|
|
"wg-easy"
|
|
],
|
|
"stop_order": [
|
|
"wg-easy"
|
|
],
|
|
"dependency_readiness": "compose-healthcheck-then-port-or-process-fallback",
|
|
"rollback_on_failure": "remove-new-rootfs-preserve-created-persistent-volumes"
|
|
},
|
|
"installer_inputs": {
|
|
"prompted": [
|
|
"stack_name",
|
|
"base_vmid",
|
|
"rootfs_storage",
|
|
"persistent_data_destinations",
|
|
"frontend_bridge",
|
|
"frontend_ipv4_mode"
|
|
],
|
|
"automatic": [
|
|
"dependent_vmids",
|
|
"private_bridge",
|
|
"private_subnet",
|
|
"private_service_addresses",
|
|
"compose_service_aliases",
|
|
"generated_secrets",
|
|
"dependency_start_and_stop_order"
|
|
],
|
|
"generated_secrets": [
|
|
{
|
|
"id": "password",
|
|
"strategy": "generate-cryptographically-random-at-install",
|
|
"bindings": [
|
|
{
|
|
"service": "wg-easy",
|
|
"environment_variable": "PASSWORD"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"first_run": {
|
|
"endpoints": [
|
|
{
|
|
"label": "Web UI",
|
|
"scheme": "http",
|
|
"port": 51821,
|
|
"path": "/",
|
|
"source": "compose-metadata"
|
|
}
|
|
],
|
|
"credentials": []
|
|
},
|
|
"proxmox": {
|
|
"runtime": "native-oci-lxc",
|
|
"technology_status": "proxmox-technology-preview",
|
|
"defaults": {
|
|
"unprivileged": true,
|
|
"ostype": "auto-from-image",
|
|
"cores": 2,
|
|
"memory_mb": 1024,
|
|
"swap_mb": 512,
|
|
"rootfs_size_gb": 8,
|
|
"rootfs_storage": "local-lvm",
|
|
"volume_storage": "local-lvm",
|
|
"template_storage": "local",
|
|
"bridge": "vmbr0",
|
|
"ipv4": "dhcp",
|
|
"firewall": true,
|
|
"host_managed_network": true,
|
|
"onboot": false,
|
|
"features": [
|
|
"nesting=1"
|
|
],
|
|
"shutdown_timeout_seconds": 30
|
|
},
|
|
"image_metadata_policy": {
|
|
"entrypoint": "import-from-oci-image",
|
|
"cmd": "import-from-oci-image",
|
|
"environment": "import-image-env-then-apply-compose-overrides",
|
|
"user": "import-from-oci-image",
|
|
"working_dir": "import-from-oci-image",
|
|
"stop_signal": "import-from-oci-image"
|
|
},
|
|
"installer_profile": {
|
|
"network": {
|
|
"compose_mode": "bridge"
|
|
},
|
|
"security": {
|
|
"required_capabilities": [
|
|
"NET_ADMIN",
|
|
"SYS_MODULE"
|
|
],
|
|
"host_modules": [
|
|
{
|
|
"name": "wireguard",
|
|
"enable_prompt": "Load and verify the WireGuard module on the Proxmox host",
|
|
"enabled_default": true,
|
|
"required_by_compose": true
|
|
}
|
|
],
|
|
"sysctls": [
|
|
{
|
|
"name": "net.ipv4.ip_forward",
|
|
"value": "1"
|
|
},
|
|
{
|
|
"name": "net.ipv4.conf.all.src_valid_mark",
|
|
"value": "1"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"adaptations": [
|
|
{
|
|
"id": "imported-compose-source",
|
|
"upstream_behavior": "The source definition deploys the complete Docker Compose application model.",
|
|
"native_lxc_behavior": "The source model is preserved and remains blocked until every service option has a reviewed native Proxmox mapping.",
|
|
"reason": "Catalog import must not imply runtime compatibility.",
|
|
"behavioral_impact": "No automatic installation before review.",
|
|
"validation": "pending-per-application"
|
|
},
|
|
{
|
|
"id": "rolling-latest-image",
|
|
"upstream_behavior": "A discovered Compose may pin a release tag or digest.",
|
|
"native_lxc_behavior": "ProxMenux selects the same image repository with the latest tag for catalog installations.",
|
|
"reason": "The automatic catalog intentionally offers rolling latest images; pinned versions belong to the future manual installer.",
|
|
"behavioral_impact": "The installed release can be newer than the discovered Compose revision.",
|
|
"validation": "pending-per-application"
|
|
},
|
|
{
|
|
"id": "dedicated-lxc-network",
|
|
"upstream_behavior": "Docker publishes selected container ports on the Docker host.",
|
|
"native_lxc_behavior": "A reviewed native application will listen on its original container ports at a dedicated LXC address.",
|
|
"reason": "A native LXC has its own address and does not require Docker port NAT.",
|
|
"behavioral_impact": "Published ports are metadata; ProxMenux URLs use the matching container target port.",
|
|
"validation": "pending-per-application"
|
|
},
|
|
{
|
|
"id": "compose-shm-size",
|
|
"upstream_behavior": "Compose sets the size of the container /dev/shm tmpfs.",
|
|
"native_lxc_behavior": "ProxMenux mounts a native LXC tmpfs at /dev/shm with the same requested capacity.",
|
|
"reason": "The OCI image runs directly as an LXC and therefore needs the equivalent Proxmox mount entry.",
|
|
"behavioral_impact": "None expected.",
|
|
"validation": "not-requested-by-compose"
|
|
},
|
|
{
|
|
"id": "compose-command",
|
|
"upstream_behavior": "Compose replaces the image Cmd while retaining its Entrypoint.",
|
|
"native_lxc_behavior": "ProxMenux reads the official OCI Entrypoint and combines it with the Compose command as the native LXC init command.",
|
|
"reason": "Proxmox stores the effective OCI process as one entrypoint string.",
|
|
"behavioral_impact": "None expected.",
|
|
"validation": "not-requested-by-compose"
|
|
},
|
|
{
|
|
"id": "compose-privileged-mode",
|
|
"upstream_behavior": "Compose selects whether the container runs in privileged mode.",
|
|
"native_lxc_behavior": "ProxMenux uses a privileged LXC only after an explicit high-risk confirmation; otherwise it keeps the LXC unprivileged.",
|
|
"reason": "The native OCI-LXC deployment must preserve the requested privilege level without silently weakening isolation.",
|
|
"behavioral_impact": "A privileged LXC has weaker isolation from the Proxmox host.",
|
|
"validation": "native-equivalent"
|
|
},
|
|
{
|
|
"id": "compose-process-runtime",
|
|
"upstream_behavior": "Compose can replace Entrypoint, User and WorkingDir and request an init process or interactive terminal.",
|
|
"native_lxc_behavior": "ProxMenux applies the process overrides through native LXC init directives; lxc-init provides PID 1 supervision and the CT console provides terminal access.",
|
|
"reason": "The OCI process must start with the same identity, command and working directory without Docker.",
|
|
"behavioral_impact": "Compose stdin_open and tty become access through the Proxmox LXC console.",
|
|
"validation": "not-requested-by-compose"
|
|
},
|
|
{
|
|
"id": "compose-healthcheck",
|
|
"upstream_behavior": "Docker periodically executes the declared container healthcheck.",
|
|
"native_lxc_behavior": "For a single-service LXC, ProxMenux translates HTTP localhost checks into a mandatory first-start service check.",
|
|
"reason": "Proxmox has no persistent Docker health state, while the installer still must detect a failed first boot.",
|
|
"behavioral_impact": "The check runs during installation rather than continuously after installation.",
|
|
"validation": "not-requested-by-compose"
|
|
},
|
|
{
|
|
"id": "compose-cpu-priority",
|
|
"upstream_behavior": "Docker cpu_shares sets a relative scheduling weight with 1024 as its neutral value.",
|
|
"native_lxc_behavior": "ProxMenux converts the relative weight to Proxmox cpuunits with 100 as its neutral value and lets the user review it.",
|
|
"reason": "Both settings express relative CPU priority on different scales.",
|
|
"behavioral_impact": "Rounding and Proxmox minimum limits can slightly change very low weights.",
|
|
"validation": "not-requested-by-compose"
|
|
},
|
|
{
|
|
"id": "compose-network-identity",
|
|
"upstream_behavior": "Compose can set hostname, MAC address, extra hosts and attach a service to Docker networks.",
|
|
"native_lxc_behavior": "ProxMenux applies hostname and MAC to net0, writes additional host aliases into the LXC and uses its dedicated bridge connection for single-service networks.",
|
|
"reason": "A dedicated LXC has its own network namespace and does not need a Docker bridge per service.",
|
|
"behavioral_impact": "host-gateway resolves to the IPv4 address of the selected Proxmox bridge.",
|
|
"validation": "not-requested-by-compose"
|
|
},
|
|
{
|
|
"id": "compose-network-mode",
|
|
"upstream_behavior": "Docker host mode removes Docker network isolation; bridge and default use a Docker-managed network.",
|
|
"native_lxc_behavior": "The OCI process uses the dedicated LXC network namespace directly, so host, bridge and default all listen on the LXC address without Docker NAT.",
|
|
"reason": "The LXC is the application host and already has its own address and port namespace.",
|
|
"behavioral_impact": "host means the LXC host, never the Proxmox host; this preserves Proxmox network isolation.",
|
|
"validation": "pending-per-application"
|
|
},
|
|
{
|
|
"id": "compose-capabilities-and-sysctls",
|
|
"upstream_behavior": "Compose can add Linux capabilities and set kernel parameters in the container network namespace.",
|
|
"native_lxc_behavior": "ProxMenux validates requested capabilities against the native LXC capability set and writes namespaced network settings as lxc.sysctl directives.",
|
|
"reason": "A native OCI-LXC already starts with the namespaced capability set; lxc.cap.keep would incorrectly discard unrelated required capabilities.",
|
|
"behavioral_impact": "Host-global capabilities such as SYS_MODULE remain blocked until their host prerequisite is explicitly adapted.",
|
|
"validation": "pending-per-application"
|
|
},
|
|
{
|
|
"id": "docker-engine-metadata",
|
|
"upstream_behavior": "Compose labels annotate Docker objects and the json-file logging driver rotates Docker-managed logs.",
|
|
"native_lxc_behavior": "Labels remain source metadata; Docker json-file settings are not applied because the OCI process runs directly under LXC.",
|
|
"reason": "There is no Docker object or Docker json-file log behind a native OCI-LXC application.",
|
|
"behavioral_impact": "Docker-only label consumers and Docker log-driver rotation do not exist in the native deployment.",
|
|
"validation": "not-requested-by-compose"
|
|
},
|
|
{
|
|
"id": "compose-device-passthrough",
|
|
"upstream_behavior": "Compose passes host character devices or requests an NVIDIA runtime GPU.",
|
|
"native_lxc_behavior": "ProxMenux converts recognized device declarations to native Proxmox dev resources; NVIDIA profiles also inject compatible host driver libraries read-only.",
|
|
"reason": "Native OCI-LXC does not execute Docker device or NVIDIA runtime hooks.",
|
|
"behavioral_impact": "Hardware is exposed only after explicit user confirmation and host-path validation.",
|
|
"validation": "not-requested-by-compose"
|
|
},
|
|
{
|
|
"id": "compose-host-ipc",
|
|
"upstream_behavior": "ipc: host shares the Docker host IPC namespace, commonly to avoid Docker's small default shared-memory allocation.",
|
|
"native_lxc_behavior": "The application keeps the LXC IPC namespace and receives a configurable 1 GiB /dev/shm instead of sharing Proxmox host IPC.",
|
|
"reason": "Processes in a single native LXC already share one IPC namespace; retaining isolation is safer than exposing host IPC.",
|
|
"behavioral_impact": "The application cannot exchange IPC objects with processes on the Proxmox host.",
|
|
"validation": "not-requested-by-compose"
|
|
}
|
|
]
|
|
},
|
|
"compatibility": {
|
|
"automatic_install_candidate": true,
|
|
"validated": false,
|
|
"supported_compose_keys": [
|
|
"cap_add",
|
|
"command",
|
|
"container_name",
|
|
"cpu_shares",
|
|
"deploy",
|
|
"devices",
|
|
"entrypoint",
|
|
"environment",
|
|
"extra_hosts",
|
|
"group_add",
|
|
"healthcheck",
|
|
"hostname",
|
|
"image",
|
|
"init",
|
|
"ipc",
|
|
"labels",
|
|
"logging",
|
|
"mac_address",
|
|
"network_mode",
|
|
"networks",
|
|
"ports",
|
|
"privileged",
|
|
"restart",
|
|
"runtime",
|
|
"security_opt",
|
|
"shm_size",
|
|
"stdin_open",
|
|
"stop_grace_period",
|
|
"sysctls",
|
|
"tty",
|
|
"user",
|
|
"volumes",
|
|
"working_dir"
|
|
],
|
|
"untranslated_blockers": [],
|
|
"policy": "Single-image definitions are installable when every declared Compose option has a native Proxmox translation. Multi-image and unsupported runtime features remain blocked until their orchestrator or mapping is available."
|
|
},
|
|
"validation": {
|
|
"schema": "passed-at-generation",
|
|
"clean_install": "passed-amd64",
|
|
"service_health": "passed-amd64",
|
|
"restart_persistence": "pending",
|
|
"backup_restore": "pending",
|
|
"update_preserves_data": "pending"
|
|
},
|
|
"lifecycle": {
|
|
"update_strategy": "resolve-latest-image-then-apply-reviewed-native-lxc-update",
|
|
"registry_state": {
|
|
"resolved_architecture": null,
|
|
"resolved_digest": null,
|
|
"image_version_label": null,
|
|
"image_created": null
|
|
},
|
|
"change_detection": "compare-compose-sha256-and-resolved-latest-image-digest",
|
|
"automatic_unattended_updates": false
|
|
}
|
|
}
|