# passport-ghost

> Passport strategy for Ghost OAuth 2.0

Latest version **2.3.1** (published 2017-03-10) · MIT license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install passport-ghost
pnpm add passport-ghost
yarn add passport-ghost
bun add passport-ghost
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 2.3.1 |
| Published | 2017-03-10 |
| First published | 2016-09-28 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 4 |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 8 |
| Author | Ghost Foundation |
| Maintainers | erisds, kevinansfield, kirrg001 |
| Keywords | auth, ghost, passportjs, oauth2 |

## Links

- npm: https://www.npmjs.com/package/passport-ghost
- Repository: https://github.com/TryGhost/passport-ghost
- Homepage: https://ghost.org
- Issues: https://github.com/TryGhost/passport-ghost/issues
- npm.io page: https://npm.io/package/passport-ghost

## Dependencies (4)

- [lodash](https://npm.io/package/lodash.md) ^4.16.6
- [bluebird](https://npm.io/package/bluebird.md) ^3.4.1
- [ghost-ignition](https://npm.io/package/ghost-ignition.md) ^2.8.7
- [passport-oauth2](https://npm.io/package/passport-oauth2.md) 1.1.2

## Alternatives

- [@pothos/plugin-authz](https://npm.io/package/@pothos/plugin-authz.md) — 12.4K weekly downloads
- [@bounded-sh/client](https://npm.io/package/@bounded-sh/client.md) — 3.2K weekly downloads
- [@luigi-project/plugin-auth-oauth2](https://npm.io/package/@luigi-project/plugin-auth-oauth2.md) — 2.3K weekly downloads
- [@nocobase/plugin-verification](https://npm.io/package/@nocobase/plugin-verification.md) — 2.0K weekly downloads
- [escher-request](https://npm.io/package/escher-request.md) — 545 weekly downloads

## Recent versions

- 2.3.1 (latest) — 2017-03-10
- 2.3.0 — 2017-03-08
- 2.2.4 — 2017-02-28
- 2.2.3 — 2017-02-16
- 2.2.2 — 2017-02-14
- 2.2.1 — 2017-02-13
- 2.2.0 — 2016-12-03
- 2.1.0 — 2016-12-03
- 2.0.0 — 2016-11-21
- 1.3.0 — 2016-11-08
- 1.2.0 — 2016-11-07
- 1.1.0 — 2016-11-04
- 1.0.3 — 2016-10-26
- 1.0.2 — 2016-10-19
- 1.0.1 — 2016-10-13
- … 1 more at https://npm.io/package/passport-ghost/versions

## README

# passport-ghost
Passport adapter for logging in with Ghost.org


## install
```
npm install passport-ghost
```

## usage

```
var GhostStrategy = require('passport-ghost').Strategy;

var ghostStrategy = new GhostStrategy({
  redirectUri: 'your-redirect-url',          [required]
  blogUri: 'your-blog-url',                  [required]
  url: 'your-own-auth-server-url',           [required]
  passReqToCallback: true                    [optional]
  retries                                    [optional] default 10
  retryTimeout                               [optional] default 5000ms
  retryHook: function                        [optional] If an error occurs while retrying, you can define a hook to get notified
}, callback);

ghostStrategy.registerClient({
  name: 'your-client-name',                  [required]
  description: 'your blog description'       [optional]
});

ghostStrategy.updateClient({
  clientId: 'your-client-id',                [required]
  clientSecret: 'your-client-secret',        [required]
  name: 'your-client-name',                  [optional]
  description: 'your blog description',      [optional]
  redirectUri: 'your-redirect-url',          [optional]
  blogUri: 'your-blog-url'                   [optional]
});
```

# Copyright & License

Copyright (c) 2016-2017 Ghost Foundation - Released under the [MIT license](LICENSE).

---
_Source: https://npm.io/package/passport-ghost · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._