ynab-portfolio-monitor/README.md

41 lines
2.1 KiB
Markdown
Raw Normal View History

2023-10-28 21:22:10 +00:00
# ynab-portfolio-monitor
2023-11-12 19:04:22 +00:00
[![Build Status](https://drone.deadbeef.codes/api/badges/steven/ynab-portfolio-monitor/status.svg)](https://drone.deadbeef.codes/steven/ynab-portfolio-monitor)
2023-11-12 20:06:07 +00:00
Track your securities in YNAB for account types and update your balance automatically. For each configured account, it will update the balance from your broker in YNAB every 6 hours by creating / editing a transaction named "Capital Gains or Losses". On days that exchanges are closed, it will not do anything. The end result is that there will be transaction each day with payee "Capital Gains or Losses" in YNAB for each account you configure, which allows tracking your account balance over time.
2023-11-12 20:20:53 +00:00
It syncs your balance like magic!
![alt text][logo]
[logo]: https://deadbeef.codes/steven/ynab-portfolio-monitor/raw/branch/main/example-image.png "It syncs your balance like magic!"
2023-11-12 20:06:07 +00:00
### Example docker-compose.yml
The values below are examples only. You can configure as many account pairings as you want using environment variables in a continuous series starting from 0 as shown below. Two example accounts are configured ending in _0 and _1 but a third can be added by adding account numbers/ID with _2.
```yaml
version: '3.8'
services:
ynab-portfolio-monitor:
image: registry.deadbeef.codes/ynab-portfolio-monitor:latest
restart: always
environment:
- questrade_refresh_token=4dsO6652dS3cxtcctscd3ds4Df2E0
- questrade_account_0=51000001 # TFSA
- questrade_account_1=51000002 # RRSP
- questrade_ynab_account_0=731af51e-cb40-4d4a-8094-8654e59e11fc # TFSA
- questrade_ynab_account_1=78e76e45-2fbe-4ab1-84e9-64ba0996d015 # RRSP
- ynab_budget_id=76566452-67ff-4642-99d1-47d752216fb3
- ynab_secret=98Q_J655F_TAyGnhCCDS4uqRe4R5654DT2d-ZXdssZ
- bitcoin_address_0=bc1qg0edu4tr7pza8qsxf576r0eulr2ygt3mhldswg
- bitcoin_address_1=bc1qeh0dkdqvjyt646657lge0nxqj67z5xa8zxl8q3
- bitcoin_ynab_account=1f5bec0d-f852-2fbe-bbee-02fa98ded566 # Bitcoin addresses map to single YNAB account
2023-11-12 20:06:07 +00:00
volumes:
- /data/ynab-portfolio-monitor-data:/data
2023-11-12 20:20:53 +00:00
```