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

@dekproject/keycloak

v1.0.4

Published

Keycloak interface plugin for DEK

Downloads

6

Readme

@dekproject/keycloak

Keycloak interface plugin for DEK

What does this plugin do?

  • Create a basic connection with Keycloak
  • Use express-session to create session

What is Keycloak?

For more information access: https://www.keycloak.org/about.html

Instalation

To install the bootstrap we recommend using the CLI

$ npm i -g @dekproject/cli
$ dek install keycloak

Config

  • Access the administrative panel of Keycloak, create a new realm
  • Already connected to the new realm, access the clients option and create a new client
  • In the new client settings, look for the Calid Redirect URIs option, add '*', and save
  • In the Installation tab, select the Keycloak format OIDC JSON
  • create the keycloak.json file in the root directory of the application and paste the settings

sample

{
    "realm": "myrealm",
    "auth-server-url": "http://localhost:8080/auth",
    "ssl-required": "external",
    "resource": "test",
    "public-client": true,
    "confidential-port": 0
}

Usage

Using direct

$ npm i @dekproject/scope
import express from "express";
import session from "express-session";
import cookieParser from "cookie-parser";
import bodyParser from "body-parser";

import { $, plugins, keycloak, memoryStore } from "@dekproject/scope";

(async () => {
    await plugins("");

    $.set("app", express());
    $.app.use(bodyParser.urlencoded({ extended: false }));
    $.app.use(bodyParser.json());

    const PORT = process.env.PORT || 5555;

    $.wait("keycloak").then(async () => {
        $.app.use( cookieParser() );

        $.app.use(session({
            secret: 'secret',
            resave: false,
            saveUninitialized: true,
            store: memoryStore
        }));

        $.app.use( keycloak.middleware( { logout: '/logout' } ));

        $.app.get('/', (req, res) => { res.send("insecure content").end(); });

        $.app.get('/protect', keycloak.protect(), (req, res) => {
            res.send("protected content").end();
        });

        $.app.listen(PORT, () => {
            console.log(`App listening on port ${PORT}!`);
        });
    });
})();

Using in the standard DEK skeleton

import session from "express-session";
import { $, app, keycloak, memoryStore } from "@dekproject/scope";
import routes from "@dekproject/routes";

$.wait(["app", "keycloak"]).then(() => {
    $.app.use(session({
        secret: 'secret',
        resave: false,
        saveUninitialized: true,
        store: memoryStore
    }));

    $.app.use( keycloak.middleware( { logout: '/logout' } ));

    $.app.get('/', (req, res) => { res.send("insecure content").end(); });

    $.app.get('/protect', keycloak.protect(), (req, res) => {
        res.send("protected content").end();
    });

    $.app.listen(PORT, () => {
        console.log(`App listening on port ${PORT}!`);
    });
});