mirror of
https://github.com/alexbelgium/hassio-addons.git
synced 2026-01-09 17:31:03 +01:00
113 lines
5.9 KiB
Markdown
113 lines
5.9 KiB
Markdown
# Home assistant add-on: Fireflyiii fints importer
|
|
|
|
|
|
I maintain this and other Home Assistant add-ons in my free time: keeping up with upstream changes, HA changes, and testing on real hardware takes a lot of time (and some money). I use around 5-10 of my >110 addons so regularly I install test machines (and purchase some test services such as vpn) that I don't use myself to troubleshoot and improve the addons
|
|
|
|
If this add-on saves you time or makes your setup easier, I would be very grateful for your support!
|
|
|
|
[![Buy me a coffee][donation-badge]](https://www.buymeacoffee.com/alexbelgium)
|
|
[![Donate via PayPal][paypal-badge]](https://www.paypal.com/donate/?hosted_button_id=DZFULJZTP3UQA)
|
|
|
|
## Addon informations
|
|
|
|
|
|
|
|
|
|
|
|
[](https://www.codacy.com/gh/alexbelgium/hassio-addons/dashboard?utm_source=github.com&utm_medium=referral&utm_content=alexbelgium/hassio-addons&utm_campaign=Badge_Grade)
|
|
[](https://github.com/alexbelgium/hassio-addons/actions/workflows/weekly-supelinter.yaml)
|
|
[](https://github.com/alexbelgium/hassio-addons/actions/workflows/onpush_builder.yaml)
|
|
|
|
[donation-badge]: https://img.shields.io/badge/Buy%20me%20a%20coffee-%23d32f2f?logo=buy-me-a-coffee&style=flat&logoColor=white
|
|
[paypal-badge]: https://img.shields.io/badge/Donate%20via%20PayPal-0070BA?logo=paypal&style=flat&logoColor=white
|
|
|
|
_Thanks to everyone having starred my repo! To star it click on the image below, then it will be on top right. Thanks!_
|
|
|
|
[](https://github.com/alexbelgium/hassio-addons/stargazers)
|
|
|
|
|
|
|
|
## About
|
|
|
|
["Firefly III"](https://www.firefly-iii.org) is a (self-hosted) manager for your personal finances. It can help you keep track of your expenses and income, so you can spend less and save more. This tool allows you to import transactions from your FinTS enabled bank into Firefly III. It comes with a web GUI that guides you through the process.
|
|
|
|
This addon is based on the docker image https://hub.docker.com/r/benkl/firefly-iii-fints-importer
|
|
|
|
## Configuration
|
|
|
|
Use the add-on `env_vars` option to pass extra environment variables (uppercase or lowercase names). See https://github.com/alexbelgium/hassio-addons/wiki/Add-Environment-variables-to-your-Addon-2 for details.
|
|
|
|
Webui can be found at <http://homeassistant:3476>.
|
|
|
|
This tool allows you to import transactions from your FinTS enabled bank (primarily German banks) into Firefly III.
|
|
|
|
### Setup Steps
|
|
|
|
1. Ensure you have a running Firefly III instance
|
|
2. Access the web interface to configure bank connections
|
|
3. Set up import configurations for each bank account
|
|
4. Configure automatic import schedules if desired
|
|
|
|
For detailed setup documentation, see: https://github.com/bnw/firefly-iii-fints-importer
|
|
|
|
### Options
|
|
|
|
| Option | Type | Description |
|
|
|--------|------|-------------|
|
|
| `Updates` | list | Automatic import schedule (hourly, daily2, daily4, daily6, daily8, daily10, daily12, weekly) |
|
|
| `silent` | bool | Suppress debug messages |
|
|
|
|
### Example Configuration
|
|
|
|
```yaml
|
|
Updates: ["daily6"] # Run daily at 6 AM
|
|
silent: false
|
|
```
|
|
|
|
### Automatic Import Schedule
|
|
|
|
The `Updates` option allows you to schedule automatic imports:
|
|
|
|
- `hourly`: Every hour
|
|
- `daily2`: Daily at 2:00 AM
|
|
- `daily4`: Daily at 4:00 AM
|
|
- `daily6`: Daily at 6:00 AM
|
|
- `daily8`: Daily at 8:00 AM
|
|
- `daily10`: Daily at 10:00 AM
|
|
- `daily12`: Daily at 12:00 PM
|
|
- `weekly`: Weekly (Sunday at 2:00 AM)
|
|
|
|
### Configuration Storage
|
|
|
|
Bank configurations and import settings are stored in:
|
|
`/config/addons_config/fireflyiii_fints_importer/`
|
|
|
|
For configuration file format, see: https://github.com/bnw/firefly-iii-fints-importer#storing-configurations
|
|
|
|
### FinTS Support
|
|
|
|
This importer supports German banks that use the FinTS (Financial Transaction Services) protocol. Most major German banks support FinTS for automated transaction retrieval.
|
|
|
|
## Installation
|
|
|
|
The installation of this add-on is pretty straightforward and not different in comparison to installing any other add-on.
|
|
|
|
1. Add my add-ons repository to your home assistant instance (in supervisor addons store at top right, or click button below if you have configured my HA)
|
|
[](https://my.home-assistant.io/redirect/supervisor_add_addon_repository/?repository_url=https%3A%2F%2Fgithub.com%2Falexbelgium%2Fhassio-addons)
|
|
1. Install this add-on.
|
|
1. Click the `Save` button to store your configuration.
|
|
1. Set the add-on options to your preferences
|
|
1. Start the add-on.
|
|
1. Check the logs of the add-on to see if everything went well.
|
|
1. Open the webUI and adapt the software options
|
|
|
|
## Support
|
|
|
|
Create an issue on github
|
|
|
|
## Illustration
|
|
|
|
[repository]: https://github.com/alexbelgium/hassio-addons
|
|
|
|
|