diff --git a/docs/v1.X/docs/user_guide/network.md b/docs/v1.X/docs/user_guide/network.md new file mode 100644 index 000000000..aa2d66232 --- /dev/null +++ b/docs/v1.X/docs/user_guide/network.md @@ -0,0 +1,39 @@ + +# Ports inventory + + - `tcp/8080` exposes a [REST API](https://crowdsecurity.github.io/api_doc/index.html?urls.primaryName=LAPI) for bouncers, `cscli` and comunication between crowdsec agent and local api + - `tcp/6060` (endpoint `/metrics`) exposes [prometheus metrics](https://doc.crowdsec.net/Crowdsec/v1/observability/prometheus/) + - `tcp/6060` (endpoint `/debug`) exposes pprof debugging metrics + +# Outgoing connections + + - Local API connects to `tcp/443` on `api.crowdsec.net` (signal push and blocklists pull) + - `cscli` connects to `tcp/443` on `raw.githubusercontent.com` to fetch scenarios, parsers etc. + - `cscli dashboard` fetches metabase configuration from a s3 bucket (`https://crowdsec-statics-assets.s3-eu-west-1.amazonaws.com/`) + + + +# Comunication between components + +## Bouncers -> Local API + + - Bouncers are using Local API on `tcp/8080` by default + +## Agents -> Local API + + - Agents connect to local API on port `tcp/8080` (only relevant ) + +## Local API -> Central API + + - Central API is reached on port `tcp/443` by Local API. The FQDN is `api.crowdsec.net` + +## Local API -> Database + + - When using a networked database (PostgreSQL or MySQL), only the local API needs to access the database, agents don't have to be able to comunicate with it. + +## Prometheus -> Agents + + - If you're scrapping prometheus metrics from your agents or your local API, you need to allow inbound connections to `tcp/6060` + + + diff --git a/docs/v1.X/mkdocs.yml b/docs/v1.X/mkdocs.yml index ec3c069e6..9ef3ecc43 100644 --- a/docs/v1.X/mkdocs.yml +++ b/docs/v1.X/mkdocs.yml @@ -15,10 +15,11 @@ nav: - Parsers: user_guide/configurations_management/parsers.md - Enrichers: user_guide/configurations_management/enrichers.md - Scenarios: user_guide/configurations_management/scenarios.md - - Decisions Management: user_guide/decision_management.md + - Decisions management: user_guide/decision_management.md - Bouncers & machines management: user_guide/bouncer_machine_management.md - Databases: user_guide/database.md - - Simulation Management: user_guide/simulation_mode.md + - Network management: user_guide/network.md + - Simulation management: user_guide/simulation_mode.md - Crowdsec forensic mode: user_guide/forensic_mode.md - Debugging: user_guide/debugging_configs.md - CLI: