You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
virt/deploy/virt-cloud-agent.env.example

48 lines
2.6 KiB
Plaintext

# Copy to /etc/virt-cloud-agent/agent.env and edit the values. This file is
# an example only; it contains no certificates, private keys, HMAC material,
# bearer tokens, passwords, or other credentials.
# Keep the default loopback listener for local development. For a remote PHP
# panel, replace this with the host management address and keep both mTLS and
# request signing enabled. Do not use 0.0.0.0 as a production shortcut.
VIRT_CLOUD_AGENT_LISTEN=127.0.0.1:8787
# A fresh, stable identifier generated by the enrollment workflow. Leaving it
# empty is safe: health remains available but mutating operations stay blocked.
VIRT_CLOUD_AGENT_ID=
VIRT_CLOUD_AGENT_JOURNAL=/var/lib/virt-cloud-agent/operations.json
VIRT_CLOUD_AGENT_ARTIFACT_ROOT=/var/lib/virt-cloud-agent/artifacts
VIRT_CLOUD_AGENT_BACKEND=virsh
VIRT_CLOUD_AGENT_LIBVIRT_URI=qemu:///system
# Optional explicit allowlist for existing file-backed VM images. Empty means
# fail-closed for <disk type="file">; it is never an allow-all fallback.
# Use canonical absolute paths only, comma-separated, and provision each root
# as a real root-owned directory before enabling domain_define.
# VIRT_CLOUD_AGENT_STORAGE_ROOTS=/var/lib/libvirt/images/virt-cloud
# File paths only. Provision the actual files out of band with root-only
# ownership; the HMAC key specifically must be a regular 0400/0600 file with
# no group/other permission bits. Never paste key contents here.
# request.hmac must contain canonical standard base64 for exactly 32 random raw
# bytes (44 ASCII characters, optionally followed by one newline). PHP
# CloudSecrets and Go auth.FromFile decode the same format.
VIRT_CLOUD_AGENT_TLS_CERT=/etc/virt-cloud-agent/tls/agent.crt
VIRT_CLOUD_AGENT_TLS_KEY=/etc/virt-cloud-agent/tls/agent.key
VIRT_CLOUD_AGENT_TLS_CA=/etc/virt-cloud-agent/tls/panel-ca.crt
VIRT_CLOUD_AGENT_HMAC_KEY_FILE=/etc/virt-cloud-agent/secrets/request.hmac
# SHA-256 fingerprints of the panel client certificate(s), comma-separated
# during an intentional rotation overlap. The value is public identity
# metadata, not a private key.
VIRT_CLOUD_AGENT_CLIENT_CERT_SHA256=
# Explicit production posture. If any referenced file is missing or cannot
# be read, a loopback process serves degraded liveness/diagnostics while
# protected writes return 503. A remote bind refuses to start plaintext until
# the operator repairs the mTLS material.
VIRT_CLOUD_AGENT_REQUIRE_MTLS=true
VIRT_CLOUD_AGENT_REQUIRE_SIGNED_REQUESTS=true
# Optional bounded request settings; defaults are safe when omitted.
# VIRT_CLOUD_AGENT_MAX_BODY_BYTES=1048576
# VIRT_CLOUD_AGENT_REQUEST_TIMEOUT=15s