{ "schema_version": "0.4.0", "kind": "proxmenux.oci-template", "id": "linuxserver-kimai", "status": "generated-unvalidated", "catalog_ui": { "title": { "en_US": "Kimai" }, "tagline": { "en_US": "Kimai is a professional grade time-tracking application, free and open-source." }, "description": { "en_US": "Kimai is a professional grade time-tracking application, free and open-source." }, "category": "business", "category_label": "Business & ERP", "author": "LinuxServer.io", "developer": null, "icon": "https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/kimai-icon.png", "thumbnail": "https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/kimai-banner.png", "screenshots": [], "architectures": [ "amd64", "arm64" ], "launch": { "scheme": "http", "port": 80, "path": "/" }, "website": "https://kimai.org/", "documentation": "https://docs.linuxserver.io/images/docker-kimai/", "repository": "https://github.com/linuxserver/docker-kimai", "tips": [], "mini_changelog": [ { "date": "2027-07-04", "note": "Rebase to Alpine 3.24." }, { "date": "2025-12-28", "note": "Rebase to Alpine 3.23." }, { "date": "2025-07-04", "note": "Rebase to Alpine 3.22." }, { "date": "2025-04-06", "note": "Rebase to Alpine 3.21." }, { "date": "2024-06-30", "note": "Rebase to Alpine 3.20. Existing users should update their nginx confs to avoid http2 deprecation warnings." } ], "display_version": null, "updated_at": "2027-07-04" }, "source": { "provider": "linuxserver.io", "repository": "https://github.com/linuxserver/docker-kimai", "default_branch": "main", "revision": "21f7b9db5742edabb76b11e6fa5275f0066cc415", "readme_raw_url": "https://raw.githubusercontent.com/linuxserver/docker-kimai/21f7b9db5742edabb76b11e6fa5275f0066cc415/README.md", "readme_pushed_at": "2026-09-12T00:49:44Z", "compose_sha256": "745bfbac6203afa250031b71ce2a6ccf09f16206e472efa3a4da653f61a43fb1", "generated_at": "2026-09-14T16:50:34+00:00" }, "container_contract": { "service_name": "kimai", "container_name": "kimai", "image": { "reference": "lscr.io/linuxserver/kimai:latest", "registry": "lscr.io", "repository": "lscr.io/linuxserver/kimai", "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": "APP_SECRET", "example": "", "required": true, "sensitive": true, "source": "linuxserver-compose" }, { "name": "DATABASE_URL", "example": "mysql://your_db_user:your_db_pass@your_db_host:3306/your_db_name?charset=your_db_charset&serverVersion=your_db_version", "required": true, "sensitive": false, "source": "linuxserver-compose" }, { "name": "TRUSTED_HOSTS", "example": "kimai.example.com", "required": true, "sensitive": false, "source": "linuxserver-compose" }, { "name": "TRUSTED_PROXIES", "example": "127.0.0.1/32", "required": false, "sensitive": false, "source": "linuxserver-compose" } ], "volumes": [ { "id": "volume-0", "container_path": "/config", "compose_source_example": "/path/to/kimai/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": 80, "published_example": 80, "protocol": "tcp", "required": true, "proxmox_behavior": "listener-on-dedicated-lxc-address-no-nat" }, { "container_port": 443, "published_example": 443, "protocol": "tcp", "required": true, "proxmox_behavior": "listener-on-dedicated-lxc-address-no-nat" } ], "related_services": [ { "name": "mariadb", "image": "lscr.io/linuxserver/mariadb:latest" } ], "restart": "unless-stopped", "stop_grace_period": null, "original_compose": "---\nservices:\n kimai:\n image: lscr.io/linuxserver/kimai:latest\n container_name: kimai\n environment:\n - PUID=1000\n - PGID=1000\n - TZ=Etc/UTC\n - APP_SECRET=\n - DATABASE_URL=mysql://your_db_user:your_db_pass@your_db_host:3306/your_db_name?charset=your_db_charset&serverVersion=your_db_version\n - TRUSTED_HOSTS=kimai.example.com\n - TRUSTED_PROXIES=127.0.0.1/32 #optional\n volumes:\n - /path/to/kimai/config:/config\n ports:\n - 80:80\n - 443:443\n restart: unless-stopped\n\n# This container requires an external application to be run separately.\n# MariaDB\n mariadb:\n image: lscr.io/linuxserver/mariadb:latest\n container_name: mariadb\n environment:\n - PUID=1000\n - PGID=1000\n - TZ=Etc/UTC\n - MYSQL_ROOT_PASSWORD=ROOT_ACCESS_PASSWORD\n - MYSQL_DATABASE=your_db_name #optional\n - MYSQL_USER=your_db_user #optional\n - MYSQL_PASSWORD=your_db_pass #optional\n volumes:\n - path_to_data:/config\n ports:\n - 3306:3306\n restart: unless-stopped\n" }, "first_run": { "endpoints": [ { "label": "Web UI", "scheme": "http", "port": 80, "path": "/", "source": "compose-first-tcp-port-fallback" } ], "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" }, "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": "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-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": "not-requested-by-compose" }, { "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" } ], "stack_environment_overrides": { "kimai": { "APP_SECRET": "${GENERATED_APP_SECRET}", "DATABASE_URL": "mysql://kimai:${GENERATED_KIMAI_DB_PASSWORD}@mariadb:3306/kimai?charset=utf8mb4", "TRUSTED_HOSTS": "^(?:[0-9]{1,3}[.]){3}[0-9]{1,3}$|^localhost$" }, "mariadb": { "MYSQL_ROOT_PASSWORD": "${GENERATED_MARIADB_ROOT_PASSWORD}", "MYSQL_DATABASE": "kimai", "MYSQL_USER": "kimai", "MYSQL_PASSWORD": "${GENERATED_KIMAI_DB_PASSWORD}" } }, "stack_adaptation_notes": [ "Both images remain LinuxServer images, including lscr.io/linuxserver/mariadb:latest; no database image substitution.", "MariaDB persists /config and readiness requires an authenticated SELECT 1 as the application user.", "The DATABASE_URL uses the shared generated database password and automatic server version detection.", "Initial TRUSTED_HOSTS permits IPv4 hostnames and localhost. Set the intended domain when configuring a reverse proxy.", "Create the first administrator using the upstream console kimai:user:create command inside the Kimai LXC; no default account is fabricated.", "Installation, migrations, administrator creation and persistence remain unvalidated in a real OCI LXC." ], "stack_references": [ "https://docs.linuxserver.io/images/docker-kimai/", "https://docs.linuxserver.io/images/docker-mariadb/" ], "installer_profile": { "stack_driver": "generic-multi-lxc-stack" }, "stack_completion_notes": [ "Kimai has no default account. Enter the container with: pct enter {main_vmid}", "Inside the LXC, create the administrator: console kimai:user:create YOUR_USERNAME YOUR_EMAIL ROLE_SUPER_ADMIN" ] }, "compatibility": { "automatic_install_candidate": true, "validated": false, "supported_compose_keys": [ "cap_add", "command", "container_name", "cpu_shares", "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": "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, "dependency_lifecycle": { "implementation": "proxmox-hookscript", "trigger": "main-lxc-pre-start", "waits_for_dependency_healthchecks": true, "stops_dependencies_with_main": false } }, "compose_stack": { "project_name": "kimai", "deployment_model": "one-native-oci-lxc-per-compose-service", "user_experience": "single-application-install", "main_service": "kimai", "service_count": 2, "services": [ { "name": "mariadb", "image": "lscr.io/linuxserver/mariadb:latest", "is_main": false, "role": "dependency", "vmid_offset": 1, "depends_on": [], "frontend_network": true, "private_network": true, "compose": { "image": "lscr.io/linuxserver/mariadb:latest", "container_name": "mariadb", "environment": [ "PUID=1000", "PGID=1000", "TZ=Etc/UTC", "MYSQL_ROOT_PASSWORD=ROOT_ACCESS_PASSWORD", "MYSQL_DATABASE=your_db_name", "MYSQL_USER=your_db_user", "MYSQL_PASSWORD=your_db_pass" ], "volumes": [ "path_to_data:/config" ], "ports": [ "3306:3306" ], "restart": "unless-stopped" } }, { "name": "kimai", "image": "lscr.io/linuxserver/kimai:latest", "is_main": true, "role": "frontend", "vmid_offset": 0, "depends_on": [], "frontend_network": true, "private_network": true, "compose": { "image": "lscr.io/linuxserver/kimai:latest", "container_name": "kimai", "environment": [ "PUID=1000", "PGID=1000", "TZ=Etc/UTC", "APP_SECRET=", "DATABASE_URL=mysql://your_db_user:your_db_pass@your_db_host:3306/your_db_name?charset=your_db_charset&serverVersion=your_db_version", "TRUSTED_HOSTS=kimai.example.com", "TRUSTED_PROXIES=127.0.0.1/32" ], "volumes": [ "/path/to/kimai/config:/config" ], "ports": [ "80:80", "443:443" ], "restart": "unless-stopped" } } ], "top_level": {}, "networking": { "frontend": "selected-proxmox-bridge", "private_required": true, "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": "kimai-volume-0", "service": "kimai", "container_path": "/config", "mode": "managed-volume", "user_selectable": false, "backup": true, "shared_with_other_lxc": false, "source_path": null, "source_path_prompt": null }, { "id": "mariadb-volume-0", "service": "mariadb", "container_path": "/config", "mode": "managed-volume", "user_selectable": false, "backup": true, "shared_with_other_lxc": false, "source_path": null, "source_path_prompt": null } ], "orchestration": { "reserve_vmids_atomically": 2, "start_order": [ "mariadb", "kimai" ], "stop_order": [ "kimai", "mariadb" ], "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": [] } } }