Files
ProxMenux/oci/catalog/overlays/wg-easy.json
T
MacRimiandClaude Opus 5 bcabcb618c feat(oci): run official container images as native LXC containers
Adds the OCI manager: an engine that turns a Docker Compose file into an
LXC definition, a catalog of 365 applications drawn from LinuxServer.io
and other container image sources, and a per-instance registry recording
what each container was built from. Reachable from the main menu.

Catalog text is translated like every other string in the project: the
taglines go through translate() and land in lang/*.json, so the entries
read in all eight languages instead of only English.

Translation cache builder:
- a failed translation leaves the key absent rather than writing English,
  which previously made the string count as translated forever
- a result identical to a 3+ word source is rejected, catching a provider
  that silently returns the text it was given
- strings that are nothing but glossary terms keep their source spelling
  instead of being discarded as failures
- no backoff between attempts when the provider is deterministic
- application names are protected so "HAOS One" survives translation
- argos joins the provider list, and the workflow reads the OCI sources

Audit & Report:
- findings that moved in the wrong direction between runs are reported
  alongside the ones that improved
- an accepted risk can carry a review date and is flagged when it falls due
- backup checks explain in plain language what they looked at and what to
  do next

Monitor:
- disks can be excluded from periodic reads, and an idle disk says so
  instead of showing a stale temperature
- per-disk identity survives a controller or enclosure change
- scheduled Borg backups resolve their SSH key from the repository entry
- PVE upgrades log the package list and the resulting dpkg changes

The web build no longer copies scripts/ into public/: the documentation
links to GitHub, so nothing read that folder.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
2026-09-22 18:24:59 +02:00

131 lines
3.9 KiB
JSON

{
"container_contract": {
"image": {
"reference": "ghcr.io/wg-easy/wg-easy:15",
"tag": "15"
},
"environment": [
{
"name": "PASSWORD",
"example": "",
"required": false,
"sensitive": true,
"prompt_user": false,
"source": "wg-easy-v15-refuses-to-start-with-this-variable"
},
{
"name": "WG_HOST",
"example": "",
"required": false,
"sensitive": false,
"prompt_user": false,
"source": "wg-easy-v15-replaced-by-INIT_HOST"
},
{
"name": "WG_PORT",
"example": "",
"required": false,
"sensitive": false,
"prompt_user": false,
"source": "wg-easy-v15-replaced-by-INIT_PORT"
},
{
"name": "WG_DEFAULT_DNS",
"example": "",
"required": false,
"sensitive": false,
"prompt_user": false,
"source": "wg-easy-v15-replaced-by-INIT_DNS"
},
{
"name": "INSECURE",
"example": "true",
"required": true,
"sensitive": false,
"prompt_user": false,
"source": "wg-easy-optional-configuration"
},
{
"name": "INIT_ENABLED",
"example": "true",
"required": true,
"sensitive": false,
"prompt_user": false,
"source": "wg-easy-unattended-setup"
},
{
"name": "INIT_USERNAME",
"example": "admin",
"required": true,
"sensitive": false,
"prompt": "User name of the administrator of the web interface",
"source": "wg-easy-unattended-setup"
},
{
"name": "INIT_PASSWORD",
"example": "",
"required": true,
"sensitive": true,
"prompt": "Administrator password, at least 12 characters (empty = generated)",
"source": "wg-easy-unattended-setup"
},
{
"name": "INIT_HOST",
"example": "",
"required": true,
"sensitive": false,
"prompt": "Public address clients connect to (vpn.example.com or a public IP)",
"source": "wg-easy-unattended-setup"
},
{
"name": "INIT_PORT",
"example": "51820",
"required": true,
"sensitive": false,
"prompt": "Public UDP port clients connect to",
"source": "wg-easy-unattended-setup"
},
{
"name": "INIT_DNS",
"example": "1.1.1.1",
"required": true,
"sensitive": false,
"prompt": "DNS server written in the client configurations",
"source": "wg-easy-unattended-setup"
}
]
},
"first_run": {
"credentials": [
{
"label": "WireGuard Easy web interface",
"type": "configured-or-installer-generated",
"username": "admin",
"password": null,
"username_environment": "INIT_USERNAME",
"password_environment": "INIT_PASSWORD",
"change_required": false,
"source": "wg-easy-unattended-setup",
"retrieval": null
}
]
},
"proxmox": {
"installer_profile": {
"generated_sensitive_environment": {
"INIT_PASSWORD": {
"strategy": "token-hex",
"bytes": 16,
"prompt": true
}
},
"completion_notes": [
"The administrator account, the public address and the UDP port are created on the first start, so the web interface opens directly on its login page.",
"The web interface is served over plain HTTP on port 51821 (INSECURE=true). Keep it inside the local network or publish it through a reverse proxy with TLS.",
"The initial user name and password stay written in /etc/pve/lxc/<CTID>.conf as INIT_USERNAME and INIT_PASSWORD. They can be removed after the first login, with the container stopped.",
"Clients reach the VPN through the public address and the UDP port given during the installation, so that port must be forwarded to this container."
]
}
}
}