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. The revenue is used for covering the hosting costs.

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 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 and linux/arm64.

• Basic knowledge of Docker
• Installation of Docker
• Local copy of this Git repository (clone)

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 https://localhost:3333 in your browser and accomplish these steps:

1. Create a new user via Get Started (this first user will get the role ADMIN)
2. Go to the Market Data tab in the Admin Control Panel and click Gather All Data to fetch historical data
3. Click Sign out and check out the Live Demo

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.

Please follow the instructions of the Ghostfolio Unraid Community App.

• Docker
• Node.js (version 16)
• Yarn
• A local copy of this Git repository (clone)

1. Run yarn install
2. Run yarn build:dev to build the source code including the assets
3. Run docker-compose --env-file ./.env -f docker/docker-compose.dev.yml up -d to start PostgreSQL and Redis
4. Run yarn database:setup to initialize the database schema and populate your database with (example) data
5. Start the server and the client (see Development)
6. Create a new user via Get Started (this first user will get the role ADMIN)
7. Go to the Market Data tab in the Admin Control Panel and click Gather All Data to fetch historical data
8. Click Sign out and check out the Live Demo

Run yarn watch:server and click Launch Program in Visual Studio Code

Run yarn start:server

Run yarn start:client

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 GET https://localhost:3333/api/v1/auth/anonymous/<INSERT_SECURITY_TOKEN_OF_ACCOUNT> or curl -s https://localhost:3333/api/v1/auth/anonymous/<INSERT_SECURITY_TOKEN_OF_ACCOUNT>.

POST https://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"
  ]
}

• ghostfolio-cli: Command-line interface to access your portfolio

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 tweet to @ghostfolio_. We would love to hear from you.

If you like to support this project, get Ghostfolio Premium or Buy me a coffee.

© 2023 Ghostfolio

Licensed under the AGPLv3 License.