Files
outline/docs/AUTHENTICATION_PROVIDERS.md
Tom Moor 21a1257d06 chore: Move remaining auth methods to plugins (#4900)
* Move Google, Email, and Azure to plugins

* Move OIDC provider, remove old loading code

* Move AuthLogo to plugin

* AuthLogo -> PluginIcon

* Lazy load plugin settings
2023-02-19 19:52:08 -08:00

745 B
Raw Permalink Blame History

Authentication Providers

A new auth provider can be added with the addition of a plugin with a koa router as the default export in /server/auth/[provider].ts and (optionally) a matching logo in /client/Icon.tsx that will appear on the sign-in button.

Auth providers generally use Passport strategies, although they can use any custom logic if needed. See the google auth provider for the cleanest example of what is required some rules:

  • The strategy name must be lowercase
  • The strategy must call the accountProvisioner command in the verify callback
  • The auth file must export a config object with name and enabled keys
  • The auth file must have a default export with a koa-router