Skip to main content
Version: v4

Documentation Home

Welcome to the SuiviBourse documentation.

SuiviBourse monitors your stock portfolio: it fetches live prices from Yahoo! Finance, stores them (together with historical data) in InfluxDB 3 Core, and lets you visualize everything in Grafana.

v5 exists, and it is not an upgrade

SuiviBourse v5 replaces InfluxDB 3 and Grafana with a single embedded store and a first-party interface. There is no upgrade path: a v5 install is a new install, whose store starts empty and is refilled by re-importing your event files. The image was renamed too, so no v5 tag is ever published under the name a v4 deployment pulls — a v4 install that changes nothing keeps running, and one that bumps its tag fails at the pull rather than starting on an empty store.

This documentation stays here, and stays accurate for v4. Switch versions with the selector in the top-right navbar.

Version 4

This documentation covers version >= 4.0, which stores data in InfluxDB 3 Core and adds historical backfill and the events configuration mode.

Looking for the previous release? Switch to v3 with the version selector in the top-right navbar — v3 stores data in Prometheus and only supports the manual configuration mode.

What's new in v4​

  • InfluxDB 3 Core replaces Prometheus as the primary datastore, unlocking long-term historical storage.
  • Historical backfill: SuiviBourse progressively fills past price data back to your first purchase, so you can see the full evolution of your portfolio.
  • Events mode: describe your portfolio as a list of transactions (BUY, SELL, GRANT, DIVIDEND) in CSV/XLSX files and let SuiviBourse aggregate positions automatically.
  • The legacy Prometheus endpoint is still exposed for backward compatibility.

Start with the Getting Started guide, or see the changelog for what landed in each release since v4.

Support​

To report a problem or request a feature, please open a ticket on the GitHub page.

Contributing​

Pull requests welcome, as long as they're not overly specific to a niche use-case. Please read and follow the contributing documentation.

Licence​

This project is under the MIT license.

Credits​

A big thank you to the contributors and maintainers of the projects SuiviBourse relies on.