Skip to content

Commit

Permalink
fix: update readme with quickstart details
Browse files Browse the repository at this point in the history
  • Loading branch information
JFWenisch committed Dec 23, 2024
1 parent 67499d6 commit d1166d4
Showing 1 changed file with 22 additions and 4 deletions.
26 changes: 22 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,36 @@
# ipfix-generator ![Build](https://github.com/JFWenisch/ipfix-generator/actions/workflows/build.yml/badge.svg) ![Version](https://img.shields.io/github/v/release/jfwenisch/ipfix-generator) ![License](https://img.shields.io/github/license/jfwenisch/ipfix-generator) ![Size](https://img.shields.io/github/repo-size/jfwenisch/ipfix-generator)
### Overview
This IPFIX (IP Flow Information Export) Generator is a tool designed to create and send IPFIX traffic for testing, demonstration, and analysis purposes. It simulates network flow data by generating IPFIX packets, which can be used to test network monitoring systems, analyze network performance, and ensure the accuracy of flow data collection.
## Overview
This IPFIX (IP Flow Information Export) Generator is a tool designed to create and send IPFIX traffic for testing, demonstration, and analysis purposes. It simulates network flow data by generating IPFIX packets, which can be used to test network monitoring systems, analyze network performance, and ensure the accuracy of flow data collection. It features a graphical user interface (GUI) for ease of use and can also be accessed via its API and REST endpoints.


The IPFIX Message Generator is a versatile tool designed for generating IPFIX (IP Flow Information Export) messages for testing purposes. It features a graphical user interface (GUI) for ease of use and can also be accessed via its API and REST endpoints.

### Features

## Features
- **Graphical User Interface (GUI)**: User-friendly interface for generating and managing IPFIX messages.

- **API Access**: Programmatic access to generate IPFIX messages via REST Endpoints allowing integration with other tools and systems.

- **Customizable Parameters**: Configure various parameters for IPFIX message generation.



## Quickstart


### Prerequisites

- Docker installed on your machine

### Steps to Run

1. **Pull the Docker Image**:
Run the Docker Container: Use the following command to run the Docker container, making sure to map port 8080
```bash
docker run -p 8080:8080 ghcr.io/jfwenisch/ipfix-generator:latest
2. **Access the GUI** : Open your web browser and navigate to http://localhost:8080. You will see the graphical user interface (GUI) of the IPFIX Message Generator.
![IPFIX Generator](https://raw.githubusercontent.com/JFWenisch/ipfix-generator/refs/heads/main/docs/img/preview_home.jpeg)
3. **Set Parameters and Create a New Generator Job** : Use the GUI to set the desired parameters and create a new generator job. The interface is user-friendly and allows you to configure various parameters for IPFIX message generation.

## Contributing
Contributions are welcome! Please fork the repository and submit pull requests.

Expand Down

0 comments on commit d1166d4

Please sign in to comment.