You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@esme.apache.org by rh...@apache.org on 2011/07/16 20:29:11 UTC
svn commit: r1147473 - in /esme/site/trunk: content/ content/docs/install/
templates/
Author: rhirsch
Date: Sat Jul 16 18:29:10 2011
New Revision: 1147473
URL: http://svn.apache.org/viewvc?rev=1147473&view=rev
Log:
[ESME-351] Move Wiki to CMS
Added:
esme/site/trunk/content/docs/install/esme-desktop-client-server-config.mdtext
esme/site/trunk/content/docs/install/install_general.mdtext
esme/site/trunk/content/docs/install/java-servlet-container-installation-guide.mdtext
esme/site/trunk/content/docs/install/mac-os-x-10.6-installation-guide.mdtext
esme/site/trunk/content/docs/install/stax.mdtext
esme/site/trunk/content/docs/install/windows-vista-installation-guide.mdtext
Removed:
esme/site/trunk/content/ce-installation-guide.mdtext
esme/site/trunk/content/esme-desktop-client-server-config.mdtext
esme/site/trunk/content/esme-mailet-install-guide.mdtext
esme/site/trunk/content/mac-os-x-10.6-installation-guide.mdtext
esme/site/trunk/content/stax.mdtext
esme/site/trunk/content/windows-vista-installation-guide.mdtext
Modified:
esme/site/trunk/content/docs/install/esme-installation-guides.mdtext
esme/site/trunk/content/index.mdtext
esme/site/trunk/templates/sidenav.mdtext
Added: esme/site/trunk/content/docs/install/esme-desktop-client-server-config.mdtext
URL: http://svn.apache.org/viewvc/esme/site/trunk/content/docs/install/esme-desktop-client-server-config.mdtext?rev=1147473&view=auto
==============================================================================
--- esme/site/trunk/content/docs/install/esme-desktop-client-server-config.mdtext (added)
+++ esme/site/trunk/content/docs/install/esme-desktop-client-server-config.mdtext Sat Jul 16 18:29:10 2011
@@ -0,0 +1,39 @@
+Title: ESME Desktop Client Server Config
+<a name="ESMEDesktopClientServerConfig-HowtoconfiguretheESMEserverESMEDesktopconnectsto.."></a>
+# How to configure the ESME server ESME Desktop connects to ..
+
+By default ESME Desktop connects to the ESME instance running at
+http://www.esme.us, but if you are running your own instance of the server,
+you will need to change the server that ESME Desktop connects to .. here's
+how ..
+
+This setting is stored in your application storage directory in a file
+called preferences.xml ... the application storage directory path varies
+based on your operating system and your username
+
+<a name="ESMEDesktopClientServerConfig-MacOS:"></a>
+# MacOS:
+
+/Users/username/Library/Preferences/ESMEDesktop.05D8320A56ED876B4DC203B7387C89522DDC092F.1/Local
+Store/preferences.xml The GUID in the path may vary.
+
+<a name="ESMEDesktopClientServerConfig-Windows:"></a>
+# Windows:
+
+C:\Documents and Settings\username\Application
+Data\ESMEDesktop.05D8320A56ED876B4DC203B7387C89522DDC092F.1\Local
+Store\preferences.xml
+
+If the file does not exist create preferences.xml and drop in the following
+xml and save .. <preferences> <preference name="ESME_APISERVER"
+value="http://api.esme.us/esme/api/"/> <preference name="ESME_SERVER"
+value="http://www.esme.us/esme/"/> </preferences>
+If the file exists then edit the values to your server urls. The new
+setting will be picked up the next time you start ESME Desktop.
+
+An example preferences file. The value for _token_ is from the Manage
+Tokens link, after you log in via the web. <preferences>
+ <preference name="ESME_APISERVER" value="http://api.esme.us/esme/api/"/>
+ <preference name="ESME_SERVER" value="http://www.esme.us/esme/"/>
+ <preference name="token" value="xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"/>
+</preferences>
Modified: esme/site/trunk/content/docs/install/esme-installation-guides.mdtext
URL: http://svn.apache.org/viewvc/esme/site/trunk/content/docs/install/esme-installation-guides.mdtext?rev=1147473&r1=1147472&r2=1147473&view=diff
==============================================================================
--- esme/site/trunk/content/docs/install/esme-installation-guides.mdtext (original)
+++ esme/site/trunk/content/docs/install/esme-installation-guides.mdtext Sat Jul 16 18:29:10 2011
@@ -1,40 +1,14 @@
Title: ESME Installation Guides
-#### Windows
-
-
-
* [Windows XP - Revision 885445](http://cwiki.apache.org/confluence/display/ESME/Windows+XP+Installation+Guide+%28revision+885445%29)
-* Mac OS X
+* [Windows Vista] (windows-vista-installation-guide.html)
+* [Mac OS X] (mac-os-x-10.6-installation-guide.html)
* Linux[Debian - Ubuntu](http://cwiki.apache.org/confluence/display/ESME/Linux+%28Debian+-+Ubuntu%29+Installation+Guide)
* [CloudBees](esme:stax.html)
* [SAP Netweaver Composition Environment (CE)](esme:stax.html)
* [ESME Mailet Install Guide](esme-mailet-install-guide.html)
-
-
-<a name="ESMEInstallationGuides-ESMEMailetInstallGuide"></a>
-#### ESME Mailet Install Guide
-
-
-
-
-
-
-
-
-<a name="ESMEInstallationGuides-JavaServletContainerInstallationGuide"></a>
-#### Java Servlet Container Installation Guide
-
-
-
-
-
-
-
-
-<a name="ESMEInstallationGuides-DesktopClientServerConfig"></a>
-#### Desktop Client Server Config
-
+* [Java Servlet Container Installation Guide](esme-mailet-install-guide.html)
+* [Desktop Client Server Config](esme-desktop-client-server-config.html)
Added: esme/site/trunk/content/docs/install/install_general.mdtext
URL: http://svn.apache.org/viewvc/esme/site/trunk/content/docs/install/install_general.mdtext?rev=1147473&view=auto
==============================================================================
--- esme/site/trunk/content/docs/install/install_general.mdtext (added)
+++ esme/site/trunk/content/docs/install/install_general.mdtext Sat Jul 16 18:29:10 2011
@@ -0,0 +1,19 @@
+Title: Build Apache ESME from Subversion
+
+### Checkout latest Apache ESME, build, and run
+Run the following commands, starting in the directory where you want to download Apache ESME:
+
+svn checkout http://svn.apache.org/repos/asf/esme/ esme
+cd esme/server/
+mvn jetty:run
+The third step can take a while the first time it is run as it needs to download all of Apache ESME's dependencies (and there are quite a few of those).
+
+After this you should be able to open your web browser and navigate to http://localhost:80/esme_server_SNAPSHOT_3.0 and see ESME running!
+
+### Optionally running under a separate Tomcat installation
+Install Tomcat
+Download latest Tomcat 6 Core .zip file from http://tomcat.apache.org/download-60.cgi
+In esme/server directory run "mvn package"
+Copy .war file in esme/server/target directory into the webapps/ directory of your Tomcat installation
+Start Tomcat (bin/startup.sh in the main Tomcat directory)
+Navigate your browser to http://localhost:80/esme_server_SNAPSHOT_3.0
Added: esme/site/trunk/content/docs/install/java-servlet-container-installation-guide.mdtext
URL: http://svn.apache.org/viewvc/esme/site/trunk/content/docs/install/java-servlet-container-installation-guide.mdtext?rev=1147473&view=auto
==============================================================================
--- esme/site/trunk/content/docs/install/java-servlet-container-installation-guide.mdtext (added)
+++ esme/site/trunk/content/docs/install/java-servlet-container-installation-guide.mdtext Sat Jul 16 18:29:10 2011
@@ -0,0 +1,45 @@
+Title: Java Servlet Container Installation Guide
+_ _
+_How to install and run ESME on a Java servlet container_
+
+<a name="JavaServletContainerInstallationGuide-Introduction"></a>
+# Introduction
+
+You will first need to build a WAR file, and then deploy it to your chosen
+Servlet container or J2EE application server.
+
+<a name="JavaServletContainerInstallationGuide-Details"></a>
+# Details
+
+Due to space constraints on Google Code, the main ESME war file is missing
+a couple of JAR files, namely the lift-webkit and scala-library files. The
+first thing you need to do is to unpack the ESME WAR file (jar \-xvf
+esme-yyyy-mm-dd.war), copy the lift and Scala library files to WEB-INF/lib
+and then create a new WAR file (jar \-cvf esme.war).
+
+If you are using a J2EE 1.5 server, then deploy the WAR file according to
+the vendor's instructions. For SAP NetWeaver? 7.1, this means using the
+Eclipse-based NetWeaver? Developer Studio in its Deployment perspective.
+
+For Tomcat, follow the instructions here: [http://tomcat.apache.org/tomcat-6.0-doc/deployer-howto.html](http://tomcat.apache.org/tomcat-6.0-doc/deployer-howto.html)
+
+Once you have deployed the WAR file, you can access ESME by pointing your browser to http://\[server}:[port](server}:[port.html)
+/esme
+
+<a name="JavaServletContainerInstallationGuide-Installingbehindacorporatefirewall"></a>
+# Installing behind a corporate firewall
+
+Often you may wish to install ESME behind the firewall. In most cases, you
+won't have an internal OpenId? provider, which means that your users are
+going to use OpenIds? from external providers. Usually, you will have to go
+through an internal proxy.
+
+If this is the case, then you must set the proxy server. If you are using
+Tomcat, then the you must add a property file to the
+"webapps\esme\WEB-INF\classes\props" directory. This file must be named
+after the user under which the process is running. On Tomcat 6.0 under
+windows, then this file would be "SYSTEM.props". Capitalization counts.
+This file must include the following lines:
+
+http.proxyHost=[proxy - look in your browser](proxy---look-in-your-browser.html)
+http.proxyPort=[proxy port - look in your browser](proxy-port---look-in-your-browser.html)
Added: esme/site/trunk/content/docs/install/mac-os-x-10.6-installation-guide.mdtext
URL: http://svn.apache.org/viewvc/esme/site/trunk/content/docs/install/mac-os-x-10.6-installation-guide.mdtext?rev=1147473&view=auto
==============================================================================
--- esme/site/trunk/content/docs/install/mac-os-x-10.6-installation-guide.mdtext (added)
+++ esme/site/trunk/content/docs/install/mac-os-x-10.6-installation-guide.mdtext Sat Jul 16 18:29:10 2011
@@ -0,0 +1,40 @@
+Title: Mac OS X 10.6 Installation Guide
+<a name="MacOSX10.6InstallationGuide-HowtobuildthelatestESMEfromSubversion"></a>
+# How to build the latest ESME from Subversion
+
+<a name="MacOSX10.6InstallationGuide-Prerequisites"></a>
+### Prerequisites
+
+* XCode (recommended) - install from at [http://developer.apple.com/technology/xcode.html](http://developer.apple.com/technology/xcode.html)
+ (requires Apple Developer Network subscription, which will cost you an
+email address)
+* Maven - with XCode it is command "mvn"
+* Subversion - comes with Mac OS X 10.6
+
+<a name="MacOSX10.6InstallationGuide-CheckoutlatestESME,build,andrun"></a>
+### Checkout latest ESME, build, and run
+
+Run the following commands, starting in the directory where you want to
+download ESME:
+
+1. svn checkout http://svn.apache.org/repos/asf/incubator/esme/trunk esme
+1. cd esme/server/
+1. mvn jetty:run
+
+The third step can take a while the first time it is run as it needs to
+download all of ESME's dependencies (and there are quite a few of those).
+
+After this you should be able to open your web browser and navigate to
+http://localhost:8080/ and see ESME running!
+
+<a name="MacOSX10.6InstallationGuide-OptionallyrunningunderaseparateTomcatinstallation"></a>
+### Optionally running under a separate Tomcat installation
+
+1. Install Tomcat
+** Download latest Tomcat 6 Core .zip file from [http://tomcat.apache.org/download-60.cgi](http://tomcat.apache.org/download-60.cgi)
+1. In esme/server directory run "mvn package"
+1. Copy .war file in esme/server/target directory into the webapps/
+directory of your Tomcat installation
+1. Start Tomcat (bin/startup.sh in the main Tomcat directory)
+1. Navigate your browser to http://localhost:8080/esme_server_SNAPSHOT_3.0
+
Added: esme/site/trunk/content/docs/install/stax.mdtext
URL: http://svn.apache.org/viewvc/esme/site/trunk/content/docs/install/stax.mdtext?rev=1147473&view=auto
==============================================================================
--- esme/site/trunk/content/docs/install/stax.mdtext (added)
+++ esme/site/trunk/content/docs/install/stax.mdtext Sat Jul 16 18:29:10 2011
@@ -0,0 +1,68 @@
+Title: Stax
+<a name="Stax-Preqs."></a>
+## Preqs.
+
+* Functional build environment for Apache ESME including maven, current
+source code etc.
+* Account on Stax.net
+* [Stax SDK](http://wiki.stax.net/w/index.php/SDK)
+ must be installed locally
+* An application on the stax cloud must already exist
+
+<a name="Stax-Steps"></a>
+## Steps
+
+
+<a name="Stax-web.xml"></a>
+##### web.xml
+
+Add the following text to your file
+
+
+
+ <resource-ref>
+ <res-ref-name>esme</res-ref-name>
+ <res-type>javax.sql.DataSource</res-type>
+ <res-auth>Container</res-auth>
+ </resource-ref>
+
+
+<a name="Stax-stax-web.xml"></a>
+##### stax-web.xml
+
+Create a file in your webapp\WEB-INF directory. The contents of the file
+looks like this
+
+
+ <stax-web-app>
+ <resource name="esme" auth="Container" type="javax.sql.DataSource">
+ <param name="username" value="[Username for DB]
+" />
+ <param name="password" value="[Password for DB]
+" />
+ <param name="url" value="jdbc:stax://[DB name]
+" />
+ </resource>
+ </stax-web-app>
+
+
+
+The information for database is available in the Stax Console for your DB
+
+<a name="Stax-BuildApacheESME"></a>
+##### Build Apache ESME
+
+use _mvn clean install_
+
+<a name="Stax-"></a>
+#####
+
+
+<a name="Stax-DeployonStax"></a>
+##### Deploy on Stax
+
+1. Start the "Stax Console.bat" command (on windows)
+1. In this console use the app:deploy command to deploy the application:
+
+
+
Added: esme/site/trunk/content/docs/install/windows-vista-installation-guide.mdtext
URL: http://svn.apache.org/viewvc/esme/site/trunk/content/docs/install/windows-vista-installation-guide.mdtext?rev=1147473&view=auto
==============================================================================
--- esme/site/trunk/content/docs/install/windows-vista-installation-guide.mdtext (added)
+++ esme/site/trunk/content/docs/install/windows-vista-installation-guide.mdtext Sat Jul 16 18:29:10 2011
@@ -0,0 +1,99 @@
+Title: Windows Vista Installation Guide
+{info:title=Useful Information}
+This setup instruction is mainly based on Windows (Vista) & Apache Tomcat
+(version 6.0.18).
+You will find the complete "Installation & Deployment Guide" attatched to
+this page.
+{info}
+
+<a name="WindowsVistaInstallationGuide-InstallationofJava"></a>
+## Installation of Java
+
+1. You need a current installation of a Java Runtime Environment (JRE) on
+your machine; I used version 1.6.0_07-b06, which works well. You can get
+the Java binary from http://java.sun.com/javase.
+1. Your setup is successful, when you can afterwards open a commandline
+(-->start menu --> execute or search for "cmd.exe" ), issue a "java
+-version" command and see an output similar to the following:
+
+
+<a name="WindowsVistaInstallationGuide-InstallationofApacheTomcat"></a>
+## Installation of Apache Tomcat
+
+1. Download the current Apache Tomcat binary from
+http://tomcat.apache.org/download-60.cgi.
+1. The best option on the Windows Platform is the Windows Service Installer.
+Download it and execute the installer.
+1. You can follow the recommended install parameters: the only exception is
+the installation path: Tomcat recommends (along with MS-Windows settings)
+to be installed in c:\Program Files\Apache\... As this path includes
+spaces, some Java programs and configuration files have trouble starting
+files with path information (with spaces included): it is more safe (and
+better to keep the overview) to use an own folder high in the drive
+hierarchy without spaces. (e.g. take something like d:\tomcat_60)
+1. Tomcat recommends the port 8080 for development needs: however if port 80
+is not used otherwise, you will have less trouble (e.g. related to firewall
+issues), when you use port 80 for your deployment.(Another reason for port
+80 is that browsers by default use port 80, for any other port setting the
+user needs to be aware of the fact, as he/she has to include this in the
+URL.)
+1. Your setup is successful, when you can reach afterwards the following
+page:
+
+{note:title=Be Careful}For all further examples I assume Tomcat to be
+installed in d:\tomcat_60.{note}
+
+<a name="WindowsVistaInstallationGuide-DeploymentoftheESMEApplication"></a>
+## Deployment of the ESME Application
+
+* You can either build the current version directly from the source code
+repository (SVN)or setup the application from existing (but outdated)
+binary packages.
+
+* Steps to deploy the current SVN version
+*# Make sure, that you have a working installation of the Apache Maven tool
+(at [http://maven.apache.org/](http://maven.apache.org/)
+). You can test this by issuing a "mvn --version" command on a command
+line.
+*# Get the source of the ESME application with any subv ersion
+(SVN)-compatilbe client: [Wikipedia](http://en.wikipedia.org/wiki/Comparison_of_Subversion_clients)
+ has a list with many clients and their features.
+*# Issue a "svn checkout http://svn.apache.org/repos/asf/incubator/esme"
+command (preferably in an own directory).
+*# Issue a "mvn install" in the directory, where you stored the SVN files.
+This creates a esme*.war file (most likely in the "target"-subdirectory).
+
+* Steps to implement the precompiled binary packages
+*# Download the binary files from Google code page (at [http://code.google.com/p/esmeproject/downloads/list](http://code.google.com/p/esmeproject/downloads/list)
+).
+*# You will see the following list:
+*For hosting an ESME pilot or for the testing, the last three files are
+needed: Download them with a right mouse click to a temporary folder on
+your computer.
+*# For deployment you need to the contents of the WAR-file and the two
+jar-files to the right locations. For this to work, you have to stop the
+Apache Tomcat service via the service console.
+*# Create a directory called esme under d:\tomcat_60\webapps.(I recommend
+not to take over the naming of the WAR file - with the complete date, as
+this requires the later user to remember also the ESME build date)-
+*# Extract the content of the WAR file to d:\tomcat_60\webapps\esme.
+*# Now take the the two other Jar-files from your download (lift*.jar and
+scala*.jar) and put them to d:\tomcat_60\webapps\esme\WEB-INF\lib.
+
+1. You are now ready to start the tomcat server (via the service console)
+and to see your application running.
+1. Open your browser, and enter the following link:
+http://localhost:8080/esme.
+
+Your setup was successful, when you can see a similar screen:
+From now on you can enter the ESME world and try out everything.
+
+<a name="WindowsVistaInstallationGuide-FurtheroptionsforESMEdeployment"></a>
+## Further options for ESME deployment
+As I also need to figure out further options for deployment, I just list my
+ideas here (knowing that these partly need further descriptions).
+* Enabling HTTPS-Encryption on Tomcat (-->
+http://tomcat.apache.org/tomcat-6.0-doc/ssl-howto.html) Even some intranets
+require this nowadays.
+
+
Modified: esme/site/trunk/content/index.mdtext
URL: http://svn.apache.org/viewvc/esme/site/trunk/content/index.mdtext?rev=1147473&r1=1147472&r2=1147473&view=diff
==============================================================================
--- esme/site/trunk/content/index.mdtext (original)
+++ esme/site/trunk/content/index.mdtext Sat Jul 16 18:29:10 2011
@@ -4,15 +4,11 @@ Welcome to Apache ESME (Enterprise Socia
You can hardly turn a web page these days without seeing a story that describes how people are using social networks, whether it is Twitter, Facebook or some other service to develop and build their personal communities.
-When solving problems, how good might it be if a user was able to tap into the collective knowledge of her peers or surrounding groups of people with whom she might naturally network in the workplace setting? How much quicker and with greater precision might she be able to solve daily problems? What if there was a communications mechanism that takes the best of what services like Twitter offers and co-mingled that with readily recognizable business processes? That solution is Apache ESME.
-
-The [Apache ESME blog](http://blogs.apache.org/esme/) has more details about ESME as well as project news.
+When solving problems, how useful might it be if a user was able to tap into the collective knowledge of her peers or surrounding groups of people with whom she might naturally network in the workplace setting? How much quicker and with greater precision might she be able to solve daily problems? What if there was a communications mechanism that takes the best of what services like Twitter offers and co-mingled that with readily recognizable business processes? That solution is Apache ESME.
## How to download ESME
-The current release is 1.2. [You can download it here](http://www.apache.org/dyn/closer.cgi?path=/esme) Here are the [changes for this release.](https://issues.apache.org/jira/secure/IssueNavigator.jspa?reset=true&jqlQuery=project+%3D+ESME+AND+fixVersion+%3D+%221.2%22+AND+status+%3D+Closed+ORDER+BY+priority+DESC&mode=hide)
-
-
+The current release is 1.2. You can download it [here](http://www.apache.org/dyn/closer.cgi?path=/esme) Here are the [changes for this release.](https://issues.apache.org/jira/secure/IssueNavigator.jspa?reset=true&jqlQuery=project+%3D+ESME+AND+fixVersion+%3D+%221.2%22+AND+status+%3D+Closed+ORDER+BY+priority+DESC&mode=hide)
## How to get involved
@@ -21,9 +17,6 @@ The dev mailing list is where the action
to the ESME developers mailing list by sending an
email to <code>dev-subscribe AT esme.apache.org</code> .
-We don't have a users mailing list at this time, we'll create it if traffic becomes too high on the dev list. User questions
-are welcome on the dev list for now.
-
Mailing list archives are available at [mail-archives.apache.org](http://mail-archives.apache.org/mod_mbox/),
[markmail.org](http://markmail.org/search/?q=list:org.apache.esme-*) and the other usual places.
Modified: esme/site/trunk/templates/sidenav.mdtext
URL: http://svn.apache.org/viewvc/esme/site/trunk/templates/sidenav.mdtext?rev=1147473&r1=1147472&r2=1147473&view=diff
==============================================================================
--- esme/site/trunk/templates/sidenav.mdtext (original)
+++ esme/site/trunk/templates/sidenav.mdtext Sat Jul 16 18:29:10 2011
@@ -6,6 +6,7 @@
- [Clients](/docs/clients/apache-esme-clients.html)
- [Actions](/actions.html)
- [FAQ](/faq.html)
+ - [Blog](http://blogs.apache.org/esme/)
# ASF links
- [Apache Software Foundation](http://www.apache.org)