ProxMenux/oci/catalog/apps/ngircd.json

{
  "schema_version": "0.3.0",
  "kind": "proxmenux.oci-template",
  "id": "linuxserver-ngircd",
  "status": "generated-unvalidated",
  "catalog_ui": {
    "title": {
      "en_US": "Ngircd"
    },
    "tagline": {
      "en_US": "Ngircd is a free, portable and lightweight Internet Relay Chat server for small or private networks, developed under the GNU General Public License (GPL). It is easy to configure, can cope with dynamic IP addresses, and supports IPv6, SSL-protected connections as well as PAM for authentication. It is written from scratch and not based on the original IRCd."
    },
    "description": {
      "en_US": "Ngircd is a free, portable and lightweight Internet Relay Chat server for small or private networks, developed under the GNU General Public License (GPL). It is easy to configure, can cope with dynamic IP addresses, and supports IPv6, SSL-protected connections as well as PAM for authentication. It is written from scratch and not based on the original IRCd."
    },
    "category": "misc",
    "category_label": "Miscellaneous",
    "author": "LinuxServer.io",
    "developer": null,
    "icon": "https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/ngircd-icon.png",
    "thumbnail": "https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/ngircd-banner.png",
    "screenshots": [],
    "architectures": [
      "amd64",
      "arm64"
    ],
    "launch": {
      "scheme": "http",
      "port": 6667,
      "path": "/"
    },
    "website": "https://ngircd.barton.de/",
    "documentation": "https://docs.linuxserver.io/images/docker-ngircd/",
    "repository": "https://github.com/linuxserver/docker-ngircd",
    "tips": [],
    "mini_changelog": [
      {
        "date": "2024-10-14",
        "note": "Rebase to Alpine 3.22."
      },
      {
        "date": "2024-06-27",
        "note": "Rebase to Alpine 3.20."
      },
      {
        "date": "2024-03-20",
        "note": "Rebase to Alpine 3.19."
      },
      {
        "date": "2023-07-12",
        "note": "Rebase to Alpine 3.18."
      },
      {
        "date": "2023-07-01",
        "note": "Deprecate armhf. As announced [here](https://www.linuxserver.io/blog/a-farewell-to-arm-hf)"
      }
    ],
    "display_version": null,
    "updated_at": "2024-10-14"
  },
  "source": {
    "provider": "linuxserver.io",
    "repository": "https://github.com/linuxserver/docker-ngircd",
    "default_branch": "master",
    "revision": "aa2feb02afbb86cd66155664d8a30559e4f9fb24",
    "readme_raw_url": "https://raw.githubusercontent.com/linuxserver/docker-ngircd/aa2feb02afbb86cd66155664d8a30559e4f9fb24/README.md",
    "readme_pushed_at": "2026-07-11T15:45:47Z",
    "compose_sha256": "e4c9822c9c1b5331b9625b9968cf6bfc54fae231ea544fdf20fa40b72b50753e",
    "generated_at": "2026-09-12T14:37:32+00:00"
  },
  "container_contract": {
    "service_name": "ngircd",
    "container_name": "ngircd",
    "image": {
      "reference": "lscr.io/linuxserver/ngircd:latest",
      "registry": "lscr.io",
      "repository": "lscr.io/linuxserver/ngircd",
      "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"
      }
    ],
    "volumes": [
      {
        "id": "volume-0",
        "container_path": "/config",
        "compose_source_example": "/path/to/ngircd/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": 6667,
        "published_example": 6667,
        "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  ngircd:\n    image: lscr.io/linuxserver/ngircd:latest\n    container_name: ngircd\n    environment:\n      - PUID=1000\n      - PGID=1000\n      - TZ=Etc/UTC\n    volumes:\n      - /path/to/ngircd/config:/config\n    ports:\n      - 6667:6667\n    restart: unless-stopped\n"
  },
  "first_run": {
    "endpoints": [
      {
        "label": "Web UI",
        "scheme": "http",
        "port": 6667,
        "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
  }
}