Documentation changes to address : Maintainer Alignment: Documentatio… #96
There are no files selected for viewing
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
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,76 @@ | ||
| --- | ||
| title: Config Validation | ||
| description: Detect drift between running config and saved snapshots | ||
| --- | ||
|
|
||
| # Config Validation | ||
|
|
||
| The Config Validation feature allows you to detect configuration drift between the current running configuration of CrowdSec Manager and saved configuration snapshots. This helps ensure consistency and identify unintended changes. | ||
|
|
||
| ## Features | ||
|
|
||
| - **Configuration Drift Detection**: Compare running configuration against saved snapshots | ||
| - **Snapshot Management**: Create, list, and restore configuration snapshots | ||
| - **Detailed Diff Reports**: View specific differences between configurations | ||
| - **Automated Validation**: Schedule regular configuration validation checks | ||
|
|
||
| ## API Endpoints | ||
|
|
||
| The Config Validation exposes the following API endpoints under the `/api/config-validation` prefix: | ||
|
|
||
| ### Snapshots | ||
|
|
||
| - `POST /config-validation/snapshot` - Create a new configuration snapshot | ||
|
Comment on lines
+19
to
+23
There was a problem hiding this comment.
This section documents a full Useful? React with 👍 / 👎. |
||
| - `GET /config-validation/snapshots` - List all saved configuration snapshots | ||
| - `GET /config-validation/snapshot/:id` - Get details of a specific snapshot | ||
| - `DELETE /config-validation/snapshot/:id` - Delete a configuration snapshot | ||
|
|
||
| ### Validation | ||
|
|
||
| - `POST /config-validation/validate` - Validate current configuration against a snapshot | ||
| - `GET /config-validation/validation/:id` - Get results of a specific validation | ||
| - `GET /config-validation/validations` - List all validation results | ||
|
|
||
| ### Restoration | ||
|
|
||
| - `POST /config-validation/restore/:id` - Restore configuration from a snapshot | ||
|
|
||
| ## Usage Examples | ||
|
|
||
| ### Creating a Snapshot | ||
|
|
||
| ```bash | ||
| curl -X POST http://localhost:8080/api/config-validation/snapshot \ | ||
| -H "Content-Type: application/json" \ | ||
| -d '{ | ||
| "name": "pre-update-backup", | ||
| "description": "Backup before applying security updates" | ||
| }' | ||
| ``` | ||
|
|
||
| ### Validating Configuration | ||
|
|
||
| ```bash | ||
| curl -X POST http://localhost:8080/api/config-validation/validate \ | ||
| -H "Content-Type: application/json" \ | ||
| -d '{ | ||
| "snapshot_id": "abc123", | ||
| "check_items": ["api_config", "database_config", "docker_settings"] | ||
| }' | ||
| ``` | ||
|
|
||
| ### Restoring from Snapshot | ||
|
|
||
| ```bash | ||
| curl -X POST http://localhost:8080/api/config-validation/restore/abc123 | ||
| ``` | ||
|
|
||
| ## Configuration | ||
|
|
||
| Config validation behavior can be customized through environment variables or the configuration file. Refer to the [Configuration](../configuration/index.mdx) documentation for details. | ||
|
|
||
| ## Related Topics | ||
|
|
||
| - [Configuration](../configuration/index.mdx) | ||
| - [Backup and Restore](../features/backups.mdx) | ||
| - [History](../features/history.mdx) | ||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,93 @@ | ||
| --- | ||
| title: History | ||
| description: Decision history with trends, charts, geographic data | ||
| --- | ||
|
|
||
| # History | ||
|
|
||
| The History feature provides persistent storage and analysis of CrowdSec decisions and alerts over time. This enables you to track security events, identify trends, and generate reports for compliance and auditing purposes. | ||
|
|
||
| ## Features | ||
|
|
||
| - **Decision History**: Persistent storage of all bans, captchas, and other decisions made by CrowdSec. | ||
| - **Alert History**: Complete history of alerts generated by CrowdSec scenarios. | ||
| - **Trend Analysis**: Visualize security event trends over time with charts and graphs. | ||
| - **Geographic Data**: View the geographic origin of attacks on a world map. | ||
| - **Repeated Offenders**: Identify IP addresses that repeatedly trigger security events. | ||
| - **Configurable Retention**: Set how long history data is stored before automatic cleanup. | ||
| - **Reapply Decisions**: Re-insert historical decisions back into CrowdSec for immediate effect. | ||
| - **Bulk Operations**: Reapply multiple historical decisions at once. | ||
|
|
||
| ## API Endpoints | ||
|
|
||
| The History exposes the following API endpoints under the `/api` prefix: | ||
|
|
||
| ### Decision History | ||
|
|
||
| - `GET /crowdsec/decisions/history` - Retrieve persisted decision history with filtering options. | ||
| - `POST /crowdsec/decisions/history/reapply` - Re-insert a historical decision into CrowdSec. | ||
| - `POST /crowdsec/decisions/history/bulk-reapply` - Re-insert multiple historical decisions. | ||
|
|
||
| ### Alert History | ||
|
|
||
| - `GET /crowdsec/alerts/history` - Retrieve persisted alert history with filtering options. | ||
|
|
||
| ### History Statistics | ||
|
|
||
| - `GET /crowdsec/history/stats` - Get aggregate counts for the history dashboard. | ||
|
|
||
| ### Configuration | ||
|
|
||
| - `GET /crowdsec/history/config` - Get current history retention configuration. | ||
| - `PUT /crowdsec/history/config` - Update history retention configuration. | ||
|
|
||
| ### Repeated Offenders | ||
|
|
||
| - `GET /crowdsec/decisions/repeated-offenders` - Get list of repeated offenders from history. | ||
|
|
||
| ### Hub Operation History | ||
|
|
||
| - `GET /hub/history` - List hub operation history with filtering options. | ||
| - `GET /hub/history/:id` - Get details of a specific hub operation. | ||
|
|
||
| ## Usage Examples | ||
|
|
||
| ### Retrieving Decision History | ||
|
|
||
| ```bash | ||
| curl "http://localhost:8080/api/crowdsec/decisions/history?limit=100&scenario=crowdsecurity/ssh-bf&since=24h" | ||
| ``` | ||
|
|
||
| ### Reapplying a Decision | ||
|
|
||
| ```bash | ||
| curl -X POST http://localhost:8080/api/crowdsec/decisions/history/reapply \ | ||
| -H "Content-Type: application/json" \ | ||
| -d '{ | ||
| "id": 12345, | ||
| "type": "ban", | ||
| "duration": "24h", | ||
| "reason": "Reapplying due to continued malicious activity" | ||
| }' | ||
| ``` | ||
|
|
||
| ### Updating History Retention | ||
|
|
||
| ```bash | ||
| curl -X PUT http://localhost:8080/api/crowdsec/history/config \ | ||
| -H "Content-Type: application/json" \ | ||
| -d '{ | ||
| "retention_days": 30 | ||
| }' | ||
| ``` | ||
|
|
||
| ## Configuration | ||
|
|
||
| History behavior can be customized through environment variables or the configuration file. Refer to the [Configuration](../configuration/index.mdx) documentation for details. | ||
|
|
||
| ## Related Topics | ||
|
|
||
| - [Configuration](../configuration/index.mdx) | ||
| - [Decisions](../features/decisions.mdx) | ||
| - [Alerts](../features/alerts.mdx) | ||
| - [Hub Browser](../features/hub.mdx) |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,86 @@ | ||
| --- | ||
| title: Hub Browser | ||
| description: Browse, install, upgrade CrowdSec collections, parsers, scenarios | ||
| --- | ||
|
|
||
| # Hub Browser | ||
|
|
||
| The Hub Browser allows you to manage CrowdSec hub items (collections, parsers, scenarios, postoverflows, etc.) directly from the CrowdSec Manager interface. You can browse available items, install new ones, upgrade existing items, and remove items you no longer need. | ||
|
|
||
| ## Features | ||
|
|
||
| - **Browse Hub Items**: View all available hub items by category. | ||
| - **Install Items**: Install new hub items from the CrowdSec hub. | ||
| - **Upgrade Items**: Upgrade installed hub items to their latest versions. | ||
| - **Remove Items**: Remove hub items that are no longer needed. | ||
| - **Manual Apply**: Apply custom YAML configurations directly to the CrowdSec container. | ||
| - **Preference Management**: Set default behaviors for hub operations per category. | ||
| - **Operation History**: Audit all hub operations performed through the manager. | ||
|
|
||
| ## API Endpoints | ||
|
|
||
| The Hub Browser exposes the following API endpoints under the `/api/hub` prefix: | ||
|
|
||
| ### Categories | ||
|
|
||
| - `GET /hub/categories` - List all supported hub categories with metadata. | ||
|
|
||
| ### Items | ||
|
|
||
| - `GET /hub/list` - Legacy endpoint for browsing all hub items (raw format). | ||
| - `GET /hub/:category/items` - List hub items for a specific category. | ||
| - `POST /hub/:category/install` - Install a hub item in the specified category. | ||
| - `POST /hub/:category/remove` - Remove a hub item from the specified category. | ||
| - `POST /hub/:category/manual-apply` - Apply a custom YAML file to the CrowdSec container. | ||
|
|
||
| ### Preferences | ||
|
|
||
| - `GET /hub/preferences` - Get all hub preferences. | ||
| - `GET /hub/preferences/:category` - Get preference for a specific category. | ||
| - `PUT /hub/preferences/:category` - Update preference for a specific category. | ||
|
|
||
| ### History | ||
|
|
||
| - `GET /hub/history` - List hub operation history with filtering options. | ||
| - `GET /hub/history/:id` - Get details of a specific hub operation. | ||
|
|
||
| ### Upgrades | ||
|
|
||
| - `POST /hub/upgrade` - Upgrade all hub items to their latest versions. | ||
|
|
||
| ## Usage Examples | ||
|
|
||
| ### Listing Categories | ||
|
|
||
| ```bash | ||
| curl http://localhost:8080/api/hub/categories | ||
| ``` | ||
|
|
||
| ### Installing a Scenario | ||
|
|
||
| ```bash | ||
| curl -X POST http://localhost:8080/api/hub/scenarios/install \ | ||
| -H "Content-Type: application/json" \ | ||
| -d '{"item_name": "crowdsecurity/ssh-bf"}' | ||
| ``` | ||
|
|
||
| ### Applying Custom YAML | ||
|
|
||
| ```bash | ||
| curl -X POST http://localhost:8080/api/hub/parsers/manual-apply \ | ||
| -H "Content-Type: application/json" \ | ||
| -d '{ | ||
| "filename": "custom-parser.yaml", | ||
| "yaml": "filter: ...", | ||
| "target_path": "/etc/crowdsec/parsers/custom-parser.yaml" | ||
| }' | ||
| ``` | ||
|
|
||
| ## Configuration | ||
|
|
||
| Hub behavior can be customized through environment variables or the configuration file. Refer to the [Configuration](../configuration/index.mdx) documentation for details. | ||
|
There was a problem hiding this comment.
This link points to Useful? React with 👍 / 👎. |
||
|
|
||
| ## Related Topics | ||
|
|
||
| - [Configuration](../configuration/index.mdx) | ||
| - [Backup and Restore](../features/backups.mdx) | ||
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The
Podfile.lockfile should typically be tracked in version control for application projects. It ensures that all developers and the CI/CD environment use the exact same versions of dependencies, preventing inconsistent behavior across environments caused by version mismatches.