Getting Started

There are multiple ways to run SuiviBourse, but Docker Compose is the easiest way to get started — it launches the full stack: the app, a pre-configured InfluxDB 3 Core and a Grafana with a ready-made dashboard.

To see every deployment option, visit the deployment section.

1. Install requirements

• Docker (> 19.03.0)
• Docker Compose

2. Get the project

Download the source code from the latest release, extract it, and move into the docker-compose folder.

3. Create your configuration

make init

This gives you a .env (every setting, including a freshly generated InfluxDB token) and a data/ directory (your portfolio). They are yours — no shipped file needs editing from here on, and re-running make init leaves both untouched.

4. Configure your portfolio

Choose one of the two configuration modes.

Manual mode

Edit data/config.yaml to describe the current state of your portfolio:

data/config.yaml

shares:
- name: Apple
  symbol: AAPL
  purchase:
    quantity: 1
    fee: 2
    cost_price: 119.98
  estate:
    quantity: 2
    received_dividend: 2.85

See Manual mode for the full reference.

Events mode

Drop your transactions into data/events/:

data/events/portfolio.csv

date,event_type,symbol,name,quantity,unit_price,fee,amount,notes
2024-01-15,BUY,AAPL,Apple Inc,10,150.00,2.50,,Initial purchase
2024-03-01,DIVIDEND,AAPL,Apple Inc,,,,8.50,Q1 2024

That's all: SuiviBourse detects the event files and switches to events mode on its own — nothing to declare in .env or settings.yaml.

See Events mode for the full CSV format. Events mode also unlocks historical backfill.

5. Run the stack

Run the following command in the docker-compose folder:

docker compose up -d

This starts three containers: suivi-bourse-app, suivi-bourse-influxdb and suivi-bourse-graf.

6. Visit Grafana

Connect to Grafana at http://localhost:3000 with:

• login: admin
• password: admin

and open the Stock share monitoring dashboard.

note

Please wait a few minutes for the first prices to appear. In events mode, historical data is filled in progressively — the further back your first purchase, the longer the full history takes to backfill. See Historical backfill to understand and tune this behaviour.