Skip to content

CONFIGURATION.md

Latest commit

 

History

History
101 lines (79 loc) · 2.71 KB

CONFIGURATION.md

File metadata and controls

101 lines (79 loc) · 2.71 KB
Raw

Configuration Reference

The configuration for Proxmox-GitOps and the container libraries is split into several files.

General Configuration

General Proxmox VE configuration and credentials (./local/config.json or ./local/config.local.json):

{
  "proxmox": {
    "host":       "(set)", 
    "user":       "(adjust)",
    "password":   "(set)",

    "node":       "(adjust)",
    "gateway":    "(adjust)",
    "mask":       "(adjust)",
    "interface":  "(adjust)",
    "bridge":     "(adjust)"
  },

  "login":          "(set)",
  "password":       "(set)"

}

Global Environment

Proxmox-GitOps centralizes configuration via Git. It leverages Utils.Env to access environment variables, which are initially set by ./globals.json or ./globals.local.json.

Container Environment

Defines resource allocation for the Proxmox-GitOps control plane and container libraries.

  • ./container.env or ./container.local.env
  • ./libs/{lib}/container[.local|.stage].env
IP="192.168.178.***"
ID="***"
...
MOUNT="/mnt/..:/share/.."

Advanced Configuration

Persistence

The control plane config defines the (network) /share.

  • Create ./local/share/ to override the Proxmox-GitOps generated default share (e.g., to fix keys or set specific snapshots).
tree -a ./local/share
./local/share
├── .certs
│   ├── .lego
│   │   ├── accounts
│   │   └── certificates
├── .keys
│   ├── 100
│   ├── 100.pub
│   ├── 101
│   ├── ...
└── snapshots
    ├── assistant
    │   ├── assistant-260420.tar.gz
    └── bridge
        ├── bridge-260420.tar.gz
  • Snapshots are automatically restored via Utils.snapshot and written to /share/snapshots/{lib}/ by the snapshot pipeline.

Reverse Proxy

The Caddy-based reverse proxy dynamically includes configuration files via ./libs/proxy/templates/Caddyfile:

<%= domain %> {
    import <%= @config_dir %>/*<%= hostname %>.caddy
   ...
} <% end -%>
import <%= @config_dir %>/*.local.caddy

You can inject custom logic via .caddy and .local.caddy files, for example in ./libs/proxy/files/default/config/10-assistant.local.caddy:

proxmox.gitops.pm {
    @denied not remote_ip 192.168.178.0/24
    abort @denied
    tls /share/.certs/cert.crt /share/.certs/cert.key
    import default assistant 192.168.178.110:8123
}