console: add admonitions to documentation markdown

This commit is contained in:
Vincent Bernat
2025-07-14 16:45:32 +02:00
parent 41ee631b37
commit 8ac89407fd
6 changed files with 490 additions and 38 deletions

View File

@@ -33,26 +33,26 @@ explore the features.
To connect your own network devices:
1. **Disable demo data**:
1. Disable demo data:
- Remove the reference to `docker-compose-demo.yml` from `.env`
- Comment out the last line in `akvorado.yaml`
1. **Customize the configuration** in `akvorado.yaml`:
1. Customize the configuration in `akvorado.yaml`:
- Set SNMP communities for your devices in `outlet``metadata``provider``communities`
- Configure interface classification rules in `outlet``core``interface-classifiers`
1. **Configure your routers/switches** to send flows to *Akvorado*:
1. Configure your routers/switches to send flows to *Akvorado*:
- NetFlow/IPFIX: port 2055
- sFlow: port 6343
1. **Restart all containers**
1. Restart all containers:
- `docker compose down --volumes`
- `docker compose up -d`
> [!IMPORTANT]
> [!TIP]
> Interface classification is essential for the web interface to work properly.
> Without it, you won't see data in the dashboard widgets or visualization tab.
> See the [configuration guide](02-configuration.md) for details.
> See the [configuration guide](02-configuration.md#classification) for details.
### Need help?
@@ -65,6 +65,11 @@ You can get all the expanded configuration (with default values) with
`docker compose exec akvorado-orchestrator akvorado orchestrator
--check --dump /etc/akvorado/akvorado.yaml`.
> [!IMPORTANT]
> Please, do not open an issue or start a discussion unless you have read the
> various chapters of the documentation, notably the [troubleshooting
> guide](05-troubleshooting.md).
## Big picture
![General design](design.svg)