{ "schema_version": "0.5.0", "kind": "proxmenux.oci-template", "id": "image-firefly", "status": "generated-unvalidated", "catalog_ui": { "title": { "en_US": "Firefly" }, "tagline": { "en_US": "Firefly, the easiest using of WireGuard VPN server, plus version of wg-easy." }, "description": { "en_US": "Firefly is a simple and easy to install WireGuard server software, which can be widely used in scenarios such as remote networking, remote work, and expose a local server behind a NAT or firewall to the internet. 🎯 Features 🟢 Provide a simple and easy-to-use web management UI 🟣 Supports access to all WireGuard clients 🟡 No need for system installation of WireGuard components 🟠 Single file, no additional library dependencies 🔴 Automatically apply for free SSL certificate" }, "category": "finance", "category_label": "Finance & Budgeting", "author": "Safe3", "developer": "Safe3", "icon": "https://cdn.jsdelivr.net/gh/homarr-labs/dashboard-icons@main/webp/firefly.webp", "thumbnail": null, "screenshots": [], "architectures": [ "amd64", "arm64" ], "launch": { "scheme": "http", "port": 50121, "path": "/" }, "website": "https://qq.uusec.com/", "documentation": null, "repository": "https://hub.docker.com/r/uusec/firefly", "tips": [], "mini_changelog": [], "display_version": null, "updated_at": null }, "source": { "provider": "uusec", "repository": "https://hub.docker.com/r/uusec/firefly", "revision": "35bd2ac3b2a663b5a125c65c35bc84540f45452ddca293a31e2ef509feaec1f4", "image_repository_url": "https://hub.docker.com/r/uusec/firefly", "readme_pushed_at": "2026-09-11T10:43:22Z", "compose_sha256": "35bd2ac3b2a663b5a125c65c35bc84540f45452ddca293a31e2ef509feaec1f4", "generated_at": "2026-09-13T15:58:28+00:00" }, "container_contract": { "service_name": "firefly", "container_name": "firefly", "image": { "reference": "uusec/firefly:latest", "registry": "docker.io", "repository": "uusec/firefly", "tag": "latest", "digest": null, "pull_policy": "resolve-selected-tag-to-architecture-digest-at-install" }, "environment": [ { "name": "FIREFLY_PASSWORD", "example": "${GENERATED_FIREFLY_PASSWORD}", "required": true, "sensitive": true, "source": "docker-compose" } ], "volumes": [ { "id": "volume-0", "container_path": "/lib/modules", "compose_source_example": "/lib/modules", "read_only": false, "required": true, "installation_choice": [ "host-bind" ], "default": "host-bind", "managed_volume": { "backup": true, "default_size_gb": 8 } }, { "id": "volume-1", "container_path": "/firefly/conf", "compose_source_example": "/DATA/AppData/firefly/conf", "read_only": false, "required": true, "installation_choice": [ "managed-volume", "host-bind" ], "default": "managed-volume", "managed_volume": { "backup": true, "default_size_gb": 8 } } ], "ports": [], "related_services": [], "restart": "unless-stopped", "stop_grace_period": null, "original_compose": "version: '3'\nname: firefly\nservices:\n firefly:\n image: uusec/firefly:latest\n container_name: firefly\n devices:\n - /dev/net/tun:/dev/net/tun\n network_mode: host\n volumes:\n - /lib/modules:/lib/modules\n - /DATA/AppData/firefly/conf:/firefly/conf\n cap_add:\n - NET_ADMIN\n - SYS_MODULE\n restart: unless-stopped\n environment:\n - FIREFLY_PASSWORD=${GENERATED_FIREFLY_PASSWORD}\n deploy:\n resources:\n reservations:\n memory: 32M\n" }, "compose_stack": { "project_name": "firefly", "deployment_model": "one-native-oci-lxc-per-compose-service", "user_experience": "single-application-install", "main_service": "firefly", "service_count": 1, "services": [ { "name": "firefly", "image": "uusec/firefly:latest", "is_main": true, "role": "frontend", "vmid_offset": 0, "depends_on": [], "frontend_network": true, "private_network": false, "compose": { "image": "uusec/firefly:latest", "container_name": "firefly", "devices": [ "/dev/net/tun:/dev/net/tun" ], "network_mode": "host", "volumes": [ "/lib/modules:/lib/modules", "/DATA/AppData/firefly/conf:/firefly/conf" ], "cap_add": [ "NET_ADMIN", "SYS_MODULE" ], "restart": "unless-stopped", "environment": [ "FIREFLY_PASSWORD=${GENERATED_FIREFLY_PASSWORD}" ], "deploy": { "resources": { "reservations": { "memory": "32M" } } } } } ], "top_level": { "version": "3", "name": "firefly" }, "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": "firefly-volume-0", "service": "firefly", "container_path": "/lib/modules", "mode": "managed-volume", "user_selectable": false, "backup": true, "shared_with_other_lxc": false, "source_path": null, "source_path_prompt": null }, { "id": "firefly-volume-1", "service": "firefly", "container_path": "/firefly/conf", "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": [ "firefly" ], "stop_order": [ "firefly" ], "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": "firefly-password", "strategy": "generate-cryptographically-random-at-install", "bindings": [ { "service": "firefly", "environment_variable": "FIREFLY_PASSWORD" } ] } ] } }, "first_run": { "endpoints": [ { "label": "Web UI", "scheme": "http", "port": 50121, "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": 128, "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": { "device_requests": [ { "id": "dev-net-tun", "kind": "character-device", "purpose": "tun", "enable_prompt": "Pass /dev/net/tun to the LXC", "enabled_default": true, "required_by_compose": true, "path_prompt": "Host device for /dev/net/tun", "host_path_default": "/dev/net/tun", "container_path": "/dev/net/tun", "mode": "preserve-host", "deny_write": false, "gid_strategy": "host-device-gid", "source_mapping": "/dev/net/tun:/dev/net/tun" } ], "network": { "compose_mode": "host" }, "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 } ] } }, "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": "pending-per-application" }, { "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": "pending", "service_health": "pending", "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 } }