{ "schema_version": "0.4.0", "kind": "proxmenux.oci-template", "id": "linuxserver-github-desktop", "status": "generated-unvalidated", "catalog_ui": { "title": { "en_US": "Github Desktop" }, "tagline": { "en_US": "Github Desktop is an open source Electron-based GitHub app. It is written in TypeScript and uses React." }, "description": { "en_US": "Github Desktop is an open source Electron-based GitHub app. It is written in TypeScript and uses React." }, "category": "misc", "category_label": "Miscellaneous", "author": "LinuxServer.io", "developer": null, "icon": "https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/github-desktop-icon.png", "thumbnail": "https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/github-desktop-banner.png", "screenshots": [], "architectures": [ "amd64", "arm64" ], "launch": { "scheme": "https", "port": 3001, "path": "/" }, "website": "https://desktop.github.com/", "documentation": "https://docs.linuxserver.io/images/docker-github-desktop/", "repository": "https://github.com/linuxserver/docker-github-desktop", "tips": [], "mini_changelog": [ { "date": "2026-04-03", "note": "Make Wayland default disable with PIXELFLUX_WAYLAND=false." }, { "date": "2026-03-21", "note": "Use Wayland ozone platform flag for apps fixes scaling and acceleration." }, { "date": "2025-12-28", "note": "Add Wayland init logic." }, { "date": "2025-09-22", "note": "Rebase to Debian Trixie." }, { "date": "2025-07-12", "note": "Rebase to Selkies, HTTPS IS NOW REQUIRED." } ], "display_version": null, "updated_at": "2026-04-03" }, "source": { "provider": "linuxserver.io", "repository": "https://github.com/linuxserver/docker-github-desktop", "default_branch": "master", "revision": "31edb1dca04505312addd09daf57fb61d0616de9", "readme_raw_url": "https://raw.githubusercontent.com/linuxserver/docker-github-desktop/31edb1dca04505312addd09daf57fb61d0616de9/README.md", "readme_pushed_at": "2026-09-13T00:12:51Z", "compose_sha256": "d7d4dc30aa197ed622ff2c3aa2561adea209ffd887787b939f14f45d7b3b4bdc", "generated_at": "2026-09-13T15:47:48+00:00" }, "container_contract": { "service_name": "github-desktop", "container_name": "github-desktop", "image": { "reference": "lscr.io/linuxserver/github-desktop:latest", "registry": "lscr.io", "repository": "lscr.io/linuxserver/github-desktop", "tag": "latest", "digest": null, "pull_policy": "resolve-selected-tag-to-architecture-digest-at-install" }, "environment": [ { "name": "PUID", "example": "1000", "required": true, "sensitive": false, "source": "linuxserver-compose" }, { "name": "PGID", "example": "1000", "required": true, "sensitive": false, "source": "linuxserver-compose" }, { "name": "TZ", "example": "Etc/UTC", "required": true, "sensitive": false, "source": "linuxserver-compose" }, { "name": "LC_ALL", "example": "", "required": false, "sensitive": false, "source": "upstream-documentation", "prompt": "Language/locale (e.g. es_ES.UTF-8; translation of every application is not guaranteed)" } ], "volumes": [ { "id": "volume-0", "container_path": "/config", "compose_source_example": "/path/to/github-desktop/config", "read_only": false, "required": true, "installation_choice": [ "managed-volume", "host-bind" ], "default": "managed-volume", "managed_volume": { "backup": true, "default_size_gb": 4 } } ], "ports": [ { "container_port": 3000, "published_example": 3000, "protocol": "tcp", "required": true, "proxmox_behavior": "listener-on-dedicated-lxc-address-no-nat" }, { "container_port": 3001, "published_example": 3001, "protocol": "tcp", "required": true, "proxmox_behavior": "listener-on-dedicated-lxc-address-no-nat" } ], "related_services": [], "restart": "unless-stopped", "stop_grace_period": null, "original_compose": "---\nservices:\n github-desktop:\n image: lscr.io/linuxserver/github-desktop:latest\n container_name: github-desktop\n cap_add:\n - IPC_LOCK\n environment:\n - PUID=1000\n - PGID=1000\n - TZ=Etc/UTC\n volumes:\n - /path/to/github-desktop/config:/config\n ports:\n - 3000:3000\n - 3001:3001\n shm_size: \"1gb\"\n restart: unless-stopped\n" }, "first_run": { "endpoints": [ { "label": "Web UI", "scheme": "https", "port": 3001, "path": "/", "source": "linuxserver-readme-application-setup" } ], "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": { "tmpfs_mounts": [ { "id": "compose-shm", "container_path": "/dev/shm", "default_size_mb": 1024, "minimum_size_mb": 1, "size_prompt": "Size of the /dev/shm shared memory in MB", "mount_options": [ "rw", "nosuid", "nodev" ] }, { "id": "nginx-runtime", "container_path": "/run/nginx", "default_size_mb": 1, "minimum_size_mb": 1, "prompt_size": false, "mount_options": [ "rw", "nosuid", "nodev", "mode=0755" ] } ], "security": { "required_capabilities": [ "IPC_LOCK" ] }, "selkies": { "base": "FROM ghcr.io/linuxserver/baseimage-selkies:debiantrixie", "dockerfile_url": "https://raw.githubusercontent.com/linuxserver/docker-github-desktop/master/Dockerfile", "dockerfile_sha256": "3bae15eb6f81e3dac69859063580744abe6e7df149f549ea98901cbe3f78b898", "reviewed_on": "2026-09-16", "documentation": "https://docs.linuxserver.io/images/docker-baseimage-selkies/", "nvidia": "not-offered-until-specific-host-and-image-validation", "validation": "profile-generated; real streaming workload pending" }, "optional_devices": [], "hardware_acceleration": { "prompt": "Selkies desktop and streaming acceleration", "default": "none", "profiles": [ { "id": "none", "label": "No GPU (CPU)", "device_requests": [], "environment": [ { "name": "AUTO_GPU", "value": "false" } ] }, { "id": "vaapi", "label": "Intel/AMD (streaming rendering and encoding)", "device_requests": [ { "id": "selkies-render", "kind": "character-device", "path_prompt": "Intel/AMD render node", "host_path_default": "/dev/dri/renderD128", "container_path_strategy": "same-as-host", "mode": "0660", "deny_write": false, "gid_strategy": "host-device-gid", "drm_vendor_ids": [ "0x8086", "0x1002" ] } ], "environment": [ { "name": "PIXELFLUX_WAYLAND", "value": "true" }, { "name": "AUTO_GPU", "value": "false" } ], "environment_from_devices": { "DRINODE": [ "selkies-render" ], "DRI_NODE": [ "selkies-render" ], "ATTACHED_DEVICES_PERMS": [ "selkies-render" ] } } ] }, "gpu_validation": { "device_inventory": "host-sysfs-and-stat", "application_acceleration": "requires-workload-test", "tone_mapping": "not-implied-by-device-access" }, "device_permissions": { "strategy": "linuxserver-native-init", "service_user": "abc", "environment": "ATTACHED_DEVICES_PERMS", "paths": "all-resolved-selected-character-devices" } }, "adaptations": [ { "id": "dedicated-lxc-network", "upstream_behavior": "Docker publishes selected container ports on the Docker host.", "native_lxc_behavior": "The application listens on the same container ports at its dedicated LXC address.", "reason": "A native LXC has its own address and does not require Docker port NAT.", "behavioral_impact": "Users open the LXC address instead of the Proxmox host address.", "validation": "pending-per-application" }, { "id": "compose-environment-overlay", "upstream_behavior": "Compose environment values override OCI image environment values.", "native_lxc_behavior": "ProxMenux merges the same values into lxc.environment.runtime while the CT is stopped.", "reason": "PVE imports image Env automatically; Compose values still need to override it.", "behavioral_impact": "None expected.", "validation": "pending-per-application" }, { "id": "stop-grace-period", "upstream_behavior": "Docker waits for Compose stop_grace_period before forcing termination.", "native_lxc_behavior": "ProxMenux records the same timeout for its pct shutdown lifecycle operations.", "reason": "Proxmox has no equivalent per-CT persistent restart-policy field; startup.down is not a shutdown timeout.", "behavioral_impact": "Normal Proxmox node shutdown remains governed by the node-wide shutdown policy.", "validation": "not-requested-by-compose" }, { "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": "pending-per-application" }, { "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-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": "not-requested-by-compose" }, { "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", "devices", "entrypoint", "environment", "extra_hosts", "healthcheck", "hostname", "image", "init", "ipc", "labels", "logging", "mac_address", "network_mode", "networks", "ports", "privileged", "restart", "runtime", "shm_size", "stdin_open", "stop_grace_period", "sysctls", "tty", "user", "volumes", "working_dir" ], "untranslated_blockers": [], "policy": "A generated template is never promoted to validated without install, health, restart and persistence tests." }, "validation": { "schema": "passed-at-generation", "clean_install": "pending", "service_health": "pending", "restart_persistence": "pending", "backup_restore": "pending", "update_preserves_data": "pending" }, "lifecycle": { "update_strategy": "replace-rootfs-from-new-oci-image-preserve-managed-volumes", "registry_state": { "resolved_architecture": null, "resolved_digest": null, "image_version_label": null, "image_created": null }, "change_detection": "compare-resolved-architecture-digest", "automatic_unattended_updates": false } }