Author: scottbw
Date: Fri Mar 23 12:35:55 2012
New Revision: 1304316
URL: http://svn.apache.org/viewvc?rev=1304316&view=rev
Log:
Updated server admin doc, and link to 0.9.x version
Modified:
incubator/wookie/site/trunk/content/wookie/docs/admin.mdtext
Modified: incubator/wookie/site/trunk/content/wookie/docs/admin.mdtext
URL:
http://svn.apache.org/viewvc/incubator/wookie/site/trunk/content/wookie/docs/admin.mdtext?rev=1304316&r1=1304315&r2=1304316&view=diff
==============================================================================
--- incubator/wookie/site/trunk/content/wookie/docs/admin.mdtext (original)
+++ incubator/wookie/site/trunk/content/wookie/docs/admin.mdtext Fri Mar 23
12:35:55 2012
@@ -16,42 +16,26 @@ Notice: Licensed to the Apache Softwa
specific language governing permissions and limitations
under the License.
-NOTE: This documentation is still in the process of being written. If you have
an questions about the Wookie administration interface, please ask on the
mailing list.
-
-NOTE(2): Future versions of Wookie may not have a web interface for
administration, but be configured using command-line tools
-and/or admin clients making use of the REST API.
-
-# Downloading and installing Wookie
-See [Downloading and Installing Wookie][1]
-
-# Using the Administration web interface
-To access the administrators interface in the development server, go to
-
- [http://]{your server}/wookie/admin
+This is the administration guide for Wookie 0.10 and later. For earlier
versions, see the [Wookie 0.9.x Server Administration Guide][1].
-By default, and when Wookie is running in "standalone" mode, the Wookie server
admin username and password are both "java".
+From 0.10.0, most Wookie admin functionality is provided either by editing
text configuration files, or via the REST API. There is no longer a default web
admin user interface.
-#Adding and removing widgets
-##Adding widgets using the admin interface
+NOTE: This documentation is still in the process of being written. If you have
an questions about the Wookie administration interface, please ask on the
mailing list.
-On the admin page, click "add new widget". A page containing an upload form
will be displayed. Select the widget file you wish to deploy
-and click the "publish" button to upload it.
+# Downloading and installing Wookie
+See [Downloading and Installing Wookie][2]
-##Adding widgets using a watched folder
+#Adding and Updating widgets
Wookie supports the "hot deployment" of widgets by adding .wgt files to a
watched folder. The location of the folder is determined by the
widget.deployfolder property. Hot-deploy functionality is enabled by default;
you can disable it if desired by setting widget.hot_deploy=false. Note that
only widgets that have a .wgt file extension will be deployed automatically.
-#Removing widgets
+Widgets can also be added using the REST API.
-To remove a widget, from the admin page click "Remove widget from system".
This will show a list of all widgets currently deployed with
-a link to delete widgets.
-
-Note that deleting a widget also deletes all instances and data associated
with the widget by all users.
+#Removing widgets
-#Widget services (categories)
+Deleting widgets is managed using the REST API. Note that deleting a widget
also deletes all instances and data associated with the widget by all users.
-Services are deprecated.
+# Access Policies
-#Whitelist and Access Policies
When a Widget tries to access a third-party website or service, this is
usually prevented by the browser's
same-origin policy. This is to prevent cross-site scripting hacks and
unauthorized sharing of personal data.
However, there are many instances where a Widget may legitimately want to make
a call to a third party service
@@ -60,17 +44,15 @@ tunnel requests through Wookie.
To use the proxy, the widget author simply needs to call
"widget.proxify(myurl)" to change their service URL to one that makes use of
the proxy. However, Wookie will not make the HTTP request to take place unless
the requested URL is permitted using either the global whitelist or by an
enabled Widget Access Request Policy.
-##Global Whitelist
-The global whitelist is accessed from the White list section of the
Administrator Menu page. From here you can view the white list, and add and
remove entries. Each whitelist entry allows ANY widget to invoke the URL you've
added.
+The proxy servlet is configured by default to operate in a whitelist mode, and
is configured using the policies text configuration file (usually found at
WEB-INF/classes/policies). There is additional documentation in the policies
file itself on how to manage access policies.
-##Widget Access Request Policies
-Widget Access Request Policies (also known as W3C WARP; see
[http://www.w3.org/TR/widgets-access/][2]) is a W3C specification that allows
Widgets to specify origins they wish to access in the Widget's config.xml file.
+By default, Wookie automatically adds policies specified in widget <access>
element when installing a new Widget, and notifies the Administrator with a
message in the Wookie log file.
-When you add a Widget to Wookie, any `<access>` elements are turned into
access policies that can be viewed in the Admininstrator interface.
+Policies can also be set via the REST API.
-To manage WARPs, go to the White list section of the Administrator Menu page,
and select Manage widget access request policies. From this page you can view a
table of policies that have been created; the format of the table is (from left
to right): the name of the widget the policy applies to, the origin to allow,
and whether the policy is granted or not granted. Finally, there is a button to
toggle the state of the policy.
+# API Keys
-By default, Wookie automatically grants WARPs when installing a new Widget,
and notifies the Administrator with a message in the Admin interface and in the
Wookie log file.
+Wookie operates as a multi-tenancy server, with each application identified by
its API Key. There is a default API Key called "TEST" in a new Wookie
installation; for each application that connects to Wookie an API key should be
created. This can be done via the REST API (e.g. from an admin client.)
#Server configuration
@@ -80,7 +62,7 @@ The Wookie server comes with a built-in
Login configuration settings can be found in the web.xml file located in
wookie/WEB-INF.
##Integration with Shindig
-See [Integrating Wookie With Shindig][3]
+See [Integrating Wookie With Shindig][4]
##Proxy configuration
In order for widgets running in Wookie to communicate with external web
services using Ajax, requests must be redirected through a server-side proxy.
The proxy configuration is located in WEB-INF/classes/widgetserver.properties.
@@ -120,10 +102,11 @@ Username and password are optional. You
#Virtual host configuration
-See [Running Wookie][4]
+See [Running Wookie][5]
- [1]: /wookie/docs/download.html
- [2]: http://www.w3.org/TR/widgets-access/
- [3]: /wookie/docs/shindig.html
- [4]: /wookie/docs/developer/running.html
\ No newline at end of file
+ [1]: /wookie/docs/admin_9.html
+ [2]: /wookie/docs/download.html
+ [3]: http://www.w3.org/TR/widgets-access/
+ [4]: /wookie/docs/shindig.html
+ [5]: /wookie/docs/developer/running.html
\ No newline at end of file
