karaf-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Achim Nierbeck (JIRA)" <j...@apache.org>
Subject [jira] Commented: (KARAF-303) Documentation for available Features and how they might be configured
Date Wed, 01 Dec 2010 22:30:12 GMT

    [ https://issues.apache.org/jira/browse/KARAF-303?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12965888#action_12965888
] 

Achim Nierbeck commented on KARAF-303:
--------------------------------------

This would be my "proposal" on how to document this. 

{code}
    <feature name="http" version="${project.version}" resolver="(obr)">
    	<description>
    		Provides a standard web container for standard services and http service which are needed
as runtime for the webconsole feature.
    	</description>
        <config name="org.ops4j.pax.web">
            org.osgi.service.http.port=8181
            org.ops4j.pax.web.config.file=${karaf.base}/etc/jetty.xml
        </config>
        <configurationDescription>
        	<confentry name="org.osgi.service.http.port" defaultValue="8181">The port the
web container is running on</confentry>
        	<confentry name="org.ops4j.pax.web.config.file" defaultValue="${karaf.base}/etc/jetty.xml">External
location to look for an additional web container (usually jetty) configuration file</confentry>
        </configurationDescription>
        <feature version="[7.0,8.0)">jetty</feature>
    	<bundle>mvn:org.ops4j.pax.web/pax-web-api/${pax.web.version}</bundle>
        <bundle>mvn:org.ops4j.pax.web/pax-web-spi/${pax.web.version}</bundle>
        <bundle>mvn:org.ops4j.pax.web/pax-web-runtime/${pax.web.version}</bundle>
        <bundle>mvn:org.ops4j.pax.web/pax-web-jetty/${pax.web.version}</bundle>
    </feature>
{code}

> Documentation for available Features and how they might be configured
> ---------------------------------------------------------------------
>
>                 Key: KARAF-303
>                 URL: https://issues.apache.org/jira/browse/KARAF-303
>             Project: Karaf
>          Issue Type: Improvement
>          Components: documentation
>            Reporter: Achim Nierbeck
>
> The documentation for 2.2.0 (and before that) http://karaf.apache.org/manual/2.1.99-SNAPSHOT/index.html
> does lack information of what kind of additional features can be installed. 
> Two things should be of Interest here: 
> 1. What is the feature good for
> 2. How can it be configured
> Just one brief example using features for http and war: 
> description:
> http - is a standard webcontainer which provides standard services which are needed for
webconsole
> war - enables the fullfeature set of the webcontainer by enabling JSP support and deployment
of non OSGi wars ...
> configuration:
> following configurations are available for the webcontainer: 
> ...
> org.osgi.service.http.port=8181 - entry for the port the webcontainer is running on
> org.ops4j.pax.web.config.file=${karaf.base}/etc/jetty.xml - entry for the place to look
for an additional jetty configuration
> ...
> In case of the jetty even some special configurations on how to connect jetty with the
jaas should be documented. 
> I'm sure this isn't the only place where some more detailed documentation is helpful
for the user.

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


Mime
View raw message