ghost-oauth

ghost-oauth is an early TypeScript project exploring external authentication for Ghost staff users. The exported adapter class is currently named NiceOAuth.

No authentication strategy is implemented yet. The current adapter methods return null, so this package is not ready for use with Ghost.

The current milestone is M1: Forward Auth Mode. It will add a forward-auth adapter for existing Ghost staff users, with Caddy and Authelia as the baseline deployment and additional oauth2-proxy examples.

Later milestones may consider:

• forwarded JWTs verified by the adapter
• a native OpenID Connect login flow
• claims and Ghost role reconciliation

Those milestones will be defined after M1 establishes the supported Ghost integration boundary.

Project documents

• Architecture
• Roadmap
• External references

Build

pnpm install
pnpm build

There is no working test suite yet.

Installing and activating

Place the adapter at content/adapters/sso/MySSO/index.js and activate it in your Ghost config:

{
  "adapters": {
    "sso": {
      "active": "NiceOAuth",
      "NiceOAuth": {
        "mode": "x-auth",
        "requiredGroups": ["GhostStaff"] // optional
      }
    }
  }
}

See also https://github.com/TryGhost/Ghost/tree/main/packages/adapters/sso-base#installing-and-activating