caswire

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

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

Go to latest
Published: Aug 20, 2023 License: Apache-2.0 Imports: 5 Imported by: 0

README

📦⚡️ Caswire

An open-source logging and auditing system developed by Go and React.

semantic-release docker pull casbin/caswire GitHub Release Docker Image Version (latest semver)

Go Report Card license GitHub issues GitHub stars GitHub forks

Architecture

Caswire contains 2 parts:

Name Description Language Source code
Frontend Web frontend UI for Caswire Javascript + React https://github.com/casbin/caswire/tree/master/web
Backend RESTful API backend for Caswire Golang + Beego + MySQL https://github.com/casbin/caswire

Installation

Caswire uses Casdoor to manage members. So you need to create an organization and an application for Caswire in a Casdoor instance.

Necessary configuration

Get the code
go get github.com/casbin/casdoor
go get github.com/casbin/caswire

or

git clone https://github.com/casbin/casdoor
git clone https://github.com/casbin/caswire
Setup database

Caswire will store its users, nodes and topics informations in a MySQL database named: caswire, will create it if not existed. The DB connection string can be specified at: https://github.com/casbin/caswire/blob/master/conf/app.conf

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

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

Configure Casdoor

After creating an organization and an application for Caswire in a Casdoor, you need to update clientID, clientSecret, casdoorOrganization and casdoorApplication in app.conf.

Run Caswire
  • Configure and run Caswire by yourself. If you want to learn more about caswire.
  • Open browser: http://localhost:16001/

Optional configuration

Setup your Caswire to enable some third-party login platform

Caswire uses Casdoor to manage members. If you want to log in with oauth, you should see casdoor oauth configuration.

OSS, Mail, and SMS services

Caswire uses Casdoor to upload files to cloud storage, send Emails and send SMSs. See Casdoor for more details.

Contribute

For Caswire, if you have any questions, you can give Issues, or you can also directly start Pull Requests(but we recommend giving issues first to communicate with the community).

License

Apache-2.0

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