diff --git a/README.md b/README.md index 960a45fddd2..4bb2fb04337 100644 --- a/README.md +++ b/README.md @@ -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 diff --git a/docker/docker-compose/README.md b/docker/docker-compose/README.md index 4c67432c771..f57c71fdd07 100644 --- a/docker/docker-compose/README.md +++ b/docker/docker-compose/README.md @@ -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` \ No newline at end of file