mirror of
https://github.com/YunoHost-Apps/yunomonitor_ynh.git
synced 2024-09-03 17:46:11 +02:00
[enh] Readme
This commit is contained in:
ljf
parent
15e0fe18a8
commit
1545715cda
1 changed files with 17 additions and 51 deletions
68
README.md
68
README.md
|
|
@ -1,73 +1,39 @@
|
||||||
# Usage of this package (REMOVE THIS SECTION BEFORE RELEASE)
|
# YunoMonitor
|
||||||
- Copy this app before working on it.
|
|
||||||
- Edit `conf/nginx.conf` file to match application prerequisites.
|
|
||||||
- Edit `manifest.json` with application specific information.
|
|
||||||
- Edit the `install`, `upgrade`, `remove`, `backup`, and `restore` scripts.
|
|
||||||
- Using the [script helpers documentation.](https://helpers.yunohost.org/)
|
|
||||||
- Add a `LICENSE` file for the package.
|
|
||||||
- Edit `README.md` and README_fr.md.
|
|
||||||
|
|
||||||
# Example app for YunoHost
|
[](https://dash.yunohost.org/appci/app/yunomonitor)
|
||||||
|
[](https://install-app.yunohost.org/?app=yunomonitor)
|
||||||
|
|
||||||
[](https://dash.yunohost.org/appci/app/REPLACEBYYOURAPP)
|
|
||||||
[](https://install-app.yunohost.org/?app=REPLACEBYYOURAPP)
|
|
||||||
|
|
||||||
*[Lire ce readme en français.](./README_fr.md)*
|
> *This package allow you to install yunomonitor quickly and simply on a YunoHost server.
|
||||||
|
|
||||||
> *This package allow you to install REPLACEBYYOURAPP quickly and simply on a YunoHost server.
|
|
||||||
If you don't have YunoHost, please see [here](https://yunohost.org/#/install) to know how to install and enjoy it.*
|
If you don't have YunoHost, please see [here](https://yunohost.org/#/install) to know how to install and enjoy it.*
|
||||||
|
|
||||||
## Overview
|
## Overview
|
||||||
Quick description of this app.
|
YunoMonitor is a simple tools to auto-configure monitoring on a remote YunoHost server. So you need one server to monitor and another to run monitoring task.
|
||||||
|
|
||||||
|
YunoMonitor can send you email or SMS if you give him an URL API to do it (like the API from the operator "free mobile").
|
||||||
|
|
||||||
**Shipped version:** 1.0
|
**Shipped version:** 1.0
|
||||||
|
|
||||||
## Screenshots
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Demo
|
|
||||||
|
|
||||||
* [Official demo](Link to a demo site for this app)
|
|
||||||
|
|
||||||
## Configuration
|
## Configuration
|
||||||
|
|
||||||
How to configure this app: by an admin panel, a plain file with SSH, or any other way.
|
To configure this app.
|
||||||
|
|
||||||
## Documentation
|
## Documentation
|
||||||
|
|
||||||
* Official documentation: Link to the official documentation of this app
|
* Official documentation: https://github.com/zamentur/yunomonitor/blob/master/README.md
|
||||||
* YunoHost documentation: If specific documentation is needed, feel free to contribute.
|
|
||||||
|
|
||||||
## YunoHost specific features
|
## YunoHost specific features
|
||||||
|
|
||||||
#### Multi-users support
|
|
||||||
|
|
||||||
Are LDAP and HTTP auth supported?
|
|
||||||
Can the app be used by multiple users?
|
|
||||||
|
|
||||||
#### Supported architectures
|
#### Supported architectures
|
||||||
|
|
||||||
* x86-64b - [](https://ci-apps.yunohost.org/ci/apps/REPLACEBYYOURAPP/)
|
* x86-64b - [](https://ci-apps.yunohost.org/ci/apps/yunomonitor/)
|
||||||
* ARMv8-A - [](https://ci-apps-arm.yunohost.org/ci/apps/REPLACEBYYOURAPP/)
|
* ARMv8-A - [](https://ci-apps-arm.yunohost.org/ci/apps/yunomonitor/)
|
||||||
* Jessie x86-64b - [](https://ci-stretch.nohost.me/ci/apps/REPLACEBYYOURAPP/)
|
|
||||||
|
|
||||||
## Limitations
|
|
||||||
|
|
||||||
* Any known limitations.
|
|
||||||
|
|
||||||
## Additional information
|
|
||||||
|
|
||||||
* Other information you would add about this application
|
|
||||||
|
|
||||||
**More information on the documentation page:**
|
|
||||||
https://yunohost.org/packaging_apps
|
|
||||||
|
|
||||||
## Links
|
## Links
|
||||||
|
|
||||||
* Report a bug: https://github.com/YunoHost-Apps/REPLACEBYYOURAPP_ynh/issues
|
* Report a bug: https://github.com/YunoHost-Apps/yunomonitor_ynh/issues
|
||||||
* App website: Link to the official website of this app
|
* App website: https://github.com/zamentur/yunomonitor
|
||||||
* Upstream app repository: Link to the official repository of the upstream app
|
* Upstream app repository: https://github.com/zamentur/yunomonitor
|
||||||
* YunoHost website: https://yunohost.org/
|
* YunoHost website: https://yunohost.org/
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
@ -76,11 +42,11 @@ Developers info
|
||||||
----------------
|
----------------
|
||||||
|
|
||||||
**Only if you want to use a testing branch for coding, instead of merging directly into master.**
|
**Only if you want to use a testing branch for coding, instead of merging directly into master.**
|
||||||
Please do your pull request to the [testing branch](https://github.com/YunoHost-Apps/REPLACEBYYOURAPP_ynh/tree/testing).
|
Please do your pull request to the [testing branch](https://github.com/YunoHost-Apps/yunomonitor_ynh/tree/testing).
|
||||||
|
|
||||||
To try the testing branch, please proceed like that.
|
To try the testing branch, please proceed like that.
|
||||||
```
|
```
|
||||||
sudo yunohost app install https://github.com/YunoHost-Apps/REPLACEBYYOURAPP_ynh/tree/testing --debug
|
sudo yunohost app install https://github.com/YunoHost-Apps/yunomonitor_ynh/tree/testing --debug
|
||||||
or
|
or
|
||||||
sudo yunohost app upgrade REPLACEBYYOURAPP -u https://github.com/YunoHost-Apps/REPLACEBYYOURAPP_ynh/tree/testing --debug
|
sudo yunohost app upgrade yunomonitor -u https://github.com/YunoHost-Apps/yunomonitor_ynh/tree/testing --debug
|
||||||
```
|
```
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue