Ghostfolio
- 0 ratings
Wealth management software to keep track of stocks, ETFs and cryptocurrencies.
Deploy this app to Linode with a free $100 credit!
](https://ghostfol.io)
# Ghostfolio
**Open Source Wealth Management Software**
[**Ghostfol.io**](https://ghostfol.io) | [**Live Demo**](https://ghostfol.io/en/demo) | [**Ghostfolio Premium**](https://ghostfol.io/en/pricing) | [**FAQ**](https://ghostfol.io/en/faq) |
[**Blog**](https://ghostfol.io/en/blog) | [**Slack**](https://join.slack.com/t/ghostfolio/shared_invite/zt-vsaan64h-F_I0fEo5M0P88lP9ibCxFg) | [**Twitter**](https://twitter.com/ghostfolio_)
[](https://www.buymeacoffee.com/ghostfolio)
[](#contributing)
[](https://www.gnu.org/licenses/agpl-3.0)
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.
](https://www.youtube.com/watch?v=yY6ObSQVJZk)
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...
Today, YTD, 1Y, 5Y, Max
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.
](https://www.buymeacoffee.com/ghostfolio)
| Name | Default Value | Description |
|---|---|---|
ACCESS_TOKEN_SALT |
A random string used as salt for access tokens | |
BASE_CURRENCY |
USD |
The base currency of the Ghostfolio application.AUD | CAD | CNY | EUR | GBP | JPY | RUB | USDCaution: Only set if you intend to track cryptocurrencies in a non- USD currency. This cannot be changed later! |
DATABASE_URL |
The database connection URL, e.g. postgresql://${POSTGRES_USER}:${POSTGRES_PASSWORD}@localhost:5432/${POSTGRES_DB}?sslmode=prefer |
|
HOST |
0.0.0.0 |
The host where the Ghostfolio application will run on |
JWT_SECRET_KEY |
A random string used for JSON Web Tokens (JWT) | |
PORT |
3333 |
The port where the Ghostfolio application will run on |
POSTGRES_DB |
The name of the PostgreSQL database | |
POSTGRES_PASSWORD |
The password of the PostgreSQL database | |
POSTGRES_USER |
The user of the PostgreSQL database | |
REDIS_HOST |
The host where Redis is running | |
REDIS_PASSWORD |
The password of Redis | |
REDIS_PORT |
The port where Redis is running |
Run the following command to start the Docker images from Docker Hub:
docker-compose --env-file ./.env -f docker/docker-compose.yml up -dRun 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 -dOpen http://localhost:3333 in your browser and accomplish these steps:
ADMIN)ghostfolio/ghostfolio Docker image in docker/docker-compose.ymldocker-compose --env-file ./.env -f docker/docker-compose.yml up -dPlease follow the instructions of the Ghostfolio Unraid Community App.
yarn installyarn build:dev to build the source code including the assetsdocker-compose --env-file ./.env -f docker/docker-compose.dev.yml up -d to start PostgreSQL and Redisyarn database:setup to initialize the database schema and populate your database with (example) dataADMIN)Run yarn watch:server and click Launch Program 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:pushRun yarn test
Set the header for each request as follows:
"Authorization": "Bearer eyJh..."You can get the Bearer Token via 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 |
| currency | string | CHF | EUR | USD etc. |
| dataSource | string | 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 | ITEM | SELL |
| unitPrice | number | Price per unit of the activity |
201 Created
400 Bad Request
{
"error": "Bad Request",
"message": [
"activities.1 is a duplicate activity"
]
}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.
Please login to review this project.
No reviews for this project yet.
Assets management and booking for small/medium companies.
Firefly III is a modern financial manager. It helps you to …
Manage quotes, invoices, payments and customers for your sm…
Comments (0)
Please login to join the discussion on this project.