summaryrefslogtreecommitdiff
path: root/.env.example
diff options
context:
space:
mode:
Diffstat (limited to '.env.example')
-rw-r--r--.env.example16
1 files changed, 15 insertions, 1 deletions
diff --git a/.env.example b/.env.example
index 328f4c0..d3a2448 100644
--- a/.env.example
+++ b/.env.example
@@ -1,5 +1,19 @@
+# pyvyos device configuration.
+# Copy this file to .env and fill in the values.
+
+# Hostname or IP address of the VyOS device.
VYDEVICE_HOSTNAME=
+
+# API key configured on the device with:
+# set service https api keys id <name> key <secret>
VYDEVICE_APIKEY=
+
+# HTTPS port of the VyOS API (default: 443).
VYDEVICE_PORT=443
+
+# Protocol: "https" (recommended) or "http".
VYDEVICE_PROTOCOL=https
-VYDEVICE_VERIFY_SSL=False \ No newline at end of file
+
+# Verify the TLS certificate of the device.
+# Set to "false" ONLY in lab environments using self-signed certificates.
+VYDEVICE_VERIFY_SSL=true