Update installation instructions

This commit is contained in:
Dmitriy Simushev 2014-11-27 12:40:58 +00:00
parent a0de85bf58
commit 3f26559dec

View File

@ -6,19 +6,21 @@ It provides notification about new messages and new threads in window title.
## Installation ## Installation
1. Get the archive with the plugin sources. At the moment the only option is to build the plugin from sources. 1. Get the archive with the plugin sources. At the moment the only option is to build the plugin from sources.
2. Untar/unzip the plugin's archive. 2. Untar/unzip the plugin's archive.
3. Put files of the plugins to the `<Mibew root>/plugins` folder. 3. Put files of the plugins to the `<Mibew root>/plugins` folder.
4. Add plugins definition to "plugins" structure in "`<Mibew root>`/configs/config.yml".
If the "plugins" stucture looks like `plugins: []` it will become: 4. (optional) Add plugins configs to "plugins" structure in "`<Mibew root>`/configs/config.yml". If the "plugins" stucture looks like `plugins: []` it will become:
```yaml ```yaml
plugins: plugins:
- "Mibew:TitleNotification": # Plugin's configurations are described below
name: "Mibew:TitleNotification"
config: # Plugin's configurations are described below
new_thread: false new_thread: false
new_message: "operator" new_message: "operator"
``` ```
5. Navigate to "`<Mibew Base URL>`/operator/plugin" page and enable the plugin.
## Plugin's configurations ## Plugin's configurations