Author: ldywicki
Date: Tue Sep 6 09:59:50 2011
New Revision: 1165582
URL: http://svn.apache.org/viewvc?rev=1165582&view=rev
Log:
Added more informations to manual
Added:
karaf/sandbox/webconsole/trunk/manual/src/main/webapp/developers-guide/branding.conf
karaf/sandbox/webconsole/trunk/manual/src/main/webapp/developers-guide/extending.conf
karaf/sandbox/webconsole/trunk/manual/src/main/webapp/developers-guide/security.conf
Modified:
karaf/sandbox/webconsole/trunk/manual/src/main/webapp/WEB-INF/scalate/layouts/headers.jade
karaf/sandbox/webconsole/trunk/manual/src/main/webapp/css/style.css
karaf/sandbox/webconsole/trunk/manual/src/main/webapp/developers-guide/index.conf
Modified:
karaf/sandbox/webconsole/trunk/manual/src/main/webapp/WEB-INF/scalate/layouts/headers.jade
URL:
http://svn.apache.org/viewvc/karaf/sandbox/webconsole/trunk/manual/src/main/webapp/WEB-INF/scalate/layouts/headers.jade?rev=1165582&r1=1165581&r2=1165582&view=diff
==============================================================================
---
karaf/sandbox/webconsole/trunk/manual/src/main/webapp/WEB-INF/scalate/layouts/headers.jade
(original)
+++
karaf/sandbox/webconsole/trunk/manual/src/main/webapp/WEB-INF/scalate/layouts/headers.jade
Tue Sep 6 09:59:50 2011
@@ -15,9 +15,9 @@ html(lang="en")
= include("/org/fusesource/scalate/console/console_head.scaml")
link(href={uri("/css/scalate/console.css")} rel="stylesheet"
type="text/css")
+ link(href={uri("/css/reset.css")} rel="stylesheet" type="text/css")
link(href={uri("/css/grid.css")} rel="stylesheet" type="text/css")
link(href={uri("/css/style.css")} rel="stylesheet" type="text/css")
- link(href={uri("/css/reset.css")} rel="stylesheet" type="text/css")
link(href={uri("/css/sh/shCore.css")} rel="stylesheet" type="text/css")
link(href={uri("/css/sh/shThemeDefault.css")} rel="stylesheet"
type="text/css")
Modified: karaf/sandbox/webconsole/trunk/manual/src/main/webapp/css/style.css
URL:
http://svn.apache.org/viewvc/karaf/sandbox/webconsole/trunk/manual/src/main/webapp/css/style.css?rev=1165582&r1=1165581&r2=1165582&view=diff
==============================================================================
--- karaf/sandbox/webconsole/trunk/manual/src/main/webapp/css/style.css
(original)
+++ karaf/sandbox/webconsole/trunk/manual/src/main/webapp/css/style.css Tue Sep
6 09:59:50 2011
@@ -45,4 +45,20 @@ a:link, a:active, a:visited {
pre {
font-family: monospace;
+}
+
+h1, h2, h3 {
+ margin-top: 15px;
+}
+
+h1 {
+ font-size: 24px;
+}
+
+h2 {
+ font-size: 20px;
+}
+
+h3 {
+ font-size: 16px;
}
\ No newline at end of file
Added:
karaf/sandbox/webconsole/trunk/manual/src/main/webapp/developers-guide/branding.conf
URL:
http://svn.apache.org/viewvc/karaf/sandbox/webconsole/trunk/manual/src/main/webapp/developers-guide/branding.conf?rev=1165582&view=auto
==============================================================================
---
karaf/sandbox/webconsole/trunk/manual/src/main/webapp/developers-guide/branding.conf
(added)
+++
karaf/sandbox/webconsole/trunk/manual/src/main/webapp/developers-guide/branding.conf
Tue Sep 6 09:59:50 2011
@@ -0,0 +1,17 @@
+h1. Branding
+
+Every product requires sometimes more or less fancy look and feel. We try to
provide working project which may be customized by vendors in many different
ways - first of all by building extensions, but also by changing webconsole
layout easily.
+
+h2. Brand provider
+
+Brand provider is an interface which is used by default in core and other
modules. Every page which extends *org.apache.karaf.webconsole.core.BasePage*
will use it. An instance of this interface is looked up in OSGi service
registry. Brand provider is asked for header image and list of behaviors to add
in every page. These behaviors may add own CSS and JavaScript files.
+
+You can use only one brand provider in webconsole, so if you will have
multiple brand providers please use *service.ranking* when you register your
OSGi service.
+
+h2. Shipping new translations
+
+New translations should be attached to modules as a fragments. That's easiest
way to extend module classpath and add new resources.
+
+h2. Security customization
+
+TODO
\ No newline at end of file
Added:
karaf/sandbox/webconsole/trunk/manual/src/main/webapp/developers-guide/extending.conf
URL:
http://svn.apache.org/viewvc/karaf/sandbox/webconsole/trunk/manual/src/main/webapp/developers-guide/extending.conf?rev=1165582&view=auto
==============================================================================
---
karaf/sandbox/webconsole/trunk/manual/src/main/webapp/developers-guide/extending.conf
(added)
+++
karaf/sandbox/webconsole/trunk/manual/src/main/webapp/developers-guide/extending.conf
Tue Sep 6 09:59:50 2011
@@ -0,0 +1,51 @@
+h1. Extending Webconsole
+
+Webconsole extensions may be done by different ways. In this section we going
to cover followin topic - new pages, new navigation elements and new widgets.
+
+h2. New pages
+
+Webconsole ships four different types of pages which should be used in
different cases.
+* BasePage
+* SecuredPage
+* SinglePage
+* SidebarPage
+
+h3. BasePage
+
+BasePage is used to load shared resources and keep same look and feel on all
webconsole pages. You should use this page for non-secured operations for
example to build your own LoginPage and so on.
+
+h3. SecuredPage
+
+SecuredPage will be rendered to users which have 'admin' role assigned. Others
will see error page. By default this page renders navigation bar and adds
logout link.
+
+h3. SinglePage
+
+SinglePage is secured. If you have no additional navigation or your content
requires full screen width then use this page. You will have all screen to
display data.
+
+h3. SidebarPage
+
+SidebarPage is secured. If you have additional navigation then Sidebar is what
you need. In your extension you have to call *setSidebarProvider* method
othervise your sidebar won't be displayed.
+
+h2. New navigation elements
+
+When you implement own modules you honestly want to add new tab or new link
somewhere to let user navigate directly to your logic without address bar usage.
+
+To do this we shipped a *ConsoleTabProvider* interface. Just register an
implementation of it under OSGi as a service and when webconsole will be ready
to serve content it will ask your service for module home link and sub items.
+
+h2. Widgets
+
+Every management tool requires widgets. ;) We know about this and we provided
also a *WidgetProvider* interface. It works in same way as a ConsoleTabProvider
but it doesn't return links - it returns panels. Please remember following rule
- because widgets may be used in different places you need to directly specify
your widget provider 'intention'. Webconsole uses 'intention' service property
to group providers. Please take a look for example below:
+{code:xml}
+<?xml version="1.0" encoding="utf-8" ?>
+<blueprint xmlns="http://www.osgi.org/xmlns/blueprint/v1.0.0";>
+ <service ref="widgetProvider"
interface="org.apache.karaf.webconsole.core.widget.WidgetProvider">
+ <service-properties>
+ <entry key="intention" value="dashboard" />
+ </service-properties>
+ </service>
+
+ <bean id="widgetProvider" class="com.example.extension.MyWidgetProvider" />
+</blueprint>
+{code}
+
+Widgets created by MyWidgetProvider will be used in dashboard.
\ No newline at end of file
Modified:
karaf/sandbox/webconsole/trunk/manual/src/main/webapp/developers-guide/index.conf
URL:
http://svn.apache.org/viewvc/karaf/sandbox/webconsole/trunk/manual/src/main/webapp/developers-guide/index.conf?rev=1165582&r1=1165581&r2=1165582&view=diff
==============================================================================
---
karaf/sandbox/webconsole/trunk/manual/src/main/webapp/developers-guide/index.conf
(original)
+++
karaf/sandbox/webconsole/trunk/manual/src/main/webapp/developers-guide/index.conf
Tue Sep 6 09:59:50 2011
@@ -2,5 +2,8 @@ h1. Developer guide
This part of manual contains informations for extensions developers.
+ * [Extending webconsole|extending]
+ * [Security|security]
* [Displaying tables|tables]
- * [Serialization|serialization]
\ No newline at end of file
+ * [Serialization|serialization]
+ * [Branding|branding]
\ No newline at end of file
Added:
karaf/sandbox/webconsole/trunk/manual/src/main/webapp/developers-guide/security.conf
URL:
http://svn.apache.org/viewvc/karaf/sandbox/webconsole/trunk/manual/src/main/webapp/developers-guide/security.conf?rev=1165582&view=auto
==============================================================================
---
karaf/sandbox/webconsole/trunk/manual/src/main/webapp/developers-guide/security.conf
(added)
+++
karaf/sandbox/webconsole/trunk/manual/src/main/webapp/developers-guide/security.conf
Tue Sep 6 09:59:50 2011
@@ -0,0 +1,22 @@
+h1. Security
+
+Every management application requires authentication and authorization. In our
case both are controlled by Wicket. But from technology point of view there is
also second element which provides information about users and roles - JAAS.
+
+By default Webconsole uses JAAS to authenticate users and grant them roles.
+
+h2. JAAS Configuration
+
+Realm used by webconsole is named "karaf". If you would like to change realm
name please check the [branding] page. This realm may be configured in
different ways, depending on environment you run. If you run webconsole on
Karaf this realm is default. How to add new users and grant them new roles
then? Using *$KARAF_HOME/etc/users.properties* file. Let check what do we have
by default in this file:
+
+{code}
+karaf=karaf
+{code}
+
+We have user named 'karaf' with password 'karaf' and no roles assigned.
Because we do require roles we need to modify this file a bit:
+
+{code}
+karaf=karaf,admin
+{code}
+
+After password we can pass list of roles separated by commas assigned to
account.
+
