diff --git a/modules/console/pages/config/configure-console.adoc b/modules/console/pages/config/configure-console.adoc index 041702a6fd..7ce81546e4 100644 --- a/modules/console/pages/config/configure-console.adoc +++ b/modules/console/pages/config/configure-console.adoc @@ -1,4 +1,3 @@ - = Configure Redpanda Console :description: Learn how to configure Redpanda Console using environment variables, YAML files, or command-line arguments. :page-aliases: console:reference/config.adoc, reference:console/config.adoc @@ -22,7 +21,7 @@ For example: [cols="1m,1m"] |=== -|YAML|Environment Variable +|YAML|Environment variable |kafka.rackId |KAFKA_RACKID @@ -96,6 +95,11 @@ spec: #brokers: [] # Auto-configured to connect to this Redpanda cluster server: listenPort: 8080 + auditLog: + enabled: false # default; set to true to write audit logs to stdout + additionalHeaders: # specifies HTTP headers to include in audit logs + - "X-Forwarded-For" + - "User-Agent" # Add any other Redpanda Console configuration here ---- + @@ -121,6 +125,9 @@ console: #brokers: [] # Auto-configured to connect to this Redpanda cluster server: listenPort: 8080 + auditLog: + enabled: false # default; set to true to write audit logs to stdout + additionalHeaders: # specifies HTTP headers to include in audit logs # Add any other Redpanda Console configuration here ---- + @@ -152,6 +159,11 @@ config: - redpanda-1.redpanda.svc.cluster.local:9092 server: listenPort: 8080 + auditLog: + enabled: false # default; set to true to write audit logs to stdout + additionalHeaders: # specifies HTTP headers to include in audit logs + - "X-Forwarded-For" + - "User-Agent" # Add any other Redpanda Console configuration here ---- @@ -177,7 +189,7 @@ console: container_name: redpanda-console image: docker.redpanda.com/redpandadata/console:{latest-console-tag} entrypoint: /bin/sh - command: -c 'echo "$$CONSOLE_CONFIG_FILE" > /tmp/config.yml + command: -c 'echo "$$CONSOLE_CONFIG_FILE" > /tmp/config.yml' volumes: - ./config:/tmp/config/ environment: @@ -187,6 +199,11 @@ console: # See https://docs.redpanda.com/current/console/config/connect-to-redpanda/ kafka: brokers: ["redpanda-0:9092","redpanda-1:9092","redpanda-2:9092"] + auditLog: + enabled: false # default; set to true to write audit logs to stdout + additionalHeaders: # specifies HTTP headers to include in audit logs + - "X-Forwarded-For" + - "User-Agent" ---- [[config-yaml]] @@ -203,7 +220,9 @@ The following YAML file contains a complete list of all Redpanda Console configu xref:shared:attachment$redpanda-console-config.yaml[Download the sample file]. .redpanda-console-config.yaml + [,yaml] ---- include::shared:attachment$redpanda-console-config.yaml[] ----- + +---- \ No newline at end of file diff --git a/modules/shared/attachments/redpanda-console-config.yaml b/modules/shared/attachments/redpanda-console-config.yaml index 0d06c9fb9b..6a5427a814 100644 --- a/modules/shared/attachments/redpanda-console-config.yaml +++ b/modules/shared/attachments/redpanda-console-config.yaml @@ -271,6 +271,11 @@ console: # -----END PRIVATE KEY----- # privateKeyFilepath: /path/to/private/key # passphrase: + auditLog: + enabled: false # default; set to true to write audit logs to stdout + additionalHeaders: # specifies HTTP headers to include in audit logs + - "X-Forwarded-For" + - "User-Agent" #---------------------------------------------------------------------------- # Server settings