docs(readme): improve with comprehensive flow diagram #134
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Add badges for Go version and license - Add detailed features section highlighting key capabilities - Add Mermaid sequence diagram showing complete request flow - Add architecture section explaining hybrid storage approach - Add configuration examples for HAProxy and SPOA - Add monitoring section with Prometheus metrics examples - Add development section with build/test instructions - Improve overall structure and formatting
- Add CrowdSec AppSec as separate participant in Mermaid diagram - Show AppSec receiving HTTP request data from SPOA - Show AppSec analyzing requests and potentially overriding remediation - Update request flow details to explain AppSec integration
- Update Mermaid diagram to show AppSec is called when remediation = allow OR AlwaysSend = true - Update request flow details to explain AlwaysSend behavior - AppSec can analyze requests even when remediation is ban/captcha if AlwaysSend is enabled
- Remove CrowdSec acknowledgment (internal project) - Add links to BART GitHub repository wherever mentioned - Promote BART by linking it in features and architecture sections
- Show client sending HTTP request to HAProxy as the initial step - Clarify the sequence of events starting from client request
- Show SPOA actively polling LAPI every X seconds - Update note to reflect polling behavior
- Captcha validation updates remediation to allow - Flow naturally falls through to Remediation = allow branch
- Update initial request to show HTTP or TCP - Add conditional branches for HTTP vs TCP processing - Show different message types (crowdsec-http vs crowdsec-tcp) - Show different response handling for TCP (connection close vs forward) - AppSec only applies to HTTP requests
- Properly nest HTTP response handling within HTTP branch - Add TCP response handling (close connection vs forward)
- Move message type selection into HTTP/TCP conditional branches - Each branch shows its specific message type and processing - Eliminates duplicate 'TCP request' references
LaurenceJJones
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
"update readme.md"