README.md in klogger-1.7.0 vs README.md in klogger-2.0.0
- old
+ new
@@ -1,30 +1,40 @@
-[](https://travis-ci.org/killbill/killbill-logging-plugin)
-[](https://codeclimate.com/github/killbill/killbill-logging-plugin)
-
killbill-logging-plugin
=======================
Plugin to log Kill Bill events to Syslog, IRC, emails, ...
Release builds are available on [Maven Central](http://search.maven.org/#search%7Cga%7C1%7Cg%3A%22org.kill-bill.billing.plugin.ruby%22%20AND%20a%3A%22logging-plugin%22) with coordinates `org.kill-bill.billing.plugin.ruby:logging-plugin`.
+Kill Bill compatibility
+-----------------------
+
+| Plugin version | Kill Bill version |
+| -------------: | ----------------: |
+| 2.x.y | 0.14.z |
+
Configuration
-------------
-The plugin expects a `klogger.yml` configuration file containing the following:
-
```
+curl -v \
+ -X POST \
+ -u admin:password \
+ -H 'X-Killbill-ApiKey: bob' \
+ -H 'X-Killbill-ApiSecret: lazar' \
+ -H 'X-Killbill-CreatedBy: admin' \
+ -H 'Content-Type: text/plain' \
+ -d '
syslog:
:enabled: true
:ident: 'klogger'
:options: 9 # ::Syslog::LOG_PID | ::Syslog::LOG_NDELAY
:facility: 128 # ::Syslog::LOG_LOCAL0
irc:
:enabled: true
- :channels: ['#killbilling']
+ :channels: ['#killbillio']
:nick: 'klogger'
:server: 'irc.freenode.org'
:port: 6667
:password: 'foo'
@@ -37,9 +47,8 @@
:domain: 'your.host.name'
:username: 'username'
:password: 'password'
:authentication: 'plain'
:enable_starttls_auto: true
+' \
+ http://127.0.0.1:8080/1.0/kb/tenants/uploadPluginConfig/killbill-logger
```
-
-By default, the plugin will look at the plugin directory root (where `killbill.properties` is located) to find this file.
-Alternatively, set the Kill Bill system property `-Dorg.killbill.billing.osgi.bundles.jruby.conf.dir=/my/directory` to specify another location.