docs: suggest disabling the default GitHub OAuth2 provider on k8s (cherry-pick #16758) (#16783)

Cherry-picked docs: suggest disabling the default GitHub OAuth2 provider
on k8s (#16758)

For production deployments we recommend disabling the default GitHub
OAuth2 app managed by Coder. This PR mentions it in k8s installation
docs and the helm README so users can stumble upon it more easily.

Co-authored-by: Hugo Dutka <hugo@coder.com>
This commit is contained in:
gcp-cherry-pick-bot[bot]
2025-03-03 17:48:55 -06:00
committed by GitHub
parent fc0db40791
commit 99a5d72a8d
2 changed files with 8 additions and 0 deletions

View File

@ -101,6 +101,10 @@ coder:
# postgres://coder:password@postgres:5432/coder?sslmode=disable
name: coder-db-url
key: url
# For production deployments, we recommend configuring your own GitHub
# OAuth2 provider and disabling the default one.
- name: CODER_OAUTH2_GITHUB_DEFAULT_PROVIDER_ENABLE
value: "false"
# (Optional) For production deployments the access URL should be set.
# If you're just trying Coder, access the dashboard via the service IP.

View File

@ -47,6 +47,10 @@ coder:
# This env enables the Prometheus metrics endpoint.
- name: CODER_PROMETHEUS_ADDRESS
value: "0.0.0.0:2112"
# For production deployments, we recommend configuring your own GitHub
# OAuth2 provider and disabling the default one.
- name: CODER_OAUTH2_GITHUB_DEFAULT_PROVIDER_ENABLE
value: "false"
tls:
secretNames:
- my-tls-secret-name