mirror/opengist
1
0
Fork 0
mirror of https://github.com/thomiceli/opengist.git synced 2024-12-24 13:12:39 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
opengist/docs/configuration/oauth-providers.md
Thomas Miceli 6d31ef9732
Add Vitepress docs (#326) 
* Add vitepress for docs

* some fix

* Use vitepress and update docs

* Use vitepress and update docs

* Update README.md

* Add favicon

* Add docs by @jiriks74

Co-authored-by: jiriks74 <jiri@stefka.eu>

---------

Co-authored-by: jiriks74 <jiri@stefka.eu>
2024-09-12 01:47:15 +02:00

2.6 KiB
Raw Blame History

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>

    OG_GITHUB_CLIENT_KEY=<key>
OG_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/

    OG_GITLAB_CLIENT_KEY=<key>
OG_GITLAB_SECRET=<secret>
# URL of the GitLab instance. Default: https://gitlab.com/
OG_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

    OG_GITEA_CLIENT_KEY=<key>
OG_GITEA_SECRET=<secret>
# URL of the Gitea instance. Default: https://gitea.com/
OG_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

    OG_OIDC_CLIENT_KEY=<key>
OG_OIDC_SECRET=<secret>
# Discovery endpoint of the OpenID provider. Generally something like http://auth.example.com/.well-known/openid-configuration
OG_OIDC_DISCOVERY_URL=http://auth.example.com/.well-known/openid-configuration