🔖 Making release ready

Author: matissecallewaert

Cargo.toml

@@ -1,2 +1,2 @@
 [workspace]
-members = ["feature-extraction-tool", "common", "xtask"]
+members = ["rustiflow", "common", "xtask"]

Dockerfile

@@ -38,4 +38,4 @@ RUN cargo xtask ebpf-ipv6 --release
 RUN cargo build --release
 
 # Command
-ENTRYPOINT ["./target/release/feature-extraction-tool"]
+ENTRYPOINT ["./target/release/rustiflow"]

README.md

@@ -25,7 +25,41 @@ See the wiki for the different feature sets available.
 
 ![RustiFlow Architecture](arch.svg)
 
-## Installation Guide
+## Using the release binary:
+
+Copy the rustiflow binary that you can find in this repo in releases to a location of your choice or to the `/usr/local/bin` folder.
+You can then run the binary with the following commands:
+
+See the [help menu](#usage-instructions) for the different options available.
+
+```bash
+RUST_LOG=info rustiflow pcap basic-flow 60 /path/to/pcap.pcap print
+```
+
+```bash
+sudo RUST_LOG=info rustiflow realtime enp5s0 cic-flow 60 csv /path/to/output.csv
+```
+
+## Using the Container:
+
+Make sure that you don't use docker desktop and that you don't have it installed on your machine. If you have this setup, it will not work as intended as the `--network host` will not link the container to the host network, but to the network of a VM that docker desktop uses.
+
+- **Build the Container**:
+  ```bash
+  docker build -t rustiflow .
+  ```
+- **Run the Container**:
+  ```bash
+  docker run --network host -v /path/on/host:/app rustiflow [ARGS like you are used to]
+  ```
+  Run it with the --privileged flag if you want to capture traffic in real-time.
+- **Example**:
+  ```bash
+  docker run --network host -v /home/user/pcap:/app rustiflow pcap basic-flow 60 /app/pcap.pcap print
+  docker run --privileged --network host -v /home/matisse/Documents:/app rustiflow realtime enp5s0 cic-flow 60 csv /app/output.csv
+  ```
+
+## Installation Guide for development
 
 ### Prerequisites:
 - **libpcap-dev**:
@@ -72,25 +106,6 @@ See the wiki for the different feature sets available.
 
 ## Usage Instructions
 
-### Using the Container:
-
-Make sure that you don't use docker desktop and that you don't have it installed on your machine. If you have this setup, it will not work as intended as the `--network host` will not link the container to the host network, but to the network of a VM that docker desktop uses.
-
-- **Build the Container**:
-  ```bash
-  docker build -t rustiflow .
-  ```
-- **Run the Container**:
-  ```bash
-  docker run --network host -v /path/on/host:/app rustiflow [ARGS like you are used to]
-  ```
-  Run it with the --privileged flag if you want to capture traffic in real-time.
-- **Example**:
-  ```bash
-  docker run --network host -v /home/user/pcap:/app rustiflow pcap basic-flow 60 /app/pcap.pcap print
-  docker run --privileged --network host -v /home/matisse/Documents:/app rustiflow realtime enp5s0 cic-flow 60 csv /app/output.csv
-  ```
-
 ### Real-Time Traffic Capture:
 - **Command Help**:
   ```bash
@@ -99,7 +114,7 @@ Make sure that you don't use docker desktop and that you don't have it installed
   ```bash
   Real-time feature extraction
 
-  Usage: feature-extraction-tool realtime [OPTIONS] <INTERFACE> <FLOW_TYPE> <LIFESPAN> <METHOD> [EXPORT_PATH]
+  Usage: rustiflow realtime [OPTIONS] <INTERFACE> <FLOW_TYPE> <LIFESPAN> <METHOD> [EXPORT_PATH]
 
   Arguments:
     <INTERFACE>
@@ -150,7 +165,7 @@ Make sure that you don't use docker desktop and that you don't have it installed
   ```bash
   Feature extraction from a pcap file
 
-  Usage: feature-extraction-tool pcap [OPTIONS] <FLOW_TYPE> <LIFESPAN> <PATH> <METHOD> [EXPORT_PATH]
+  Usage: rustiflow pcap [OPTIONS] <FLOW_TYPE> <LIFESPAN> <PATH> <METHOD> [EXPORT_PATH]
 
   Arguments:
     <FLOW_TYPE>

feature-extraction-tool/Cargo.toml rustiflow/Cargo.tomlfeature-extraction-tool/Cargo.toml renamed to rustiflow/Cargo.toml

@@ -1,5 +1,5 @@
 [package]
-name = "nids-feature-extraction-tool"
+name = "rustiflow"
 version = "0.1.0"
 edition = "2021"
 publish = false
@@ -27,11 +27,11 @@ bytes = "1"
 env_logger = "0.11"
 chrono = "0.4.34"
 dashmap = "5.5.3"
-pcap = "1.3.0"
+pcap = "2.0.0"
 pnet = "0.34.0"
 lazy_static = "1.4.0"
 libc = "0.2.153"
 
 [[bin]]
-name = "feature-extraction-tool"
+name = "rustiflow"
 path = "src/main.rs"