Skip to content

Commit

Permalink
Apply suggestions from code review
Browse files Browse the repository at this point in the history
Formatting and case, adds links

Co-authored-by: Federico Di Pierro <[email protected]>
Signed-off-by: Bill Vandenberk <[email protected]>
  • Loading branch information
2 people authored and poiana committed Aug 30, 2024
1 parent 8030c03 commit 4053c6e
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 5 deletions.
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@ Considerations and guidance for Falco adopters:
5. Integrate with output destinations: Integrate Falco with SIEM, data lake systems, or other preferred output destinations to establish a robust foundation for comprehensive data analysis and enable effective incident response workflows.

### Demo Environment

A demo environment is provided via a docker-compose file that can be started on a docker host which includes falco, falcosidekick, falcosidekick-ui and its required redis database. For more information see the [docker-compose section](docker/docker-compose/)

## How to Contribute
Expand Down
12 changes: 7 additions & 5 deletions docker/docker-compose/README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,17 @@
# Warning
This environment is provided for demonstration purposes only and does not represent a production ready deployment of falco

This environment is provided for demonstration purposes only and does not represent a production ready deployment of Falco.

# Components
The components that this docker-compose file spins up are falco, falcosidekick, falcosidekick-ui and a redis database
The components that this docker-compose file spins up are [Falco](https://falco.org/), [falcosidekick](https://github.com/falcosecurity/falcosidekick), [falcosidekick-ui](https://github.com/falcosecurity/falcosidekick-ui) and a [redis](https://redis.io/) database.

# Running
To start this environment run `docker-compose up`
Note: You may need to use sudo for falco to start correctly.
To start this environment run `docker-compose up`.
Note: You may need to use sudo for Falco to start correctly.

# Cleaning up
To clean up run `docker-compose rm`

To clean up run `docker-compose rm`.

# Generating events
If you'd like to generate events that will trigger rules and show up in the UI you can run `docker run -it --rm falcosecurity/event-generator run syscall --loop`

0 comments on commit 4053c6e

Please sign in to comment.