Skip to content

Commit

Permalink
Merge branch 'main' into develop
Browse files Browse the repository at this point in the history
  • Loading branch information
bengo237 committed Sep 24, 2024
2 parents 434342f + 0b40046 commit c367c8e
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 10 deletions.
Empty file added LICENSE
Empty file.
32 changes: 22 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,36 @@
[![Snort3 Docker Image CI/CD](https://github.com/bengo237/snort-docker/actions/workflows/docker-image.yml/badge.svg)](https://github.com/bengo237/snort-docker/actions/workflows/docker-image.yml)
# Snort3 Docker Image
# Snort3 Docker Image 3.2.2.0

This repository offers a Dockerized deployment of [Snort3](https://www.snort.org/), a robust network intrusion prevention system, facilitating the utilization of Snort3 for Network Functions Virtualization (NFV).
This repository provides a Dockerized deployment of [Snort3](https://www.snort.org/), a powerful network intrusion prevention system. It simplifies the use of Snort3 for Network Functions Virtualization (NFV).

## Verifying Snort Configuration
## Docker Image Usage

> **Note:** Depending on your setup, you may need to use `sudo` for Docker commands.
To validate the Snort configuration, execute the following command:
To launch the Snort3 Docker container with full network access, use the following command:

```bash
snort -c /usr/local/etc/snort/snort.lua
docker run -it --rm --net=host ghcr.io/bengo237/snort3:latest /bin/bash
```

## Docker Image Usage
In some cases, you might need to add `--cap-add=NET_ADMIN` or `--privileged` to the Docker command. However, be cautious when using `--privileged` as it grants all capabilities to the container, which requires careful consideration.

Note: Depending on your setup, you may require `sudo` for Docker commands.
## Verifying Snort Configuration

To launch the Snort3 Docker container with complete network access, utilize the following command:
To validate the Snort configuration, run the following command:

```bash
docker run -it --rm --net=host ghcr.io/bengo237/snort3:latest /bin/bash
snort -c /usr/local/etc/snort/snort.lua
```

In certain scenarios, you might need to append `--cap-add=NET_ADMIN` or `--privileged` to the Docker command. Nonetheless, exercising caution is advised when using `--privileged` since it grants all capabilities to the container, warranting careful consideration.
## Additional Resources

For more information on Snort3 and its configuration, visit the [official Snort documentation](https://www.snort.org/documents).

## Contributing

Contributions are welcome! Please fork the repository and submit a pull request with your changes.

## License

This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.

0 comments on commit c367c8e

Please sign in to comment.