This repository has been archived on 2022-08-14. You can view files and clone it, but cannot push or open issues or pull requests.
outline/server/auth/providers/README.md

711 B
Raw Blame History

Authentication Providers

A new auth provider can be added with the addition of a single file in this folder, and (optionally) a matching logo in /app/components/AuthLogo/index.js that will appear on the signin 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