<div align="center">

<img src="https://avatars.githubusercontent.com/u/82473144?s=200" width="100" alt="Ghostfolio logo">

Ghostfolio

Open Source Wealth Management Software

Ghostfol.io | Live Demo | Ghostfolio Premium | FAQ | Blog | LinkedIn | Slack | X

</div>

Ghostfolio is an open source wealth management software built with web technology. The application empowers busy people to keep track of stocks, ETFs or cryptocurrencies and make solid, data-driven investment decisions. The software is designed for personal use in continuous operation.

<div align="center">

<img src="./apps/client/src/assets/images/video-preview.jpg" width="600" alt="Preview image of the Ghostfolio video trailer">

</div>

Ghostfolio Premium

Our official Ghostfolio Premium cloud offering is the easiest way to get started. Due to the time it saves, this will be the best option for most people. Revenue is used to cover operational costs for the hosting infrastructure and professional data providers, and to fund ongoing development.

If you prefer to run Ghostfolio on your own infrastructure, please find further instructions in the Self-hosting section.

Why Ghostfolio?

Ghostfolio is for you if you are...

• 💼 trading stocks, ETFs or cryptocurrencies on multiple platforms
• 🏦 pursuing a buy & hold strategy
• 🎯 interested in getting insights of your portfolio composition
• 👻 valuing privacy and data ownership
• 🧘 into minimalism
• 🧺 caring about diversifying your financial resources
• 🆓 interested in financial independence
• 🙅 saying no to spreadsheets
• 😎 still reading this list

Features

• ✅ Create, update and delete transactions
• ✅ Multi account management
• ✅ Portfolio performance: Return on Average Investment (ROAI) for Today, WTD, MTD, YTD, 1Y, 5Y, Max
• ✅ Various charts
• ✅ Static analysis to identify potential risks in your portfolio
• ✅ Import and export transactions
• ✅ Dark Mode
• ✅ Zen Mode
• ✅ Progressive Web App (PWA) with a mobile-first design

<div align="center"> <img src="./apps/client/src/assets/images/screenshot.png" width="300" alt="Image of a phone showing the Ghostfolio app open"> </div>

Technology Stack

Ghostfolio is a modern web application written in TypeScript and organized as an Nx workspace.

Backend

The backend is based on NestJS using PostgreSQL as a database together with Prisma and Redis for caching.

Frontend

The frontend is built with Angular and uses Angular Material with utility classes from Bootstrap.

Self-hosting

We provide official container images hosted on Docker Hub for linux/amd64, linux/arm/v7 and linux/arm64.

<div align="center">

<img src="./apps/client/src/assets/images/button-buy-me-a-coffee.png" width="150" alt="Buy me a coffee button"/>

</div>

Supported Environment Variables

| Name | Type | Default Value | Description | | --------------------------- | --------------------- | --------------------- | ----------------------------------------------------------------------------------------------------------------------------------- | | ACCESS_TOKEN_SALT | string | | A random string used as salt for access tokens | | API_KEY_COINGECKO_DEMO | string (optional) |   | The CoinGecko Demo API key | | API_KEY_COINGECKO_PRO | string (optional) | | The CoinGecko Pro API key | | DATABASE_URL | string | | The database connection URL, e.g. postgresql://${POSTGRES_USER}:${POSTGRES_PASSWORD}@localhost:5432/${POSTGRES_DB}?sslmode=prefer | | ENABLE_FEATURE_AUTH_TOKEN | boolean (optional) | true | Enables authentication via security token | | HOST | string (optional) | 0.0.0.0 | The host where the Ghostfolio application will run on | | JWT_SECRET_KEY | string | | A random string used for JSON Web Tokens (JWT) | | LOG_LEVELS | string[] (optional) | | The logging levels for the Ghostfolio application, e.g. ["debug","error","log","warn"] | | PORT | number (optional) | 3333 | The port where the Ghostfolio application will run on | | POSTGRES_DB | string | | The name of the PostgreSQL database | | POSTGRES_PASSWORD | string | | The password of the PostgreSQL database | | POSTGRES_USER | string | | The user of the PostgreSQL database | | REDIS_DB | number (optional) | 0 | The database index of Redis | | REDIS_HOST | string | | The host where Redis is running | | REDIS_PASSWORD | string | | The password of Redis | | REDIS_PORT | number | | The port where Redis is running | | REQUEST_TIMEOUT | number (optional) | 2000 | The timeout of network requests to data providers in milliseconds | | ROOT_URL | string (optional) | http://0.0.0.0:3333 | The root URL of the Ghostfolio application, used for generating callback URLs and external links. |

OpenID Connect OIDC (Experimental)

| Name | Type | Default Value | Description | | -------------------------- | --------------------- | ------------------------------------ | ---------------------------------------------------------------------------------------------------- | | ENABLE_FEATURE_AUTH_OIDC | boolean (optional) | false | Enables authentication via OpenID Connect | | OIDC_AUTHORIZATION_URL | string (optional) | | Manual override for the OIDC authorization endpoint (falls back to the discovery from the issuer) | | OIDC_CALLBACK_URL | string (optional) | ${ROOT_URL}/api/auth/oidc/callback | The OIDC callback URL | | OIDC_CLIENT_ID | string | | The OIDC client ID | | OIDC_CLIENT_SECRET | string | | The OIDC client secret | | OIDC_ISSUER | string | | The OIDC issuer URL, used