diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 481d33c1..e57f8ef6 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -1,6 +1,6 @@ repos: - repo: https://github.com/pre-commit/pre-commit-hooks - rev: v4.4.0 + rev: v5.0.0 hooks: - id: check-yaml - id: end-of-file-fixer diff --git a/documentation/docs/getting-started/configuration.mdx b/documentation/docs/getting-started/configuration.mdx index 5cd2ed4c..d3baa47b 100644 --- a/documentation/docs/getting-started/configuration.mdx +++ b/documentation/docs/getting-started/configuration.mdx @@ -24,7 +24,8 @@ Please use this table as a reference. | LOG_FILE_RETENTION | | | | LOG_FILE_COMPRESSION | | | | LOG_FILE_SERIALIZE | Serialize log messages in file into json format (useful for log aggregation platforms) | | -| LOG_FILE_LEVEL | | | +| LOG_FILE_LEVEL | +| LOG_DIAGNOSE | Include diagnosis in log messages | | | STATISTICS_ENABLED | Collect statistics about OPAL clients. | | | STATISTICS_ADD_CLIENT_CHANNEL | The topic to update about the new OPAL clients connection. | | | STATISTICS_REMOVE_CLIENT_CHANNEL | The topic to update about the OPAL clients disconnection. | | diff --git a/documentation/docs/getting-started/running-opal/run-opal-server/security-parameters.mdx b/documentation/docs/getting-started/running-opal/run-opal-server/security-parameters.mdx index 1862e7af..8a0fba6e 100644 --- a/documentation/docs/getting-started/running-opal/run-opal-server/security-parameters.mdx +++ b/documentation/docs/getting-started/running-opal/run-opal-server/security-parameters.mdx @@ -105,3 +105,5 @@ You must then configure the master token like so | Env Var Name | Function | | :--------------------- | :------------------------------------------------------------------- | | OPAL_AUTH_MASTER_TOKEN | the master token generated by the cli (or any other secret you pick) | + +Ensure LOG_DIAGNOSE is set to False to disable diagnostic logging that may expose sensitive information.