Skip to content

๐Ÿš€ Getting Started

Welcome to LibreFolio! This guide walks you through registering an account, logging in, and importing your first broker statement to instantly populate your dashboard.


๐Ÿ“ 1. Register Your Account

Navigate to the LibreFolio URL (e.g., http://localhost:6040) and you'll see the login page. Click Register to create a new account.

Registration Form

Fill in your details:

  • ๐Ÿ‘ค Username: Your display name (unique across the system)
  • ๐Ÿ“ง Email: A valid email address
  • ๐Ÿ”‘ Password: A strong password (the strength indicator helps you)
Registration with Password Strength

First User = Admin

The very first user to register automatically becomes the system administrator (superuser). This user can manage global settings, promote other users, and access all admin features.


๐Ÿ” 2. Log In

After registering, you'll be redirected to the login page. Enter your credentials to access your dashboard.

Login Page

๐Ÿฆ 3. Import Your First Statement (Create Broker & Assets On-the-Fly)

When you first log in, you will be greeted by an empty dashboard with no data.

Empty Dashboard

In LibreFolio, the fastest way to get started is by importing your transaction history directly. You don't need to configure brokers or assets beforehand: the system will automatically create them for you during the import process!

๐Ÿ“‹ Steps

  1. Upload Your Statement: Navigate to the Transactions page from the sidebar menu. Click the "Import" button () or drag & drop your broker statement file (CSV or PDF) directly onto the page.

    Wizard Step 1: Upload

  2. Parser Configuration: The wizard will automatically detect the broker format. You can verify the settings (such as dates and delimiters) and configure fallback options if using a generic CSV report.

    Wizard Step 2: Parser Configuration

    Reprocessing Existing Statements

    You can also re-process any previously uploaded statement directly from the Files & Uploads page. This is particularly useful after an import plugin update or if you accidentally deleted some transactions and want to restore them.

  3. Analysis & Parsing: The system reads, validates, and parses the statement rows. You will see a progress bar indicating the parsing speed and status.

    Wizard Step 3: Analysis

  4. Broker & Asset Resolution: If the report contains a broker account or assets (such as ETFs or stocks) that do not yet exist in your LibreFolio instance, the system flags them. You can search for existing ones or create them on-the-fly directly inside the wizard with pre-filled details. For more information, see the Import from Broker - Asset Mapping guide.

    Wizard Step 4: Resolution

  5. Duplicate Detection: The wizard compares statement transactions against your existing ledger. It groups potential matches into two UI status badges based on 4 confidence levels:

    Wizard Step 5: Duplicate Detection

    UI Badge Confidence Level Criteria / Matching Rules
    โš ๏ธ LIKELY LIKELY_WITH_ASSET Basic fields and description match, and asset auto-resolved (highly confident duplicate).
    โš ๏ธ LIKELY LIKELY Basic fields and description match, but asset is not resolved.
    โ„น๏ธ POSSIBLE POSSIBLE_WITH_ASSET Basic fields match, and asset is auto-resolved (but description differs or is empty).
    โ„น๏ธ POSSIBLE POSSIBLE Basic fields (type, date, quantity, amount) match, but asset is not resolved.
    โœ… UNIQUE โ€” The transaction has no matching records in the database and is classified as new (no duplicate detected).
    โŒ UNRESOLVED โ€” The broker or financial instrument was not matched to an existing entity in the database (requires resolution in Step 4 before importing).

    For duplicate rules and configuration options, see the Import from Broker - Duplicate Detection section.

  6. Staging & Final Review: Review the parsed transaction list. Once you verify everything is correct, click Import to save all transactions to your portfolio.

    Wizard Step 6: Bulk Review

    The staging review table displays the following columns:

    • Date: The execution date of the transaction.
    • Type: The financial operation type (BUY, SELL, DIVIDEND, DEPOSIT, etc.).
    • Asset: The matched asset from your library.
    • Quantity: The number of units or shares traded.
    • Price: The unit price of the asset.
    • Net Amount: The total cash impact (positive or negative) on the account.
    • Fees/Taxes: Broker commissions or transaction taxes included.

    For advanced settings or validation errors in staging, refer to the Import from Broker page.


๐Ÿ“ˆ 4. Back to the Dashboard

After successfully importing your statement, return to the Dashboard.

LibreFolio calculates your portfolio metrics, asset allocation (by type, sector, geography), and performance history in real-time. You can now see your entire financial situation beautifully plotted!

Dashboard Main View

๐Ÿ”ฎ 5. What's Next?

Now that your portfolio is populated, you can:

  • ๐Ÿค Share your broker โ€” Give access to family members or advisors.
  • ๐Ÿ’ฑ Set up FX rates โ€” Configure currency conversion for multi-currency portfolios.
  • โš™๏ธ Customize settings โ€” Adjust language, theme, and system preferences.