mirror of
https://github.com/YunoHost-Apps/monica_ynh.git
synced 2024-09-03 19:46:23 +02:00
65 lines
2.8 KiB
Markdown
65 lines
2.8 KiB
Markdown
# Monica app for YunoHost
|
|
|
|
[](https://dash.yunohost.org/appci/app/monica)  
|
|
[](https://install-app.yunohost.org/?app=monica)
|
|
|
|
> *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
|
|
|
|
## Screenshots
|
|
|
|
|
|
|
|
## Configuration
|
|
|
|
Change the settings of the app by changing the values in .env
|
|
|
|
## YunoHost specific features
|
|
|
|
#### Multi-user support
|
|
|
|
**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
|
|
----------------
|
|
|
|
Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/monica_ynh/tree/testing).
|
|
|
|
To try the testing branch, please proceed like that.
|
|
```
|
|
sudo yunohost app install https://github.com/YunoHost-Apps/monica_ynh/tree/testing --debug
|
|
or
|
|
sudo yunohost app upgrade monica -u https://github.com/YunoHost-Apps/monica_ynh/tree/testing --debug
|
|
```
|