Skip to content

Commit 4053c6e

Browse files
bbl232FedeDP
authored andcommitted
Apply suggestions from code review
Formatting and case, adds links Co-authored-by: Federico Di Pierro <[email protected]> Signed-off-by: Bill Vandenberk <[email protected]>
1 parent 8030c03 commit 4053c6e

File tree

2 files changed

+8
-5
lines changed

2 files changed

+8
-5
lines changed

README.md

+1
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,7 @@ Considerations and guidance for Falco adopters:
4444
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.
4545

4646
### Demo Environment
47+
4748
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/)
4849

4950
## How to Contribute

docker/docker-compose/README.md

+7-5
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,17 @@
11
# Warning
2-
This environment is provided for demonstration purposes only and does not represent a production ready deployment of falco
2+
3+
This environment is provided for demonstration purposes only and does not represent a production ready deployment of Falco.
34

45
# Components
5-
The components that this docker-compose file spins up are falco, falcosidekick, falcosidekick-ui and a redis database
6+
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.
67

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

1112
# Cleaning up
12-
To clean up run `docker-compose rm`
13+
14+
To clean up run `docker-compose rm`.
1315

1416
# Generating events
1517
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 commit comments

Comments
 (0)