docs: add metrics and oidc config (#255)

autobrr · Jan 31, 2025 · 95e51e2 · 95e51e2
1 parent c7bd06c
commit 95e51e2
Show file tree

Hide file tree

Showing 3 changed files with 49 additions and 14 deletions.
diff --git a/docs/configuration/authentication.md b/docs/configuration/authentication.md
@@ -40,11 +40,12 @@ For more details on Authentik setup, see:
 Choose one of these configuration methods:
 
 ```toml title="config.toml"
-oidc_enabled = true
-oidc_issuer = "https://your-identity-provider"
-oidc_client_id = "your-client-id"
-oidc_client_secret = "your-client-secret"
-oidc_redirect_url = "https://your-autobrr-instance/api/auth/oidc/callback"
+oidcEnabled = true
+oidcIssuer = "https://your-identity-provider"
+oidcClientId = "your-client-id"
+oidcClientSecret = "your-client-secret"
+oidcRedirectUrl = "https://your-autobrr-instance/api/auth/oidc/callback"
+oidcDisableBuiltInLogin = false
 ```
 
 Or using environment variables:
@@ -55,6 +56,7 @@ AUTOBRR__OIDC_ISSUER=https://your-identity-provider
 AUTOBRR__OIDC_CLIENT_ID=your-client-id
 AUTOBRR__OIDC_CLIENT_SECRET=your-client-secret
 AUTOBRR__OIDC_REDIRECT_URL=https://your-autobrr-instance/api/auth/oidc/callback
+AUTOBRR__OIDC_DISABLE_BUILT_IN_LOGIN=false
 ```
 
 :::info Authentication Methods

diff --git a/docs/configuration/autobrr.md b/docs/configuration/autobrr.md
@@ -92,19 +92,42 @@ sessionSecret = "secret-session-key"
 # OpenID Connect Configuration
 #
 # Enable OIDC authentication
-#oidc_enabled = false
-
+#oidcEnabled = false
+#
 # OIDC Issuer URL (e.g. https://auth.example.com)
-#oidc_issuer = ""
-
+#oidcIssuer = ""
+#
 # OIDC Client ID
-#oidc_client_id = ""
-
+#oidcClientId = ""
+#
 # OIDC Client Secret
-#oidc_client_secret = ""
-
+#oidcClientSecret = ""
+#
 # OIDC Redirect URL (e.g. http://localhost:7474/api/auth/oidc/callback)
-#oidc_redirect_url = ""
+#oidcRedirectUrl = ""
+#
+# Disable Built In Login Form (only works when using external auth)
+#oidcDisableBuiltInLogin = false
+
+# Metrics
+#
+# Enable metrics endpoint
+#metricsEnabled = true
+
+# Metrics server host
+#
+#metricsHost = "127.0.0.1"
+
+# Metrics server port
+#
+#metricsPort = "9074"
+
+# Metrics basic auth
+#
+# Comma separate list of user:password. Password must be htpasswd bcrypt hashed. Use autobrrctl to generate.
+# Only enabled if correctly set with user:pass.
+#
+#metricsBasicAuthUsers = ""
 
 # Custom definitions
 #

diff --git a/docs/installation/docker.md b/docs/installation/docker.md
@@ -79,6 +79,16 @@ services:
       - AUTOBRR__POSTGRES_PASS=string
       - AUTOBRR__POSTGRES_SSLMODE=string
       - AUTOBRR__POSTGRES_EXTRA_PARAMS=string
+      - AUTOBRR__OIDC_ENABLED=bool
+      - AUTOBRR__OIDC_ISSUER=string
+      - AUTOBRR__OIDC_CLIENT_ID=string
+      - AUTOBRR__OIDC_CLIENT_SECRET=string
+      - AUTOBRR__OIDC_REDIRECT_URL=string
+      - AUTOBRR__OIDC_DISABLE_BUILT_IN_LOGIN=bool
+      - AUTOBRR__METRICS_ENABLED=bool
+      - AUTOBRR__METRICS_HOST=string
+      - AUTOBRR__METRICS_PORT=int
+      - AUTOBRR__METRICS_BASIC_AUTH_USERS=string
 ```
 
 ### Manually configure autobrr (optional) {#manually-configure-autobrr}