koa-oidc-provider

A fully configurable OpenID Connect Provider based on Nuxt/Koa for the masses.

A slightly more opinionated config-/frontend-wrapper around node-oidc-provider from @panva.

• Author: Sascha Zarhuber
• GitHub: @saschazar21
• Twitter: @saschazar
• Source: https://github.com/saschazar21/koa-oidc-provider
• Issues: https://github.com/saschazar21/koa-oidc-provider/issues
• Releases: https://github.com/saschazar21/koa-oidc-provider/releases

Prerequisites

• Node.JS v8 (LTS: carbon) and above
• MongoDB v3.4 and above (when running locally, services like mlab also work)
• Redis v5 and above (when running locally, services like redislabs also work)

-- OR --

• 🐳 Docker v17.09 CE and above (no extra setup needed, docker-compose.yml-file included)

Build Setup

CAUTION: Make sure to set the appropriate HOST environment variable. More information about variables may be found in the Variables section of the configuration document.

Building locally

# Clone project and change into directory
$ git clone https://github.com/saschazar21/koa-oidc-provider
$ cd koa-oidc-provider

# install dependencies
$ npm install # Or yarn install

# serve with hot reload at localhost:3000 - BE SURE TO SET APPROPRIATE HOST!
$ HOST=example.com npm run dev

# build for production and launch server - BE SURE TO SET APPROPRIATE HOST!
$ HOST=example.com npm run build
$ HOST=example.com npm start

Run using 🐳 Docker

# Clone project and change into directory
$ git clone https://github.com/saschazar21/koa-oidc-provider
$ cd koa-oidc-provider

# build koa-oidc-provider service with appropriate HOST setting
$ docker-compose build --build-arg HOST=example.com koa-oidc-provider

# launch docker compose setup
$ docker-compose up

Configuration

If you want to customize the default configuration to your needs, the full configuration options are explained in /docs/CONFIGURATION.md.

API

The documentation for the API to handle clients, tokens & users may be found under /docs/API.md.

Contribution

Contributors welcome!
If you have resolved an issue, or enhanced the project in any other way; please fork this repository, open up a pull request and drop me a line on twitter.

License

This project is licensed under the MIT license.

Version history

• 0.1.0 - Initial version (unstable).