opengist/docs/administration/oauth-providers.md

Use OAuth providers

Opengist can be configured to use OAuth to authenticate users, with GitHub, Gitea, or OpenID Connect.

Github

• Add a new OAuth app in your GitHub account settings
• Set 'Authorization callback URL' to http://opengist.url/oauth/github/callback
• Copy the 'Client ID' and 'Client Secret' and add them to the configuration :

  github.client-key: <key>
  github.secret: <secret>
  

GitLab

• Add a new OAuth app in Application settings from the GitLab instance
• Set 'Redirect URI' to http://opengist.url/oauth/gitlab/callback
• Copy the 'Client ID' and 'Client Secret' and add them to the configuration :

  gitlab.client-key: <key>
  gitlab.secret: <secret>
  # URL of the GitLab instance. Default: https://gitlab.com/
  gitlab.url: https://gitlab.com/
  

Gitea

• Add a new OAuth app in Application settings from the Gitea instance
• Set 'Redirect URI' to http://opengist.url/oauth/gitea/callback
• Copy the 'Client ID' and 'Client Secret' and add them to the configuration :

  gitea.client-key: <key>
  gitea.secret: <secret>
  # URL of the Gitea instance. Default: https://gitea.com/
  gitea.url: http://localhost:3000
  

OpenID Connect

• Add a new OAuth app in Application settings of your OIDC provider
• Set 'Redirect URI' to http://opengist.url/oauth/openid-connect/callback
• Copy the 'Client ID', 'Client Secret', and the discovery endpoint, and add them to the configuration :

  oidc.client-key: <key>
  oidc.secret: <secret>
  # Discovery endpoint of the OpenID provider. Generally something like http://auth.example.com/.well-known/openid-configuration
  oidc.discovery-url: http://auth.example.com/.well-known/openid-configuration