Skip to content
Merged
27 changes: 23 additions & 4 deletions modules/console/pages/config/configure-console.adoc
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -22,7 +21,7 @@ For example:

[cols="1m,1m"]
|===
|YAML|Environment Variable
|YAML|Environment variable

|kafka.rackId
|KAFKA_RACKID
Expand Down Expand Up @@ -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
----
+
Expand All @@ -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
----
+
Expand Down Expand Up @@ -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
----

Expand All @@ -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:
Expand All @@ -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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Needs an example otherwise it's unclear how to use

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also it defaults to: ["X-Forwarded-For", "User-Agent"]

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

please check me!

- "X-Forwarded-For"
- "User-Agent"
----

[[config-yaml]]
Expand All @@ -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[]
----

----
5 changes: 5 additions & 0 deletions modules/shared/attachments/redpanda-console-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -271,6 +271,11 @@ console:
# -----END PRIVATE KEY-----
# privateKeyFilepath: /path/to/private/key
# passphrase: <optional_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
Expand Down
Loading