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.

• 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

1. Open http://localhost:3333 in your browser
2. Create a new user via Get Started (this first user will get the role ADMIN)

1. Increase the version of the ghostfolio/ghostfolio Docker image in docker/docker-compose.yml
2. 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)

1. Run yarn install
2. Run docker compose --env-file ./.env -f docker/docker-compose.dev.yml up -d to start PostgreSQL and Redis
3. Run yarn database:setup to initialize the database schema
4. Run git config core.hooksPath ./git-hooks/ to setup git hooks
5. Start the server and the client (see Development)
6. Open http://localhost:4200/en in your browser
7. 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 http://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
    }
  ]
}

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 got some ideas. 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.