casbin-hub

command module
v0.0.0-...-bf1678a Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 8, 2023 License: Apache-2.0 Imports: 4 Imported by: 0

README

Casbin-Hub

Casbin-Hub is the official web UI (admin portal) for Casbin models and policies. A security administrator can use it to view & edit Casbin models and policy rules.

Demo

https://hub.casbin.com

Architecture

Casbin-Hub contains 2 parts:

Name Description Language Source code
Frontend Web frontend UI for Casbin-Hub Javascript + React + Ant Design https://github.com/casbin/casbin-hub/tree/master/web
Backend RESTful API backend for Casbin-Hub Golang + Beego + MySQL https://github.com/casbin/casbin-hub

Installation

  • Get the code:
go get github.com/casbin/casbin-hub
  • Setup database:

Casbin-Hub will store its metadata in a MySQL database named: casbin_metadata, will create it if not existed. The DB connection string can be specified at: https://github.com/casbin/casbin-hub/blob/master/conf/app.conf

  • Setup Casbin-Hub to enable some third-party login platform

Casbin-forum provide a way to sign up using Github account, so you may have to get your own GithubAuthClientID, GithubAuthClientSecret first.

You could get them by clicking on this url: https://github.com/settings/developers , You should set Homepage URL to fit your own domain address, for local testing, sethttp://localhost:3000. And set the Authorization callback URL, the same domain address as Homepage URL, for local testing, sethttp://localhost:3000.

  • Modified config files:

Change your own GithubAuthClientID, GithubAuthClientSecret in conf/app.conf, web/src/conf.js.

dataSourceName = root:123@tcp(localhost:3306)/

Casbin-Hub uses XORM to connect to DB, so all DBs supported by XORM can also be used.

  • Run backend (in port 8800):
go run main.go
  • Run frontend (in the same machine's port 3030):
cd web
npm install
npm start
  • Open browser:

http://localhost:3030/

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL