Changeset 1197 for obs_notify_generic/README.md

Timestamp:

Oct 13, 2015, 12:33:31 PM (9 years ago)

Author:

joergs

Message:

fixes comments

File:

• obs_notify_generic/README.md (modified) (7 diffs)

obs_notify_generic/README.md

@@ -31 +31 @@
 -------------
 
-All configuration is done in the file
+All configuration for this plugin is done in the file
 
 ```
@@ -45 +45 @@
 but can be configured.
 
-The best configuration to start is by
+The starting configuration could look like this:
 
 ```
@@ -53 +53 @@
 ```
 
-This logs all UNKNOWN events. With this configuration this are all events, as no specific events are defined.
+This logs all UNKNOWN events. With this configuration this are all events, as no specific notification types are defined.
 
 Usefull notification types are
@@ -62 +62 @@
 Each event come with a number of parameter. These will also be logged.
 
-The configuration directove `filter` limits a notification type to certain cases. Filter can be regexes.
+The configuration directive `filter` limits a notification type to certain cases. Filter can be regexes.
 
 Example:
@@ -75 +75 @@
         },
         {
-            "filter" => { 'project' => '.*:bareos', 'repository' => 'SLE_12' },
+            "filter" => { 'project' => '.*:bareos', 'repo' => 'SLE_12' },
             "action" => 'logger "project $project published for repository $repository',
             "log"    => 0,
@@ -84 +84 @@
 ```
 
-Meaing:
+Meaning:
   * type=REPO_PUBLISH_STATE
     * ignore it
@@ -92 +92 @@
 
 Limitations:
-  * the `action` run as user obsrun. As the OBS service run as daemon, only very few environment variables are set.
-  * the `action`s should have a short runtime. As long as these scripts run, some other services from the obs are blocked. Maybe the scripts are forcefully ended by the OBS service.
+  * the `action` run as user obsrun. As the OBS service run as daemon, only very few environment variables are set. It might help to call scripts using `sudo -u USERNAME`
+  * the `action` script do run in background, to prevent blocking other OBS services. Output will be write to `${logfile}.out.log`.