diff --git a/docker/compose/scim.env b/docker/compose/scim.env index 8f70480..f2fd77e 100644 --- a/docker/compose/scim.env +++ b/docker/compose/scim.env @@ -20,5 +20,8 @@ OP_LETSENCRYPT_DOMAIN=op-scim.example.com # set it to a full redis:// or rediss:// (for TLS) URL #OP_REDIS_URL=redis://scim.internal.localnet.com:6379 -# OP_JSON_LOGS can be set to '1' if you would like the SCIM bridge to output logs in JSON rather than a human-readable format, can be useful for things like custom log ingestion in your environment -#OP_JSON_LOGS=1 +# OP_PRETTY_LOGS can be set to '1' if you would like the SCIM bridge to output logs in a human-readable format, which can be useful if you're not planning on ingesting these logs externally +#OP_PRETTY_LOGS=1 + +# OP_DEBUG enables more detailed logging, which can be useful during troubleshooting or debugging +#OP_DEBUG=1 diff --git a/docker/swarm/scim.env b/docker/swarm/scim.env index 325c8c4..3c82484 100644 --- a/docker/swarm/scim.env +++ b/docker/swarm/scim.env @@ -15,8 +15,11 @@ OP_LETSENCRYPT_DOMAIN=op-scim.example.com # it can be set to a redis:// or rediss:// (for TLS) URL #OP_REDIS_URL=redis://scim.internal.localnet.com:6379 -# OP_JSON_LOGS can be set to '1' if you would like the SCIM bridge to output logs in JSON rather than a human-readable format, can be useful for things like custom log ingestion in your environment -#OP_JSON_LOGS=1 +# OP_PRETTY_LOGS can be set to '1' if you would like the SCIM bridge to output logs in a human-readable format, which can be useful if you're not planning on ingesting these logs externally +#OP_PRETTY_LOGS=1 + +# OP_DEBUG enables more detailed logging, which can be useful during troubleshooting or debugging +#OP_DEBUG=1 # OP_SESSION can be either the base64-encoded string of a `scimsession` file, or it can be the path to a `scimsession` file (as in a Docker Swarm Secret) # examples: "OP_SESSION=abcdefg123456", "OP_SESSION=/path/to/scimsession" diff --git a/kubernetes/README.md b/kubernetes/README.md index bc653ee..3bf95a4 100644 --- a/kubernetes/README.md +++ b/kubernetes/README.md @@ -147,6 +147,10 @@ If you are using an existing redis instance that's not running on `redis://redis You would then omit the the `redis-*.yaml` files when deploying to your Kubernetes cluster. -### JSON-formatted Logs +### Human-Readable Logs -You can set `OP_JSON_LOGS` to `1` if you would like the SCIM bridge to output logs in JSON format. This can be helpful if you are doing custom log ingestion in your environment. +You can set `OP_PRETTY_LOGS` to `1` if you would like the SCIM bridge to output logs in a human-readable format. This can be helpful if you aren’t planning on doing custom log ingestion in your environment. + +### Debug Mode + +You can set `OP_DEBUG` to `1` to enable debug output in the logs. Useful for troubleshooting or when contacting 1Password Support. diff --git a/kubernetes/op-scim-config.yaml b/kubernetes/op-scim-config.yaml index 85804a2..13346ea 100644 --- a/kubernetes/op-scim-config.yaml +++ b/kubernetes/op-scim-config.yaml @@ -8,4 +8,5 @@ data: # (advanced) only change the options below if you need to OP_REDIS_URL: "redis://op-scim-redis:6379" OP_SESSION: "/secret/scimsession" - OP_JSON_LOGS: 0 + OP_PRETTY_LOGS: 0 + OP_DEBUG: 0