[aries-jax-rs-whiteboard] branch master updated: Document configuration properties (thanks to Ray)

[cs...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

cschneider pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/aries-jax-rs-whiteboard.git


The following commit(s) were added to refs/heads/master by this push:
     new 7be5ee8  Document configuration properties (thanks to Ray)
7be5ee8 is described below

commit 7be5ee821956fe5c5723ba4749956683ebdbefd6
Author: Christian Schneider <cs...@adobe.com>
AuthorDate: Sun Apr 5 08:59:34 2020 +0200

    Document configuration properties (thanks to Ray)
---
 README.md | 19 +++++++++++++++++++
 1 file changed, 19 insertions(+)

diff --git a/README.md b/README.md
index 746000f..cbc3664 100644
--- a/README.md
+++ b/README.md
@@ -5,6 +5,25 @@
 
 Aries JAX-RS Whiteboard is the reference implementation of the [OSGi JAX-RS Services Whiteboard 1.0](https://osgi.org/specification/osgi.cmpn/7.0.0/service.jaxrs.html).
 
+
+## Configuration
+
+The whiteboard is configured using configuration admin.
+
+PID                                        | Purpose
+-------------------------------------------| -------
+org.apache.aries.jax.rs.whiteboard.default | Default JAX-RS Whiteboard instance
+org.apache.aries.jax.rs.whiteboard         | Factory PID for creating additional JAX-RS Whiteboard instances
+
+Property                            | Default                | Description
+------------------------------------|------------------------|--------------------------------------------------------
+enabled                             | true                   | Enable or disable the whiteboard instance
+default.application.base            | /                      | Default path for applications
+application.base.prefix             | ""                     | Prefix for application base
+osgi.http.whiteboard.target         | (osgi.http.endpoint=*) | Select the http whiteboard service if there are several
+osgi.http.whiteboard.context.select |                        | Select the http whiteboard context to be used
+hide-service-list-page              | true                   | Hide the CXF service list 
+
 ## Integrations
 
 The `integrations` folder contains OSGi enabled integrations for a variety of useful libraries that you might want to use with JAX-RS. In many cases these are just adding OSGi lifecycle and configuration to existing JAX-RS enabled libraries.