Skip to content

setup-web.md

Latest commit

 

History

History
70 lines (42 loc) · 1.72 KB

setup-web.md

File metadata and controls

70 lines (42 loc) · 1.72 KB
Raw

Web setup

These instructions guide installing the project tools and running the dashboard.

Required tools

Install the tools in Requirements first. The dashboard needs Git, Bun, and Node.js.

Install the dependencies

  1. Clone the repository.

    git clone https://github.com/flamboh/atlantis.git
cd atlantis

  2. Install the JavaScript dependencies.

    bun install --frozen-lockfile

To change the code and run the full project checks, read Development.

Run the dashboard

The dashboard reads a SQLite database that the pipeline creates from your NetFlow data.

First, configure a dataset. Then, set up the data pipeline to create the database.

  1. If .env does not exist, copy the environment template.

    cp .env.example .env

  2. In .env, set DEFAULT_DATASET to your dataset ID. This step is optional. Without it, the dashboard uses the first discovered dataset.

  3. Start the dashboard.

    bun run dev:web

  4. Open http://localhost:5173.

The dashboard shows one card for each dataset. Select a card to see the charts.

The dashboard automatically discovers each database at data/<dataset-id>/netflow.sqlite. Before the pipeline creates a database, the dashboard shows a "No datasets found" message with setup guidance.

Run both sites

This command starts the dashboard and the landing site:

bun run dev

The dashboard uses port 5173. The landing site uses port 4321.

Use a remote development host

Create an SSH tunnel for the dashboard:

ssh -L 5173:localhost:5173 user@remote-host

Then, open http://localhost:5173 on your local computer.