Open Source Wealth Management Software
Ghostfol.io | Live Demo | Ghostfolio Premium | FAQ | Blog | Slack | X
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.
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 the costs of the hosting infrastructure and to fund ongoing development.
If you prefer to run Ghostfolio on your own infrastructure, please find further instructions in the Self-hosting section.
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
- โ Create, update and delete transactions
- โ Multi account management
- โ
Portfolio performance: Time-weighted rate of return (TWR) for
Today
,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
Ghostfolio is a modern web application written in TypeScript and organized as an Nx workspace.
The backend is based on NestJS using PostgreSQL as a database together with Prisma and Redis for caching.
The frontend is built with Angular and uses Angular Material with utility classes from Bootstrap.
We provide official container images hosted on Docker Hub for linux/amd64
, linux/arm/v7
and linux/arm64
.
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 | |
DATABASE_URL |
string | The database connection URL, e.g. postgresql://${POSTGRES_USER}:${POSTGRES_PASSWORD}@localhost:5432/${POSTGRES_DB}?sslmode=prefer |
|
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) | |
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 |
- Basic knowledge of Docker
- Installation of Docker
- Create a local copy of this Git repository (clone)
- Copy the file
.env.example
to.env
and populate it with your data (cp .env.example .env
)
Run the following command to start the Docker images from Docker Hub:
docker compose --env-file ./.env -f docker/docker-compose.yml up -d
Run the following commands to build and start the Docker images:
docker compose --env-file ./.env -f docker/docker-compose.build.yml build
docker compose --env-file ./.env -f docker/docker-compose.build.yml up -d
- Open http://localhost:3333 in your browser
- Create a new user via Get Started (this first user will get the role
ADMIN
)
- Increase the version of the
ghostfolio/ghostfolio
Docker image indocker/docker-compose.yml
- Run the following command to start the new Docker image:
docker compose --env-file ./.env -f docker/docker-compose.yml up -d
At each start, the container will automatically apply the database schema migrations if needed.
Ghostfolio is available for various home server systems, including CasaOS, Home Assistant, Runtipi, TrueCharts, Umbrel, and Unraid.
- Docker
- Node.js (version 18+)
- Yarn
- Create a local copy of this Git repository (clone)
- Copy the file
.env.dev
to.env
and populate it with your data (cp .env.dev .env
)
- Run
yarn install
- Run
docker compose --env-file ./.env -f docker/docker-compose.dev.yml up -d
to start PostgreSQL and Redis - Run
yarn database:setup
to initialize the database schema - Run
git config core.hooksPath ./git-hooks/
to setup git hooks - Start the server and the client (see Development)
- Open https://localhost:4200/en in your browser
- Create a new user via Get Started (this first user will get the role
ADMIN
)
Run yarn watch:server
and click Debug API in Visual Studio Code
Run yarn start:server
Run yarn start:client
and open https://localhost:4200/en in your browser
Run yarn start:storybook
With the following command you can keep your database schema in sync:
yarn database:push
Run yarn test
Set the header for each request as follows:
"Authorization": "Bearer eyJh..."
You can get the Bearer Token via POST http://localhost:3333/api/v1/auth/anonymous
(Body: { "accessToken": "<INSERT_SECURITY_TOKEN_OF_ACCOUNT>" }
)
Deprecated: GET http://localhost:3333/api/v1/auth/anonymous/<INSERT_SECURITY_TOKEN_OF_ACCOUNT>
or curl -s http://localhost:3333/api/v1/auth/anonymous/<INSERT_SECURITY_TOKEN_OF_ACCOUNT>
.
POST http://localhost:3333/api/v1/import
{
"activities": [
{
"currency": "USD",
"dataSource": "YAHOO",
"date": "2021-09-15T00:00:00.000Z",
"fee": 19,
"quantity": 5,
"symbol": "MSFT",
"type": "BUY",
"unitPrice": 298.58
}
]
}
Field | Type | Description |
---|---|---|
accountId | string (optional ) |
Id of the account |
comment | string (optional ) |
Comment of the activity |
currency | string | CHF | EUR | USD etc. |
dataSource | string | COINGECKO | MANUAL (for type ITEM ) | YAHOO |
date | string | Date in the format ISO-8601 |
fee | number | Fee of the activity |
quantity | number | Quantity of the activity |
symbol | string | Symbol of the activity (suitable for dataSource ) |
type | string | BUY | DIVIDEND | FEE | INTEREST | ITEM | LIABILITY | SELL |
unitPrice | number | Price per unit of the activity |
201 Created
400 Bad Request
{
"error": "Bad Request",
"message": [
"activities.1 is a duplicate activity"
]
}
Discover a variety of community projects for Ghostfolio: https://github.com/topics/ghostfolio
Are you building your own project? Add the ghostfolio
topic to your GitHub repository to get listed as well. Learn more โ
Ghostfolio is 100% free and open source. We encourage and support an active and healthy community that accepts contributions from the public - including you.
Not sure what to work on? We have some ideas, even for newcomers. Please join the Ghostfolio Slack channel or post to @ghostfolio_ on X. We would love to hear from you.
If you like to support this project, get Ghostfolio Premium or Buy me a coffee.
ยฉ 2021 - 2024 Ghostfolio
Licensed under the AGPLv3 License.