1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/firefly-iii_ynh.git synced 2024-09-03 18:36:13 +02:00

Small textual changes in readme. Removed the todo-list since it's complete.

This commit is contained in:
James Cole 2018-06-18 18:39:23 +02:00
parent 431caebe5b
commit 40c295a2bb

View file

@ -1,8 +1,8 @@
# Firefly III for YunoHost # Firefly III for YunoHost
[![Integration level](https://dash.yunohost.org/integration/firefly3.svg)](https://ci-apps.yunohost.org/jenkins/job/firefly3%20%28Community%29/lastBuild/consoleFull) [![Integration level](https://dash.yunohost.org/integration/firefly-iii.svg)](https://ci-apps.yunohost.org/jenkins/job/firefly-iii%20%28Community%29/lastBuild/consoleFull)
[![Install firefly3 with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=firefly3)<br><br> [![Install Firefly III with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=firefly-iii)<br><br>
======= =======
**Caution:** This app will install **PHP 7.1**. **Caution:** This app will install **PHP 7.1**.
@ -66,29 +66,26 @@ Everything is organised:
* Financial reporting showing you how well you are doing * Financial reporting showing you how well you are doing
* Lots of math because we all like math! * Lots of math because we all like math!
### To-do
- [x] Install
- [x] Remove
- [X] Upgrade
- [X] Backup
- [X] Restore
- [X] Multi-instance
### Installation ### Installation
- Firefly III requires a **dedicated domain** (must install under web root like **https://firefly.example.com/** not **https://example.com/firefly/** ) - Firefly III requires a **dedicated (sub)domain** (must install under web root like **https://firefly.example.com/** not **https://example.com/firefly/** )
#### Register a new domain and add it to YunoHost #### Register a new domain and add it to YunoHost
Firefly III requires a dedicated domain, so obtain one and add it using the YunoHost admin panel. **Domains -> Add domain**. As Firefly III uses the full domain and is installed on the root, you can create a subdomain such as firefly.domain.tld. Don't forget to update your DNS if you manage them manually. Firefly III requires a dedicated (sub)domain, so obtain one and add it using the YunoHost admin panel. **Domains -> Add domain**. As Firefly III uses the full domain and is installed on the root, you can create a subdomain such as firefly.domain.tld. Don't forget to update your DNS if you manage them manually.
#### Install the Firefly III application #### Install the Firefly III application
Use the YunoHost admin panel to install Firefly III by entering the GitHub repo address in the custom app URL: Use the YunoHost admin panel to install Firefly III by entering the GitHub repo address in the custom app URL:
```
https://github.com/YunoHost-Apps/firefly3_ynh https://github.com/YunoHost-Apps/firefly3_ynh
**Or**<br> ```
**Or**
Use the command line to install the Firefly III app: Use the command line to install the Firefly III app:
```
$ yunohost app install --verbose https://github.com/YunoHost-Apps/firefly3_ynh $ yunohost app install --verbose https://github.com/YunoHost-Apps/firefly3_ynh
```
- The Admin user should be **registered YunoHost user**. - The Admin user should be a **registered YunoHost user**.
- **Important**:When installation is complete, you will have to visit the domain on which the app is installed and register the first account with the **primary email address of the Admin user given at the time of installaion**(otherwise you will not get the admin rights). The registration will lock itself after the first registraion. - **Important:** When the installation is complete, you will have to visit the domain on which the app is installed and register the first account with the **primary email address of the Admin user given at the time of installayion** (otherwise you will not get admin rights). The registration will lock itself after the first registration.