giffels / AUDITOR

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

AUDITOR

Prerequisites

Requires

  • Rust
  • Docker
  • sqlx-cli
  • PostgreSQL
  • bunyan (optional)

Rust

Requires a recent Rust version (MSRV 1.56.1) and cargo.

Ideally installed via rustup:

curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

sqlx

cargo install --version=0.5.7 sqlx-cli --no-default-features --features postgres

bunyan

For nicer logs install bunyan:

cargo install bunyan

Usage

git clone git@github.com:ALU-Schumacher/AUDITOR.git 
cd AUDITOR
./scripts/db_init.sh
cargo run

For nicer logs run AUDITOR like this:

cargo run | bunyan

Running the tests

cargo test

Running the test with output of logs:

TEST_LOG=true cargo test 

Building binaries

Binaries used in production should be built in release mode:

cargo build --release

The binary can then be found in target/release/auditor.

Make sure a database is up and running when starting AUDITOR.

Configuration

AUDITOR is configured via the files in the configuration directory.

License

TODO

About


Languages

Language:Rust 93.0%Language:Shell 3.4%Language:Dockerfile 2.1%Language:Makefile 1.5%