mirror of
https://github.com/YunoHost-Apps/monica_ynh.git
synced 2024-09-03 19:46:23 +02:00
Auto-update README
This commit is contained in:
Yunohost-Bot
Yunohost-Bot
parent
c4226a3f6b
commit
1a5a0e5234
2 changed files with 73 additions and 40 deletions
66
README.md
66
README.md
|
|
@ -1,59 +1,43 @@
|
|||
# Monica app for YunoHost
|
||||
<!--
|
||||
N.B.: This README was automatically generated by https://github.com/YunoHost/apps/tree/master/tools/README-generator
|
||||
It shall NOT be edited by hand.
|
||||
-->
|
||||
|
||||
# Monica for YunoHost
|
||||
|
||||
[](https://dash.yunohost.org/appci/app/monica)  
|
||||
[](https://install-app.yunohost.org/?app=monica)
|
||||
[](https://install-app.yunohost.org/?app=monica)
|
||||
|
||||
> *This package allows you to install Monica quickly and simply on a YunoHost server.
|
||||
*[Lire ce readme en français.](./README_fr.md)*
|
||||
|
||||
> *This package allows you to install Monica 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
|
||||
|
||||
Monica is an open-source web application to organize the interactions with your loved ones. I call it a PRM, or Personal Relationship Management. Think of it as a [CRM](https://en.wikipedia.org/wiki/Customer_relationship_management) (a popular tool used by sales teams in the corporate world) for your friends or family.
|
||||
|
||||
**Shipped version:** 2.17.0
|
||||
|
||||
**Shipped version:** 2.17.0~ynh3
|
||||
|
||||
|
||||
|
||||
## Screenshots
|
||||
|
||||
|
||||
|
||||
|
||||
## Configuration
|
||||
## Disclaimers / important information
|
||||
|
||||
Change the settings of the app by changing the values in .env
|
||||
* **First User Registration:** Visit the app **domain** after the installation is complete to register as **first user**. After the first user is registered the registration will be **locked**. You can open the register for all by changing the value **APP_DISABLE_SIGNUP** to **false** in **.env**. There is **no admin interface** in the Monica app currently.
|
||||
|
||||
## YunoHost specific features
|
||||
## Documentation and resources
|
||||
|
||||
#### Multi-user support
|
||||
* Official app website: https://monicahq.com
|
||||
* Upstream app code repository: https://github.com/monicahq/monica
|
||||
* YunoHost documentation for this app: https://yunohost.org/app_monica
|
||||
* Report a bug: https://github.com/YunoHost-Apps/monica_ynh/issues
|
||||
|
||||
**First User Registration:** Visit the app **domain** after the installation is complete to register as **first user**. After the first user is registered the registration will be **locked**. You can open the register for all by changing the value **APP_DISABLE_SIGNUP** to **false** in **.env**. There is **no admin interface** in the Monica app currently.
|
||||
|
||||
#### Supported architectures
|
||||
|
||||
* x86-64 - [](https://ci-apps.yunohost.org/ci/apps/monica/)
|
||||
* ARMv8-A - [](https://ci-apps-arm.yunohost.org/ci/apps/monica/)
|
||||
|
||||
## Links
|
||||
|
||||
* Report a bug: https://github.com/YunoHost-Apps/monica_ynh/issues
|
||||
* App website: https://monicahq.com/
|
||||
* Upstream app repository: https://github.com/monicahq/monica
|
||||
* YunoHost website: https://yunohost.org/
|
||||
|
||||
## Introduction
|
||||
|
||||
|
||||
## What works?
|
||||
* [X] Update and remove script
|
||||
* [X] Upgrade script
|
||||
* [X] Backup and restore script (**Need testing**)
|
||||
* [X] Multi-instance (**Need testing**)
|
||||
* [x] make root domain redirect to index.php
|
||||
* [x] Chang URL (Need testing,backup before trying this)
|
||||
* [ ] LDAP/SSO support
|
||||
* [x] Make monica installable into subdirectory (eg. https://example.com/monica/)
|
||||
|
||||
---
|
||||
|
||||
Developer info
|
||||
----------------
|
||||
## Developer info
|
||||
|
||||
Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/monica_ynh/tree/testing).
|
||||
|
||||
|
|
@ -63,3 +47,5 @@ sudo yunohost app install https://github.com/YunoHost-Apps/monica_ynh/tree/testi
|
|||
or
|
||||
sudo yunohost app upgrade monica -u https://github.com/YunoHost-Apps/monica_ynh/tree/testing --debug
|
||||
```
|
||||
|
||||
**More info regarding app packaging:** https://yunohost.org/packaging_apps
|
||||
47
README_fr.md
Normal file
47
README_fr.md
Normal file
|
|
@ -0,0 +1,47 @@
|
|||
# Monica pour YunoHost
|
||||
|
||||
[](https://dash.yunohost.org/appci/app/monica)  
|
||||
[](https://install-app.yunohost.org/?app=monica)
|
||||
|
||||
*[Read this readme in english.](./README.md)*
|
||||
*[Lire ce readme en français.](./README_fr.md)*
|
||||
|
||||
> *Ce package vous permet d'installer Monica rapidement et simplement sur un serveur YunoHost.
|
||||
Si vous n'avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) pour savoir comment l'installer et en profiter.*
|
||||
|
||||
## Vue d'ensemble
|
||||
|
||||
Monica is an open-source web application to organize the interactions with your loved ones. I call it a PRM, or Personal Relationship Management. Think of it as a [CRM](https://en.wikipedia.org/wiki/Customer_relationship_management) (a popular tool used by sales teams in the corporate world) for your friends or family.
|
||||
|
||||
|
||||
**Version incluse :** 2.17.0~ynh3
|
||||
|
||||
|
||||
|
||||
## Captures d'écran
|
||||
|
||||
|
||||
|
||||
## Avertissements / informations importantes
|
||||
|
||||
* **First User Registration:** Visit the app **domain** after the installation is complete to register as **first user**. After the first user is registered the registration will be **locked**. You can open the register for all by changing the value **APP_DISABLE_SIGNUP** to **false** in **.env**. There is **no admin interface** in the Monica app currently.
|
||||
|
||||
## Documentations et ressources
|
||||
|
||||
* Site officiel de l'app : https://monicahq.com
|
||||
* Dépôt de code officiel de l'app : https://github.com/monicahq/monica
|
||||
* Documentation YunoHost pour cette app : https://yunohost.org/app_monica
|
||||
* Signaler un bug : https://github.com/YunoHost-Apps/monica_ynh/issues
|
||||
|
||||
## Informations pour les développeurs
|
||||
|
||||
Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/monica_ynh/tree/testing).
|
||||
|
||||
Pour essayer la branche testing, procédez comme suit.
|
||||
```
|
||||
sudo yunohost app install https://github.com/YunoHost-Apps/monica_ynh/tree/testing --debug
|
||||
ou
|
||||
sudo yunohost app upgrade monica -u https://github.com/YunoHost-Apps/monica_ynh/tree/testing --debug
|
||||
```
|
||||
|
||||
**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps
|
||||
Loading…
Add table
Reference in a new issue