Add doc for STEAMPIPE_OTEL_INSECURE env var

turbot · Feb 8, 2024 · d0d63c9 · d0d63c9
1 parent f26d8a8
commit d0d63c9
Showing 1 changed file with 18 additions and 0 deletions.
diff --git a/docs/reference/env-vars/steampipe_otel_insecure.md b/docs/reference/env-vars/steampipe_otel_insecure.md
@@ -0,0 +1,18 @@
+---
+title: STEAMPIPE_OTEL_INSECURE
+sidebar_label: STEAMPIPE_OTEL_INSECURE
+---
+# STEAMPIPE_OTEL_INSECURE
+
+To utilize a local, insecure OpenTelemetry server, please configure your environment by setting the `STEAMPIPE_OTEL_INSECURE` environment variable.
+
+Set the `STEAMPIPE_OTEL_INSECURE` to bypass the default secure connection requirements. This enables steampipe to communicate with the OpenTelemetry server without needing SSL/TLS encryption. This can be useful for local testing or when operating within a secure, isolated network where encryption may not be deemed necessary.
+
+## Usage
+
+If you are connecting to a local insecure OpenTelemetry server:
+
+```bash
+export OTEL_EXPORTER_OTLP_ENDPOINT=http://localhost:16686/
+export STEAMPIPE_OTEL_INSECURE=true
+```