NuKVM/xen-orchestra
3
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update README

Browse Source
This commit is contained in:
ABHAMON Ronan 2015-11-26 10:39:48 +01:00
parent d48fa235b1
commit 56db5dc341
1 changed files with 18 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
packages/xo-server-backup-reports/README.md
View File

@ -2,11 +2,11 @@
> Backup reports plugin for XO-Server
This plugin allows to receive email notifications when backups jobs are done.
This plugin allows to receive email notifications when backup's jobs are done.
## Install
Installation of the [npm package](https://npmjs.org/package/${pkg.name}):
Installation of the [npm package](https://npmjs.org/package/xo-server-backup-reports):
```
> npm install --global xo-server-backup-reports
@ -14,7 +14,22 @@ Installation of the [npm package](https://npmjs.org/package/${pkg.name}):
## Usage
**TODO**
### Prerequisite
You must have the [xo-server-transport-email](https://github.com/vatesfr/xo-server-transport-email) plugin enabled to use xo-server-backup-reports.
### Add the plugin to XO-Server config
```yaml
plugins:
xo-server-backup-reports:
# Receivers of notifications
to:
# Define your receivers here using brackets like this:
# [email1, email2, ...]
```
## Development