firefly-iii_ynh/README.md

# Firefly III for YunoHost

[![Integration level](https://dash.yunohost.org/integration/firefly-iii.svg)](https://dash.yunohost.org/appci/app/firefly-iii) ![](https://ci-apps.yunohost.org/ci/badges/firefly-iii.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/firefly-iii.maintain.svg)

[![Install Firefly III with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=firefly-iii)

> *This package allows you to install Firefly III quickly and simply on a YunoHost server.
If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.*

## Overview
"Firefly III" 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. Firefly III supports the use of budgets, categories and tags. It can import data from external sources and it has many neat financial reports available. You can [read all about it in the main repository](https://github.com/firefly-iii/firefly-iii) and in the [official documentation](https://firefly-iii.readthedocs.io/en/latest/).

**Shipped version:** 5.4.6

## Screenshots

![](index.png)

## Demo

* [Demo 1](https://demo.firefly-iii.org/login)
* [Demo 2](http://www.softaculous.com/softaculous/demos/Firefly_III)

## Documentation

 * Official documentation: https://docs.firefly-iii.org/

## YunoHost specific features

#### Multi-user support

- The admin user should be the first user to log into Firefly III
- SSO is not working yet
- You will probably be warned about missing locale from your system. Once you change the language to those corresponding to your system, the warning will desapear

#### Supported architectures

* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/firefly-iii%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/firefly-iii/)
* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/firefly-iii%20%28Apps%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/firefly-iii/)

## Links

 * Report a bug: https://github.com/YunoHost-Apps/firefly-iii_ynh/issues
 * App website: https://firefly-iii.org/
 * Upstream app repository: https://github.com/firefly-iii/firefly-iii
 * YunoHost website: https://yunohost.org/

TODO
 - [ ] Make Firefly III admin user dependant of the user choosen at installation
 - [ ] Make SSO work
 - [ ] Define default language according to system language

---

Developer info
----------------

Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/firefly-iii_ynh/tree/testing).

To try the testing branch, please proceed like that.
```
sudo yunohost app install https://github.com/YunoHost-Apps/firefly-iii_ynh/tree/testing --debug
or
sudo yunohost app upgrade firefly-iii -u https://github.com/YunoHost-Apps/firefly-iii_ynh/tree/testing --debug
```
Apply last example_ynh 2020-06-11 00:45:03 +02:00			`# Firefly III for YunoHost`
Reorganise readme content. 2018-06-18 19:03:28 +02:00
Updated to version 5.4.5 2020-10-31 20:25:24 +01:00			`[![Integration level](https://dash.yunohost.org/integration/firefly-iii.svg)](https://dash.yunohost.org/appci/app/firefly-iii) ![](https://ci-apps.yunohost.org/ci/badges/firefly-iii.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/firefly-iii.maintain.svg)`
Fixes in upgrade and typo in readme 2020-11-19 10:11:49 +01:00
Apply last example_ynh 2020-06-11 00:45:03 +02:00			`[![Install Firefly III with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=firefly-iii)`
Updated Readme 2018-06-17 20:51:48 +02:00
Updated to version 5.4.5 2020-10-31 20:25:24 +01:00			`> *This package allows you to install Firefly III quickly and simply on a YunoHost server.`
Apply last example_ynh 2020-06-11 00:45:03 +02:00			`If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.*`
Updated Readme 2018-06-17 20:51:48 +02:00
Apply last example_ynh 2020-06-11 00:45:03 +02:00			`## Overview`
Reorganise readme content. 2018-06-18 19:03:28 +02:00			`"Firefly III" 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. Firefly III supports the use of budgets, categories and tags. It can import data from external sources and it has many neat financial reports available. You can [read all about it in the main repository](https://github.com/firefly-iii/firefly-iii) and in the [official documentation](https://firefly-iii.readthedocs.io/en/latest/).`
Updated Readme 2018-06-17 20:51:48 +02:00
Updated to version 5.4.6 2020-11-16 23:36:00 +01:00			`Shipped version: 5.4.6`
Updated Readme 2018-06-17 20:51:48 +02:00
Apply last example_ynh 2020-06-11 00:45:03 +02:00			`## Screenshots`
Updated Readme 2018-06-17 20:51:48 +02:00
Update README.md 2020-06-11 13:32:14 +02:00			`![](index.png)`
Updated Readme 2018-06-17 20:51:48 +02:00
Apply last example_ynh 2020-06-11 00:45:03 +02:00			`## Demo`
Update version to 4.7.17 2019-06-23 01:19:50 +02:00
Apply last example_ynh 2020-06-11 00:45:03 +02:00			`* [Demo 1](https://demo.firefly-iii.org/login)`
			`* [Demo 2](http://www.softaculous.com/softaculous/demos/Firefly_III)`
Small textual changes in readme. Removed the todo-list since it's complete. 2018-06-18 18:39:23 +02:00
Apply last example_ynh 2020-06-11 00:45:03 +02:00			`## Documentation`
Updated Readme 2018-06-17 20:51:48 +02:00
Apply last example_ynh 2020-06-11 00:45:03 +02:00			`* Official documentation: https://docs.firefly-iii.org/`
Reorganise readme content. 2018-06-18 19:03:28 +02:00
Apply last example_ynh 2020-06-11 00:45:03 +02:00			`## YunoHost specific features`
Updated Readme 2018-06-17 20:51:48 +02:00
Apply last example_ynh 2020-06-11 00:45:03 +02:00			`#### Multi-user support`
Small textual changes in readme. Removed the todo-list since it's complete. 2018-06-18 18:39:23 +02:00
Clean up script and readme. 2020-02-25 18:39:05 +01:00			`- The admin user should be the first user to log into Firefly III`
Add restrictions and TODO 2020-02-23 21:10:31 +01:00			`- SSO is not working yet`
			`- You will probably be warned about missing locale from your system. Once you change the language to those corresponding to your system, the warning will desapear`

Apply last example_ynh 2020-06-11 00:45:03 +02:00			`#### Supported architectures`

			`* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/firefly-iii%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/firefly-iii/)`
			`* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/firefly-iii%20%28Apps%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/firefly-iii/)`

			`## Links`

			`* Report a bug: https://github.com/YunoHost-Apps/firefly-iii_ynh/issues`
			`* App website: https://firefly-iii.org/`
			`* Upstream app repository: https://github.com/firefly-iii/firefly-iii`
			`* YunoHost website: https://yunohost.org/`

Add restrictions and TODO 2020-02-23 21:10:31 +01:00			`TODO`
Clean up script and readme. 2020-02-25 18:39:05 +01:00			`- [ ] Make Firefly III admin user dependant of the user choosen at installation`
			`- [ ] Make SSO work`
			`- [ ] Define default language according to system language`
Apply last example_ynh 2020-06-11 00:45:03 +02:00
			`---`

			`Developer info`
			`----------------`

			`Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/firefly-iii_ynh/tree/testing).`

			`To try the testing branch, please proceed like that.`
			```
			`sudo yunohost app install https://github.com/YunoHost-Apps/firefly-iii_ynh/tree/testing --debug`
			`or`
			`sudo yunohost app upgrade firefly-iii -u https://github.com/YunoHost-Apps/firefly-iii_ynh/tree/testing --debug`
			```