diff --git a/README.md b/README.md index 48a880c..e92dd09 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,16 @@ # RHIDS [![Build Status](https://travis-ci.org/amrabed/rhids.svg)](https://travis-ci.org/amrabed/rhids) + +Host-based Intrusion Detection System for Linux Containers* + +To use `rhids`, please make sure you have [`strace-docker`](https://github.com/amrabed/strace-docker) installed. `rhids` depends on [`strace-docker`](https://github.com/amrabed/strace-docker) for collecting system calls from running containers. + +## Usage +### Basic install + git clone https://github.com/amrabed/rhids && sudo ./rhids/install + sudo rhids -h +### Using Docker + docker run -it -v /var/log/strace-docker:/var/log/strace-docker amrabed/rhids + + +* Implemented as part of my Ph.D. dissertation research. See [this paper](https://arxiv.org/abs/1611.03056) for more details