From 83f986e266ce2a058c909f002595bc8aa039cda0 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Jan=20Lo=C5=A1=C5=A5=C3=A1k?= <jan.lostak@upol.cz>
Date: Sat, 22 Feb 2025 21:28:17 +0100
Subject: [PATCH] Added missing example config

---
 config.example.yaml | 45 +++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 45 insertions(+)
 create mode 100644 config.example.yaml

diff --git a/config.example.yaml b/config.example.yaml
new file mode 100644
index 0000000..1d5fa28
--- /dev/null
+++ b/config.example.yaml
@@ -0,0 +1,45 @@
+# Server configuration.
+host: 0.0.0.0
+port: 9090
+
+# Log level.
+# Panic = 0, Fatal = 1, Error = 2, Warn = 3, 
+# Info = 4, Debug = 5, Trace = 6
+logLevel: 6
+
+# Proxmox API.
+proxmox:
+  # Proxmox API token configuration.
+  # Ensure you assign the 'PVEAuditor' permission to both the user and the API token when generating the token.
+  # For security reasons, assign only the 'PVEAuditor' role to limit permissions appropriately.
+  token:
+    tokenId: super
+    secret: secret
+
+  # Proxmox API hosts.
+  # If you are running a multi-node cluster, add multiple API hosts to ensure high availability of metrics.
+  # Note: This configuration is not intended for gathering metrics from multiple PVE clusters.
+  #       For multiple PVE clusters, deploy a separate exporter instance for each cluster.
+  hosts: []
+
+  # Scrape interval in seconds.
+  interval: 15
+
+  # Proxmox metrics configuration.
+  metrics:
+    # Enable collection of cluster state metrics.
+    clusterState: true
+    # Enable collection of LXC container metrics.
+    lxc: true
+    # Enable collection of QEMU virtual machine metrics.
+    qemu: true
+    # Enable collection of physical disk metrics.
+    disk: true
+    # Enable collection of node storage metrics.
+    storage: true
+    # Enable collection of node status metrics.
+    nodeStatus: true
+    # Enable collection of node subscription details.
+    subscription: true
+    # Enable collection of software-defined network (SDN) metrics.
+    sdn: true
\ No newline at end of file