Undocumented parameter required for GitHub Oauth #6948
Description
How are you running Flagsmith
- Self Hosted with Docker
- Self Hosted with Kubernetes
- SaaS at flagsmith.com
- Some other way (add details in description below)
Describe the bug
I don't know if this was documented in the past (I couldn't find an issue for it), but...
When setting up GitHub Oauth on the OSS/community edition the oauth_github flag actually needs a full JSON value with scopes, Oauth client ID, and redirect URI.
{"url":"https://github.com/login/oauth/authorize?client_id=<YOUR_CLIENT_ID>&redirect_uri=https://<your domain>/oauth/github&scope=user:email"}
Also, &scope=user:email is required in the URL, or lookup fails with TypeError in the backend.
The actual docs on these pages make no mention of it:
- https://docs.flagsmith.com/administration-and-security/access-control/oauth
- https://docs.flagsmith.com/deployment-self-hosting/core-configuration/running-flagsmith-on-flagsmith
Took a looot of reverse engineering to figure this out.
Can you please update documentation with a note to the URL/scope/redirect URI parameters inside the oauth_github flag in Flagsmith-On-Flagsmith project?
Or, alternatively, fix frontend code so this can be extracted from existing environment variables and auto-generated by Flagsmith.
Steps To Reproduce
I'm running Flagsmith in Kubernetes via Helm chart with separate frontend and backend deployments, but I would expect this issue to persist independent of deployment method (except maybe docker-compose if default values are hardcoded for local dev)
To reproduce, simply set up GitHub Oauth as documented.
Expected behavior
I would expect GitHub oauth to work as decsribed in the docs.
Screenshots
No response