ProxMenux/oci/catalog/apps/hishtory-server.json

{
  "schema_version": "0.3.0",
  "kind": "proxmenux.oci-template",
  "id": "linuxserver-hishtory-server",
  "status": "generated-unvalidated",
  "catalog_ui": {
    "title": {
      "en_US": "Hishtory Server"
    },
    "tagline": {
      "en_US": "hiSHtory is a better shell history. It stores your shell history in context (what directory you ran the command in, whether it succeeded or failed, how long it took, etc). This is all stored locally and end-to-end encrypted for syncing to to all your other computers."
    },
    "description": {
      "en_US": "hiSHtory is a better shell history. It stores your shell history in context (what directory you ran the command in, whether it succeeded or failed, how long it took, etc). This is all stored locally and end-to-end encrypted for syncing to to all your other computers."
    },
    "category": "ai",
    "category_label": "AI / Coding & Dev-Tools",
    "author": "LinuxServer.io",
    "developer": null,
    "icon": "https://cdn.jsdelivr.net/gh/linuxserver/docker-templates@master/linuxserver.io/img/hishtory-server-icon.png",
    "thumbnail": "https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/hishtory-server-banner.png",
    "screenshots": [],
    "architectures": [
      "amd64",
      "arm64"
    ],
    "launch": {
      "scheme": "http",
      "port": 8080,
      "path": "/"
    },
    "website": "https://github.com/ddworken/hishtory",
    "documentation": "https://docs.linuxserver.io/images/docker-hishtory-server/",
    "repository": "https://github.com/linuxserver/docker-hishtory-server",
    "tips": [],
    "mini_changelog": [
      {
        "date": "2026-07-05",
        "note": "Rebase to Alpine 3.24."
      },
      {
        "date": "2025-12-25",
        "note": "Rebase to Alpine 3.23."
      },
      {
        "date": "2025-07-05",
        "note": "Rebase to Alpine 3.22."
      },
      {
        "date": "2024-12-19",
        "note": "Rebase to Alpine 3.21."
      },
      {
        "date": "2024-08-26",
        "note": "Bump to go 1.23"
      }
    ],
    "display_version": null,
    "updated_at": "2026-07-05"
  },
  "source": {
    "provider": "linuxserver.io",
    "repository": "https://github.com/linuxserver/docker-hishtory-server",
    "default_branch": "main",
    "revision": "2ab19293ce67aca74850ada791f3f695b360f412",
    "readme_raw_url": "https://raw.githubusercontent.com/linuxserver/docker-hishtory-server/2ab19293ce67aca74850ada791f3f695b360f412/README.md",
    "readme_pushed_at": "2026-09-11T07:39:19Z",
    "compose_sha256": "6f9c613b231894bc95d9b7124c7d475da2449ce7768c397c4b412c576696d4c4",
    "generated_at": "2026-09-12T14:37:28+00:00"
  },
  "container_contract": {
    "service_name": "hishtory-server",
    "container_name": "hishtory-server",
    "image": {
      "reference": "lscr.io/linuxserver/hishtory-server:latest",
      "registry": "lscr.io",
      "repository": "lscr.io/linuxserver/hishtory-server",
      "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": "HISHTORY_POSTGRES_DB",
        "example": "postgresql://${HISHTORY_DB_USER}:${HISHTORY_DB_PASS}@hishtory-db:5432/hishtory?sslmode=disable",
        "required": false,
        "sensitive": false,
        "source": "linuxserver-compose"
      },
      {
        "name": "HISHTORY_SQLITE_DB",
        "example": "/config/hishtory.db",
        "required": false,
        "sensitive": false,
        "source": "linuxserver-compose"
      }
    ],
    "volumes": [],
    "ports": [
      {
        "container_port": 8080,
        "published_example": 8080,
        "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  hishtory-server:\n    image: lscr.io/linuxserver/hishtory-server:latest\n    container_name: hishtory-server\n    environment:\n      - PUID=1000\n      - PGID=1000\n      - TZ=Etc/UTC\n      - HISHTORY_POSTGRES_DB=postgresql://${HISHTORY_DB_USER}:${HISHTORY_DB_PASS}@hishtory-db:5432/hishtory?sslmode=disable #optional\n      - HISHTORY_SQLITE_DB=/config/hishtory.db #optional\n    ports:\n      - 8080:8080\n    restart: unless-stopped\n"
  },
  "first_run": {
    "endpoints": [
      {
        "label": "Web UI",
        "scheme": "http",
        "port": 8080,
        "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"
    },
    "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
  }
}