npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@imcatzilla/ghost-sso-header

v1.0.0

Published

Header SSO Adapter for Ghost

Downloads

5

Readme

Warning

Before using this adapter please carefully read Caveats section below

ghost-sso-header

Header SSO Adapter for Ghost

Prerequisites

This adapter is written for Ghost version 5.75.0, compatibility with other versions is unknown

Your load balancer (reverse proxy, API gateway, etc) needs to add request header with user email or user object as JSON string

This can be done with:

Installation

Linux

  1. Download package via npm:
npm install @imcatzilla/ghost-sso-header
  1. Move package to content/adapters/sso directory:
mv node_modules/@imcatzilla/ghost-sso-header/ /path-to-ghost/content/adapters/sso/ghost-sso-header/
  1. Adjust Ghost configuration with following:
"adapters": {
    "sso": {
        "active": "ghost-sso-header",
        "ghost-sso-header": {
            "header": "X-User",
            "jsonpath": "$.email"
        }
    }
}

or use environment variables as described in Ghost Configuration section

Docker

Follow steps 1 and 3 from Linux section, and mount adapter as volume in your docker-compose.yml:

services:
  ghost:
    #...
    volumes:
      - ./node_modules/@imcatzilla/ghost-sso-header:/var/lib/ghost/content/adapters/sso/ghost-sso-header

you may also build custom docker image and include adapter inside it

Configuration

| Key | Type | Default | Description | | :-- | :-- | :-- | :-- | | header | string | X-User | Header with user email. Header value must contain email as string if jsonpath is omitted | | jsonpath | string | | JSONPath to user email if header value is json string |

All options are optional

Caveats

  • Malicious users may set user header manually. Make sure that this header get stripped by your load balancer or reverse proxy. In case you are using Traefik, you may use headers middleware for this
  • This adapter does not automatically create accounts in Ghost. The account must exist in Ghost database to be able to login with SSO
  • Ghost uses separate session, so after you logout in your identity provider, you still be authenticated in Ghost
  • Logout in Ghost will not work while identity provider session is active
  • Direct login with Ghost email/password still work when no identity provider session is active
  • Use this adapter at your own risk, and do not consider it "production-ready". I wrote it for my personal projects, so no warranties at all