README.md

casbin-redis-adapter

Redis policy storage, implemented as an adapter for node-casbin.

Installation

npm install --save casbin-redis-adapter
// or
yarn add casbin-redis-adapter

Usage

Require it in a place, where you are instantiating an enforcer (read more about enforcer here):

import {newEnforcer} from 'casbin';
import {NodeRedisAdapter} from './adapter' ;
import {join} from 'path';

const model = join(__dirname, 'casbin_conf/model.conf');
const adapter = await NodeRedisAdapter.newAdapter({host: "127.0.0.1", port: 6379});
const enforcer = await newEnforcer(model, adapter);

That is all what required for integrating the adapter into casbin.

Configuration

NodeRedisAdapter.newAdapter() takes the following parameters as an object to establish the connection with redis-server

options: interface IConnectionOptions {
    host: string // IP address of the Redis server
    port: number //	Port of the Redis server
}

redisOpts ? : redis.ClientOpts //https://github.com/NodeRedis/node-redis#options-object-properties

License

Apache-2.0