https://github.com/casbin/redis-watcher

Redis WatcherEx for Casbin
https://github.com/casbin/redis-watcher

abac access-control acl auth authorization authz casbin go golang rbac redis watcher watcherex

Last synced: 5 days ago
JSON representation

Redis WatcherEx for Casbin

• Host: GitHub
• URL: https://github.com/casbin/redis-watcher
• Owner: casbin
• License: apache-2.0
• Created: 2021-04-14T14:18:14.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2023-07-20T01:09:37.000Z (over 1 year ago)
• Last Synced: 2024-10-29T22:37:49.181Z (16 days ago)
• Topics: abac, access-control, acl, auth, authorization, authz, casbin, go, golang, rbac, redis, watcher, watcherex
• Language: Go
• Homepage: https://github.com/casbin/casbin
• Size: 41 KB
• Stars: 34
• Watchers: 3
• Forks: 37
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
Redis Watcher 

---

> For Go 1.17+, use v2.4.0+ ,  

> For Go 1.16 and below, stay on v2.3.0.  

[![Go](https://github.com/casbin/redis-watcher/actions/workflows/ci.yml/badge.svg)](https://github.com/casbin/redis-watcher/actions/workflows/ci.yml)

[![report](https://goreportcard.com/badge/github.com/casbin/redis-watcher)](https://goreportcard.com/report/github.com/casbin/redis-watcher)

[![Coverage Status](https://coveralls.io/repos/github/casbin/redis-watcher/badge.svg?branch=master)](https://coveralls.io/github/casbin/redis-watcher?branch=master)

[![Go Reference](https://pkg.go.dev/badge/github.com/casbin/redis-watcher/v2.svg)](https://pkg.go.dev/github.com/casbin/redis-watcher/v2)

[![Release](https://img.shields.io/github/v/release/casbin/redis-watcher)](https://github.com/casbin/redis-watcher/releases/latest)

Redis Watcher is a [Redis](http://redis.io) watcher for [Casbin](https://github.com/casbin/casbin).

## Installation

    go get github.com/casbin/redis-watcher/v2

## Simple Example

```go

package main

import (

	"log"

	"github.com/casbin/casbin/v2"

	rediswatcher "github.com/casbin/redis-watcher/v2"

	"github.com/redis/go-redis/v9"

)

func updateCallback(msg string) {

	log.Println(msg)

}

func main() {

	// Initialize the watcher.

	// Use the Redis host as parameter.

	w, _ := rediswatcher.NewWatcher("localhost:6379", rediswatcher.WatcherOptions{

		Options: redis.Options{

			Network:  "tcp",

			Password: "",

		},

		Channel:    "/casbin",

		// Only exists in test, generally be true

		IgnoreSelf: false,

	})

	// Or initialize the watcher in redis cluster.

	// w, _ := rediswatcher.NewWatcherWithCluster("localhost:6379,localhost:6379,localhost:6379", rediswatcher.WatcherOptions{

	// 	ClusterOptions: redis.ClusterOptions{

	// 		Password: "",

	// 	},

	// 	Channel: "/casbin",

	// 	IgnoreSelf: false,

	// })

	// Initialize the enforcer.

	e, _ := casbin.NewEnforcer("examples/rbac_model.conf", "examples/rbac_policy.csv")

	// Set the watcher for the enforcer.

	_ = e.SetWatcher(w)

	// Set callback to local example

	_ = w.SetUpdateCallback(updateCallback)

	

	// Or use the default callback

	// _ = w.SetUpdateCallback(rediswatcher.DefaultUpdateCallback(e))

	// Update the policy to test the effect.

	// You should see "[casbin rules updated]" in the log.

	_ = e.SavePolicy()

	// Only exists in test

	fmt.Scanln()

}

```

## Getting Help

- [Casbin](https://github.com/casbin/casbin)

- [go-redis](https://github.com/go-redis/redis)

## License

This project is under Apache 2.0 License. See the [LICENSE](LICENSE) file for the full license text.