mirror of
https://github.com/alexbelgium/hassio-addons.git
synced 2026-01-10 09:51:02 +01:00
98 lines
5.7 KiB
Markdown
98 lines
5.7 KiB
Markdown
|
|
# Home assistant add-on: fireflyiii
|
|
|
|
[![Donate][donation-badge]](https://www.buymeacoffee.com/alexbelgium)
|
|
[![Donate][paypal-badge]](https://www.paypal.com/donate/?hosted_button_id=DZFULJZTP3UQA)
|
|
|
|
|
|
|
|
|
|
|
|
[](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%20(no%20paypal)-%23d32f2f?logo=buy-me-a-coffee&style=flat&logoColor=white
|
|
[paypal-badge]: https://img.shields.io/badge/Buy%20me%20a%20coffee%20with%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 addon is based on the docker image https://hub.docker.com/r/fireflyiii/core
|
|
|
|
## 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:PORT> or through the sidebar using Ingress.
|
|
Configurations can be done through the app webUI, except for the following options.
|
|
|
|
**⚠️ IMPORTANT**: Change your `APP_KEY` before first launch! You won't be able to change it afterwards without resetting your database.
|
|
|
|
### Options
|
|
|
|
| Option | Type | Default | Description |
|
|
|--------|------|---------|-------------|
|
|
| `APP_KEY` | str | `CHANGEME_32_CHARS_EuC5dfn3LAPzeO` | **CRITICAL**: 32-character encryption key - change before first run! |
|
|
| `CONFIG_LOCATION` | str | `/config/addons_config/fireflyiii/config.yaml` | Location of additional config file |
|
|
| `DB_CONNECTION` | list | `sqlite_internal` | Database type (sqlite_internal/mariadb_addon/mysql/pgsql) |
|
|
| `DB_HOST` | str | | Database host (for external databases) |
|
|
| `DB_PORT` | str | | Database port (for external databases) |
|
|
| `DB_DATABASE` | str | | Database name (for external databases) |
|
|
| `DB_USERNAME` | str | | Database username (for external databases) |
|
|
| `DB_PASSWORD` | str | | Database password (for external databases) |
|
|
| `Updates` | list | | Automatic update schedule (hourly/daily/weekly) |
|
|
| `silent` | bool | `true` | Silent mode - set to false for debug info |
|
|
|
|
### Example Configuration
|
|
|
|
```yaml
|
|
APP_KEY: "SomeRandomStringOf32CharsExactly"
|
|
CONFIG_LOCATION: "/config/addons_config/fireflyiii/config.yaml"
|
|
DB_CONNECTION: "mariadb_addon"
|
|
DB_HOST: "core-mariadb"
|
|
DB_PORT: "3306"
|
|
DB_DATABASE: "firefly"
|
|
DB_USERNAME: "firefly"
|
|
DB_PASSWORD: "secure_password"
|
|
Updates: "weekly"
|
|
silent: false
|
|
```
|
|
|
|
### Advanced Configuration
|
|
|
|
Additional environment variables can be configured using the config.yaml file. See:
|
|
- [Add Environment Variables Guide](https://github.com/alexbelgium/hassio-addons/wiki/Add-Environment-variables-to-your-Addon)
|
|
- [Complete Firefly III environment variables](https://raw.githubusercontent.com/firefly-iii/firefly-iii/main/.env.example)
|
|
|
|
## 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
|
|
|
|
|