From c432fd1c5d564d39a341fd21c9404e92f6cc99f5 Mon Sep 17 00:00:00 2001 From: Alexandre Date: Sun, 8 May 2022 22:46:16 +0200 Subject: [PATCH] LF --- fireflyiii/README.md | 145 ++++++++++++++++++++++--------------------- 1 file changed, 73 insertions(+), 72 deletions(-) diff --git a/fireflyiii/README.md b/fireflyiii/README.md index b94949441..756570b4b 100644 --- a/fireflyiii/README.md +++ b/fireflyiii/README.md @@ -1,73 +1,74 @@ ## ⚠ Open Issue : [[Fireflyiii] No ui in 5.7.5 (opened 2022-05-06)](https://github.com/alexbelgium/hassio-addons/issues/316) by [@tbaumann](https://github.com/tbaumann) -# Home assistant add-on: fireflyiii - -[![Donate][donation-badge]](https://www.buymeacoffee.com/alexbelgium) - -![Version](https://img.shields.io/badge/dynamic/json?label=Version&query=%24.version&url=https%3A%2F%2Fraw.githubusercontent.com%2Falexbelgium%2Fhassio-addons%2Fmaster%2Ffireflyiii%2Fconfig.json) -![Ingress](https://img.shields.io/badge/dynamic/json?label=Ingress&query=%24.ingress&url=https%3A%2F%2Fraw.githubusercontent.com%2Falexbelgium%2Fhassio-addons%2Fmaster%2Ffireflyiii%2Fconfig.json) -![Arch](https://img.shields.io/badge/dynamic/json?color=success&label=Arch&query=%24.arch&url=https%3A%2F%2Fraw.githubusercontent.com%2Falexbelgium%2Fhassio-addons%2Fmaster%2Ffireflyiii%2Fconfig.json) - -[![Codacy Badge](https://app.codacy.com/project/badge/Grade/9c6cf10bdbba45ecb202d7f579b5be0e)](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) -[![GitHub Super-Linter](https://github.com/alexbelgium/hassio-addons/workflows/Lint%20Code%20Base/badge.svg)](https://github.com/marketplace/actions/super-linter) -[![Builder](https://github.com/alexbelgium/hassio-addons/workflows/Builder/badge.svg)](https://github.com/alexbelgium/hassio-addons/actions/workflows/builder.yaml) - -[donation-badge]: https://img.shields.io/badge/Buy%20me%20a%20coffee-%23d32f2f?logo=buy-me-a-coffee&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!_ - -[![Stargazers repo roster for @alexbelgium/hassio-addons](https://reporoster.com/stars/alexbelgium/hassio-addons)](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 - -PLEASE CHANGE YOUR APP_KEY BEFORE FIRST LAUNCH! YOU WON'T BE ABLE AFTERWRADS WITHOUT RESETTING YOUR DATABASE. - -Options can be configured through two ways : - -- Addon options - -```yaml -"CONFIG_LOCATION": location of the config.yaml # Sets the location of the config.yaml (see below) -"DB_CONNECTION": "list(sqlite_internal|mariadb_addon|mysql|pgsql)" # Defines the type of database to use : sqlite (default, embedded in the addon) ; MariaDB (auto-detection if the MariaDB addon is installed and runs), and external databases that requires that the other DB_ fields are set (mysql and pgsql) -"APP_KEY": 12 characters # This is your encryption key, don't lose it! -"DB_HOST": "CHANGEME" # only needed if using a remote database -"DB_PORT": "CHANGEME" # only needed if using a remote database -"DB_DATABASE": "CHANGEME" # only needed if using a remote database -"DB_USERNAME": "CHANGEME" # only needed if using a remote database -"DB_PASSWORD": "CHANGEME" # only needed if using a remote database -"Updates": hourly|daily|weekly # Sets an automatic update -"silent": true # If false, show debug info -``` - -- Config.yaml - -Additional variables can be set as ENV variables by adding them in the config.yaml in the location defined in your addon options - -The complete list of ENV variables can be seen here : 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) - [![Open your Home Assistant instance and show the add add-on repository dialog with a specific repository URL pre-filled.](https://my.home-assistant.io/badges/supervisor_add_addon_repository.svg)](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 - -![illustration](https://raw.githubusercontent.com/firefly-iii/firefly-iii/develop/.github/assets/img/imac-complete.png) - -[repository]: https://github.com/alexbelgium/hassio-addons + +# Home assistant add-on: fireflyiii + +[![Donate][donation-badge]](https://www.buymeacoffee.com/alexbelgium) + +![Version](https://img.shields.io/badge/dynamic/json?label=Version&query=%24.version&url=https%3A%2F%2Fraw.githubusercontent.com%2Falexbelgium%2Fhassio-addons%2Fmaster%2Ffireflyiii%2Fconfig.json) +![Ingress](https://img.shields.io/badge/dynamic/json?label=Ingress&query=%24.ingress&url=https%3A%2F%2Fraw.githubusercontent.com%2Falexbelgium%2Fhassio-addons%2Fmaster%2Ffireflyiii%2Fconfig.json) +![Arch](https://img.shields.io/badge/dynamic/json?color=success&label=Arch&query=%24.arch&url=https%3A%2F%2Fraw.githubusercontent.com%2Falexbelgium%2Fhassio-addons%2Fmaster%2Ffireflyiii%2Fconfig.json) + +[![Codacy Badge](https://app.codacy.com/project/badge/Grade/9c6cf10bdbba45ecb202d7f579b5be0e)](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) +[![GitHub Super-Linter](https://github.com/alexbelgium/hassio-addons/workflows/Lint%20Code%20Base/badge.svg)](https://github.com/marketplace/actions/super-linter) +[![Builder](https://github.com/alexbelgium/hassio-addons/workflows/Builder/badge.svg)](https://github.com/alexbelgium/hassio-addons/actions/workflows/builder.yaml) + +[donation-badge]: https://img.shields.io/badge/Buy%20me%20a%20coffee-%23d32f2f?logo=buy-me-a-coffee&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!_ + +[![Stargazers repo roster for @alexbelgium/hassio-addons](https://reporoster.com/stars/alexbelgium/hassio-addons)](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 + +PLEASE CHANGE YOUR APP_KEY BEFORE FIRST LAUNCH! YOU WON'T BE ABLE AFTERWRADS WITHOUT RESETTING YOUR DATABASE. + +Options can be configured through two ways : + +- Addon options + +```yaml +"CONFIG_LOCATION": location of the config.yaml # Sets the location of the config.yaml (see below) +"DB_CONNECTION": "list(sqlite_internal|mariadb_addon|mysql|pgsql)" # Defines the type of database to use : sqlite (default, embedded in the addon) ; MariaDB (auto-detection if the MariaDB addon is installed and runs), and external databases that requires that the other DB_ fields are set (mysql and pgsql) +"APP_KEY": 12 characters # This is your encryption key, don't lose it! +"DB_HOST": "CHANGEME" # only needed if using a remote database +"DB_PORT": "CHANGEME" # only needed if using a remote database +"DB_DATABASE": "CHANGEME" # only needed if using a remote database +"DB_USERNAME": "CHANGEME" # only needed if using a remote database +"DB_PASSWORD": "CHANGEME" # only needed if using a remote database +"Updates": hourly|daily|weekly # Sets an automatic update +"silent": true # If false, show debug info +``` + +- Config.yaml + +Additional variables can be set as ENV variables by adding them in the config.yaml in the location defined in your addon options + +The complete list of ENV variables can be seen here : 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) + [![Open your Home Assistant instance and show the add add-on repository dialog with a specific repository URL pre-filled.](https://my.home-assistant.io/badges/supervisor_add_addon_repository.svg)](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 + +![illustration](https://raw.githubusercontent.com/firefly-iii/firefly-iii/develop/.github/assets/img/imac-complete.png) + +[repository]: https://github.com/alexbelgium/hassio-addons