{ "schema_version": "0.5.0", "kind": "proxmenux.oci-template", "id": "image-whoogle", "status": "generated-unvalidated", "catalog_ui": { "title": { "en_US": "Whoogle Search" }, "tagline": { "en_US": "A privacy-focused metasearch frontend." }, "description": { "en_US": "Search the web through a self-hosted Google results frontend without displaying ads or requiring client-side Google scripts. This recipe enables the optional built-in login." }, "category": "network", "category_label": "Network & Firewall", "author": "Whoogle Search contributors", "developer": "benbusby", "icon": "https://cdn.jsdelivr.net/gh/selfhst/icons@main/webp/whoogle.webp", "thumbnail": null, "screenshots": [], "architectures": [ "amd64", "arm64" ], "launch": { "scheme": "http", "port": 5000, "path": "/" }, "website": "https://github.com/benbusby/whoogle-search", "documentation": "https://github.com/benbusby/whoogle-search#manual-docker", "repository": "https://github.com/benbusby/whoogle-search", "tips": [ "The service requires outbound access to Google search endpoints. The built-in login is enabled using an installer-generated password." ], "mini_changelog": [], "display_version": null, "updated_at": null }, "source": { "provider": "benbusby", "repository": "https://github.com/benbusby/whoogle-search", "default_branch": "main", "revision": "0543f86528678ab60a20b3049483975add6b6e40", "image_repository_url": "https://hub.docker.com/r/benbusby/whoogle-search", "readme_pushed_at": "", "compose_sha256": "647d1b6bce4845c8d6df73c4605b67c9f48413ff40a3d203df890b263f6d0590", "generated_at": "2026-10-26T00:12:45+00:00", "readme_raw_url": "https://github.com/benbusby/whoogle-search#manual-docker" }, "container_contract": { "service_name": "whoogle", "container_name": "whoogle", "image": { "reference": "benbusby/whoogle-search:latest", "registry": "docker.io", "repository": "benbusby/whoogle-search", "tag": "latest", "digest": null, "pull_policy": "resolve-selected-tag-to-architecture-digest-at-install" }, "environment": [ { "name": "WHOOGLE_USER", "example": "admin", "required": true, "sensitive": false, "source": "upstream-documentation" }, { "name": "WHOOGLE_PASS", "example": "${GENERATED_WHOOGLE_PASS}", "required": true, "sensitive": true, "source": "upstream-documentation" } ], "volumes": [], "ports": [ { "container_port": 5000, "published_example": 5000, "protocol": "tcp", "required": true, "proxmox_behavior": "listener-on-dedicated-lxc-address-no-nat" } ], "related_services": [], "restart": "unless-stopped", "stop_grace_period": null, "original_compose": "{\n \"name\": \"whoogle\",\n \"services\": {\n \"whoogle\": {\n \"image\": \"benbusby/whoogle-search:latest\",\n \"restart\": \"unless-stopped\",\n \"ports\": [\n \"5000:5000/tcp\"\n ],\n \"environment\": {\n \"WHOOGLE_USER\": \"admin\",\n \"WHOOGLE_PASS\": \"${GENERATED_WHOOGLE_PASS}\"\n }\n }\n }\n}" }, "compose_stack": { "project_name": "whoogle", "deployment_model": "one-native-oci-lxc-per-compose-service", "user_experience": "single-application-install", "main_service": "whoogle", "service_count": 1, "services": [ { "name": "whoogle", "image": "benbusby/whoogle-search:latest", "is_main": true, "role": "frontend", "vmid_offset": 0, "depends_on": [], "frontend_network": true, "private_network": false, "compose": { "image": "benbusby/whoogle-search:latest", "restart": "unless-stopped", "ports": [ "5000:5000/tcp" ], "environment": { "WHOOGLE_USER": "admin", "WHOOGLE_PASS": "${GENERATED_WHOOGLE_PASS}" } } } ], "top_level": { "name": "whoogle" }, "networking": { "frontend": "selected-proxmox-bridge", "private_required": false, "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": [], "orchestration": { "reserve_vmids_atomically": 1, "start_order": [ "whoogle" ], "stop_order": [ "whoogle" ], "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": [ { "id": "generated-whoogle-pass", "strategy": "token-hex-at-install", "bindings": [ { "service": "whoogle", "environment_variable": "WHOOGLE_PASS" } ] } ] } }, "first_run": { "endpoints": [ { "label": "Whoogle Search", "scheme": "http", "port": 5000, "path": "/", "source": "upstream-documentation" } ], "credentials": [ { "label": "Whoogle Search login", "type": "runtime-generated", "username": "admin", "password": null, "password_environment": "WHOOGLE_PASS", "change_required": false, "source": "proxmenux-installer-generated" } ] }, "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": 120 }, "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": "imported-compose-source", "upstream_behavior": "The source definition deploys the complete Docker Compose application model.", "native_lxc_behavior": "The source model is preserved and remains blocked until every service option has a reviewed native Proxmox mapping.", "reason": "Catalog import must not imply runtime compatibility.", "behavioral_impact": "No automatic installation before review.", "validation": "pending-per-application" }, { "id": "rolling-latest-image", "upstream_behavior": "A discovered Compose may pin a release tag or digest.", "native_lxc_behavior": "ProxMenux selects the same image repository with the latest tag for catalog installations.", "reason": "The automatic catalog intentionally offers rolling latest images; pinned versions belong to the future manual installer.", "behavioral_impact": "The installed release can be newer than the discovered Compose revision.", "validation": "pending-per-application" }, { "id": "dedicated-lxc-network", "upstream_behavior": "Docker publishes selected container ports on the Docker host.", "native_lxc_behavior": "A reviewed native application will listen on its original container ports at a dedicated LXC address.", "reason": "A native LXC has its own address and does not require Docker port NAT.", "behavioral_impact": "Published ports are metadata; ProxMenux URLs use the matching container target port.", "validation": "pending-per-application" }, { "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-privileged-mode", "upstream_behavior": "Compose selects whether the container runs in privileged mode.", "native_lxc_behavior": "ProxMenux keeps the LXC unprivileged by default and exposes the broad Compose privilege request only as an explicit compatibility option.", "reason": "A Compose privilege request is source metadata, not proof that the image technically requires a privileged LXC.", "behavioral_impact": "A privileged LXC has weaker isolation from the Proxmox host.", "validation": "native-equivalent" }, { "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-resource-limits", "upstream_behavior": "mem_limit sets the memory ceiling; ulimits sets process soft/hard resource limits.", "native_lxc_behavior": "mem_limit supplies the editable Proxmox memory default, rounded up to MiB; ulimits maps to lxc.prlimit with -1 represented as unlimited.", "reason": "Use native Proxmox memory and LXC prlimits, without a wrapper or changing the host kernel configuration.", "behavioral_impact": "User-selected memory overrides Compose. Swap is a separate choice. Kernel restrictions still apply; nproc counts processes by real UID, not by container.", "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" } ], "installer_profile": { "runtime": {}, "startup_healthcheck": { "scheme": "http", "port": 5000, "path": "/", "timeout_seconds": 180, "request_timeout_seconds": 15, "stability_seconds": 4, "verify_tls": true, "accept_any_status": true }, "generated_sensitive_environment": { "WHOOGLE_PASS": { "strategy": "token-hex", "bytes": 24, "prompt": false } } }, "catalog": { "replaces_discovered_ids": [] } }, "compatibility": { "automatic_install_candidate": true, "validated": false, "supported_compose_keys": [ "command", "container_name", "entrypoint", "environment", "image", "ports", "restart", "volumes" ], "untranslated_blockers": [], "policy": "Single-image profile with the upstream persistent paths and startup options represented as native OCI-LXC settings. The profile remains unavailable as validated until clean-install, web-service and persistence checks pass." }, "validation": { "schema": "passed-at-generation", "clean_install": "pending", "service_health": "pending", "restart_persistence": "pending", "backup_restore": "pending", "update_preserves_data": "pending" }, "lifecycle": { "update_strategy": "resolve-latest-image-then-apply-reviewed-native-lxc-update", "registry_state": { "resolved_architecture": null, "resolved_digest": null, "image_version_label": null, "image_created": null }, "change_detection": "compare-compose-sha256-and-resolved-latest-image-digest", "automatic_unattended_updates": false } }