README.md

User documentation

These documents explain how to install and operate ATLANTIS.

ATLANTIS reads nfcapd captures from a NetFlow collector. The pipeline converts the captures into a SQLite database, and the dashboard visualizes that database. CSV input is also available as an adapter for external datasets.

Before you start

Have this available:

• nfcapd capture files on disk, in the layout that dataset configuration shows.
• Approximately 30 minutes. The one-time tool builds take most of this time.

The pipeline can run in Docker instead of a host Rust and C toolchain. The dashboard always runs natively.

First use

1. Install the required tools. Choose the Docker or native pipeline path.
2. Install the project dependencies.
3. Define a dataset that points at your captures.
4. Build and verify the database.
5. Run the dashboard.

If a step fails, read Troubleshooting.

Other tasks

• Query a database
• Verify, publish, and deploy

The code documentation gives architecture and development information.