mirror of
https://github.com/MacRimi/ProxMenux.git
synced 2026-09-29 10:06:41 +00:00
266 lines
8.6 KiB
JSON
266 lines
8.6 KiB
JSON
 
|
{
|
||
|
|
"schema_version": "0.3.0",
|
||
|
|
"kind": "proxmenux.oci-template",
|
||
|
|
"id": "linuxserver-apprise-api",
|
||
|
|
"status": "generated-unvalidated",
|
||
|
|
"catalog_ui": {
|
||
|
|
"title": {
|
||
|
|
"en_US": "Apprise Api"
|
||
|
|
},
|
||
|
|
"tagline": {
|
||
|
|
"en_US": "Apprise-api Takes advantage of Apprise through your network with a user-friendly API."
|
||
|
|
},
|
||
|
|
"description": {
|
||
|
|
"en_US": "Apprise-api Takes advantage of Apprise through your network with a user-friendly API."
|
||
|
|
},
|
||
|
|
"category": "messaging",
|
||
|
|
"category_label": "Messaging & Queues",
|
||
|
|
"author": "LinuxServer.io",
|
||
|
|
"developer": null,
|
||
|
|
"icon": "https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/apprise-api-icon.png",
|
||
|
|
"thumbnail": "https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/apprise-api-banner.png",
|
||
|
|
"screenshots": [],
|
||
|
|
"architectures": [
|
||
|
|
"amd64",
|
||
|
|
"arm64"
|
||
|
|
],
|
||
|
|
"launch": {
|
||
|
|
"scheme": "http",
|
||
|
|
"port": 8000,
|
||
|
|
"path": "/"
|
||
|
|
},
|
||
|
|
"website": "https://github.com/caronc/apprise-api",
|
||
|
|
"documentation": "https://docs.linuxserver.io/images/docker-apprise-api/",
|
||
|
|
"repository": "https://github.com/linuxserver/docker-apprise-api",
|
||
|
|
"tips": [],
|
||
|
|
"mini_changelog": [
|
||
|
|
{
|
||
|
|
"date": "2025-07-05",
|
||
|
|
"note": "Rebase to Alpine 3.22."
|
||
|
|
},
|
||
|
|
{
|
||
|
|
"date": "2024-12-24",
|
||
|
|
"note": "Rebase to Alpine 3.21."
|
||
|
|
},
|
||
|
|
{
|
||
|
|
"date": "2024-06-24",
|
||
|
|
"note": "Rebase to Alpine 3.20."
|
||
|
|
},
|
||
|
|
{
|
||
|
|
"date": "2023-12-23",
|
||
|
|
"note": "Rebase to Alpine 3.19."
|
||
|
|
},
|
||
|
|
{
|
||
|
|
"date": "2023-07-10",
|
||
|
|
"note": "Rebase to Alpine 3.18."
|
||
|
|
}
|
||
|
|
],
|
||
|
|
"display_version": null,
|
||
|
|
"updated_at": "2025-07-05"
|
||
|
|
},
|
||
|
|
"source": {
|
||
|
|
"provider": "linuxserver.io",
|
||
|
|
"repository": "https://github.com/linuxserver/docker-apprise-api",
|
||
|
|
"default_branch": "main",
|
||
|
|
"revision": "ea905a7e0229ebf4bc05f3189950ae580ba630bb",
|
||
|
|
"readme_raw_url": "https://raw.githubusercontent.com/linuxserver/docker-apprise-api/ea905a7e0229ebf4bc05f3189950ae580ba630bb/README.md",
|
||
|
|
"readme_pushed_at": "2026-09-07T15:41:13Z",
|
||
|
|
"compose_sha256": "edc366d773c0251a031d811302c84c97eb9efd9b468ee03bac804de06082dc88",
|
||
|
|
"generated_at": "2026-09-12T14:37:23+00:00"
|
||
|
|
},
|
||
|
|
"container_contract": {
|
||
|
|
"service_name": "apprise-api",
|
||
|
|
"container_name": "apprise-api",
|
||
|
|
"image": {
|
||
|
|
"reference": "lscr.io/linuxserver/apprise-api:latest",
|
||
|
|
"registry": "lscr.io",
|
||
|
|
"repository": "lscr.io/linuxserver/apprise-api",
|
||
|
|
"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": "APPRISE_ATTACH_SIZE",
|
||
|
|
"example": "0",
|
||
|
|
"required": false,
|
||
|
|
"sensitive": false,
|
||
|
|
"source": "linuxserver-compose"
|
||
|
|
}
|
||
|
|
],
|
||
|
|
"volumes": [
|
||
|
|
{
|
||
|
|
"id": "volume-0",
|
||
|
|
"container_path": "/config",
|
||
|
|
"compose_source_example": "/path/to/apprise-api/config",
|
||
|
|
"read_only": false,
|
||
|
|
"required": true,
|
||
|
|
"installation_choice": [
|
||
|
|
"managed-volume",
|
||
|
|
"host-bind"
|
||
|
|
],
|
||
|
|
"default": "managed-volume",
|
||
|
|
"managed_volume": {
|
||
|
|
"backup": true,
|
||
|
|
"default_size_gb": 4
|
||
|
|
}
|
||
|
|
},
|
||
|
|
{
|
||
|
|
"id": "volume-1",
|
||
|
|
"container_path": "/attachments",
|
||
|
|
"compose_source_example": "/path/to/apprise-api/attachments",
|
||
|
|
"read_only": false,
|
||
|
|
"required": false,
|
||
|
|
"installation_choice": [
|
||
|
|
"managed-volume",
|
||
|
|
"host-bind",
|
||
|
|
"skip"
|
||
|
|
],
|
||
|
|
"default": "skip",
|
||
|
|
"managed_volume": {
|
||
|
|
"backup": true,
|
||
|
|
"default_size_gb": 8
|
||
|
|
}
|
||
|
|
}
|
||
|
|
],
|
||
|
|
"ports": [
|
||
|
|
{
|
||
|
|
"container_port": 8000,
|
||
|
|
"published_example": 8000,
|
||
|
|
"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 apprise-api:\n image: lscr.io/linuxserver/apprise-api:latest\n container_name: apprise-api\n environment:\n - PUID=1000\n - PGID=1000\n - TZ=Etc/UTC\n - APPRISE_ATTACH_SIZE=0 #optional\n volumes:\n - /path/to/apprise-api/config:/config\n - /path/to/apprise-api/attachments:/attachments #optional\n ports:\n - 8000:8000\n restart: unless-stopped\n"
|
||
|
|
},
|
||
|
|
"first_run": {
|
||
|
|
"endpoints": [
|
||
|
|
{
|
||
|
|
"label": "Web UI",
|
||
|
|
"scheme": "http",
|
||
|
|
"port": 8000,
|
||
|
|
"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"
|
||
|
|
}
|
||
|
|
]
|
||
|
|
},
|
||
|
|
"compatibility": {
|
||
|
|
"automatic_install_candidate": true,
|
||
|
|
"validated": false,
|
||
|
|
"supported_compose_keys": [
|
||
|
|
"container_name",
|
||
|
|
"environment",
|
||
|
|
"image",
|
||
|
|
"ports",
|
||
|
|
"restart",
|
||
|
|
"stop_grace_period",
|
||
|
|
"volumes"
|
||
|
|
],
|
||
|
|
"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
|
||
|
|
}
|
||
|
|
}
|