Repository: james-project
Updated Branches:
  refs/heads/master eaf503e66 -> 6ed40404e


JAMES-2109 Consolidate install documentation for Guice


Project: http://git-wip-us.apache.org/repos/asf/james-project/repo
Commit: http://git-wip-us.apache.org/repos/asf/james-project/commit/3b63f45f
Tree: http://git-wip-us.apache.org/repos/asf/james-project/tree/3b63f45f
Diff: http://git-wip-us.apache.org/repos/asf/james-project/diff/3b63f45f

Branch: refs/heads/master
Commit: 3b63f45f3a3d5264089e4e788f05995a39301ca6
Parents: 8cb90d8
Author: benwa <btell...@linagora.com>
Authored: Fri Aug 4 11:11:19 2017 +0700
Committer: benwa <btell...@linagora.com>
Committed: Wed Aug 9 16:19:16 2017 +0700

----------------------------------------------------------------------
 .../container/guice/cassandra-guice/README.adoc | 56 ----------------
 .../container/guice/cassandra-guice/README.md   |  4 ++
 .../guice/cassandra-ldap-guice/README.md        |  4 ++
 server/container/guice/jpa-guice/README.adoc    | 44 -------------
 server/container/guice/jpa-guice/README.md      |  4 ++
 server/container/guice/jpa-smtp/README.adoc     | 40 ------------
 server/container/guice/jpa-smtp/README.md       |  4 ++
 .../markdown/server/install/guice-cassandra.md  | 68 ++++++++++++++++++++
 .../markdown/server/install/guice-jpa-smtp.md   | 37 +++++++++++
 src/site/markdown/server/install/guice-jpa.md   | 44 +++++++++++++
 src/site/site.xml                               |  7 +-
 src/site/xdoc/server/install.xml                |  4 ++
 src/site/xdoc/server/packaging.xml              |  8 +++
 13 files changed, 183 insertions(+), 141 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/james-project/blob/3b63f45f/server/container/guice/cassandra-guice/README.adoc
----------------------------------------------------------------------
diff --git a/server/container/guice/cassandra-guice/README.adoc 
b/server/container/guice/cassandra-guice/README.adoc
deleted file mode 100644
index f930b89..0000000
--- a/server/container/guice/cassandra-guice/README.adoc
+++ /dev/null
@@ -1,56 +0,0 @@
-= Guice-Cassandra Module How-to
-
-== Building
-
-=== Requirements
-
- * Java 8 SDK
- * Docker ∕ ElasticSearch 2.2.1 and Cassandra 2.2.3
- * Maven 3
-
-=== Building the artifacts
-
-An usual compilation using maven will produce two artifacts into target 
directory:
-
- * james-server-cassandra-guice.jar
- * james-server-cassandra-guice.lib
-
-You can for example run in the base of this git repository:
-
-```
-mvn clean install
-```
-
-== Running
-
-=== Requirements
-
- * Cassandra
- * ElasticSearch 1.5.2
-
-=== James Launch
-
-To run james, you have to create a directory containing required configuration 
files.
-
-James requires the configuration to be in a subfolder of working directory 
that is called **conf**. You can get a sample
-directory for configuration from 
dockerfiles/run/guice/cassandra/destination/conf. You might need to adapt it to 
your needs.
-
-You also need to generate a keystore in your conf folder with the following 
command:
-[source]
-----
-$ keytool -genkey -alias james -keyalg RSA -keystore conf/keystore
-----
-
-You need to have a Cassandra and an ElasticSearch instance running. You can 
either install the servers or launch them via docker:
-
-```bash
-$ docker run -d --port 9042:9042 --name=cassandra cassandra:2.2.3
-$ docker run -d --port 9200:9200 --port 9300:9300 --name=elasticsearch 
elasticsearch:2.2.1
-```
-
-Once everything is set up, you just have to run the jar with:
-
-[source]
-----
-$ java -Dworking.directory=. -jar target/james-server-cassandra-guice.jar
-----

http://git-wip-us.apache.org/repos/asf/james-project/blob/3b63f45f/server/container/guice/cassandra-guice/README.md
----------------------------------------------------------------------
diff --git a/server/container/guice/cassandra-guice/README.md 
b/server/container/guice/cassandra-guice/README.md
new file mode 100644
index 0000000..ca9b20c
--- /dev/null
+++ b/server/container/guice/cassandra-guice/README.md
@@ -0,0 +1,4 @@
+# Install James Cassandra-Guice
+
+Follow this 
[guide](https://james.apache.org/server/install/guice-cassandra.html) to 
install James Cassandra-guice 
+from command line.
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/james-project/blob/3b63f45f/server/container/guice/cassandra-ldap-guice/README.md
----------------------------------------------------------------------
diff --git a/server/container/guice/cassandra-ldap-guice/README.md 
b/server/container/guice/cassandra-ldap-guice/README.md
new file mode 100644
index 0000000..ca9b20c
--- /dev/null
+++ b/server/container/guice/cassandra-ldap-guice/README.md
@@ -0,0 +1,4 @@
+# Install James Cassandra-Guice
+
+Follow this 
[guide](https://james.apache.org/server/install/guice-cassandra.html) to 
install James Cassandra-guice 
+from command line.
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/james-project/blob/3b63f45f/server/container/guice/jpa-guice/README.adoc
----------------------------------------------------------------------
diff --git a/server/container/guice/jpa-guice/README.adoc 
b/server/container/guice/jpa-guice/README.adoc
deleted file mode 100644
index 4db218f..0000000
--- a/server/container/guice/jpa-guice/README.adoc
+++ /dev/null
@@ -1,44 +0,0 @@
-= Guice-JPA Module How-to
-
-== Building
-
-=== Requirements
-
- * Java 8 SDK
- * Docker
- * Maven 3
-
-=== Building the artifacts
-
-An usual compilation using maven will produce two artifacts into target 
directory:
-
- * james-server-jpa-guice.jar
- * james-server-jpa-guice.lib
-
-You can for example run in the base of this git repository:
-
-```
-mvn clean install
-```
-
-== Running
-
-=== James Launch
-
-To run james, you have to create a directory containing required configuration 
files.
-
-James requires the configuration to be in a subfolder of working directory 
that is called **conf**. You can get a sample
-directory for configuration from dockerfiles/run/guice/jpa/destination/conf. 
You might need to adapt it to your needs.
-
-You also need to generate a keystore in your conf folder with the following 
command:
-[source]
-----
-$ keytool -genkey -alias james -keyalg RSA -keystore conf/keystore
-----
-
-Once everything is set up, you just have to run the jar with:
-
-[source]
-----
-$ java -Dworking.directory=. -jar target/james-server-jpa-guice.jar
-----

http://git-wip-us.apache.org/repos/asf/james-project/blob/3b63f45f/server/container/guice/jpa-guice/README.md
----------------------------------------------------------------------
diff --git a/server/container/guice/jpa-guice/README.md 
b/server/container/guice/jpa-guice/README.md
new file mode 100644
index 0000000..708882c
--- /dev/null
+++ b/server/container/guice/jpa-guice/README.md
@@ -0,0 +1,4 @@
+# Install James JPA-Guice
+
+Follow this [guide](https://james.apache.org/server/install/guice-jpa.html) to 
install James JPA-guice
+from command line.
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/james-project/blob/3b63f45f/server/container/guice/jpa-smtp/README.adoc
----------------------------------------------------------------------
diff --git a/server/container/guice/jpa-smtp/README.adoc 
b/server/container/guice/jpa-smtp/README.adoc
deleted file mode 100644
index bedf715..0000000
--- a/server/container/guice/jpa-smtp/README.adoc
+++ /dev/null
@@ -1,40 +0,0 @@
-= Guice-JPA Module How-to
-
-== Building
-
-=== Requirements
-
- * Java 8 SDK
- * Docker
- * Maven
-
-=== Building the artifacts
-
-An usual compilation using maven will produce two artifacts into target 
directory :
-
- * james-server-jpa-smtp-${version}.jar
- * james-server-jpa-smtp-${version}.lib
-
-== Running
-
-=== Requirements
-
-=== James Launch
-
-To run james, you have to create a directory containing required configuration 
files.
-
-A sample directory (appropriately named sample-directory) is provided with some
-default value you may need to replace.
-
-You also need to generate a keystore with the following command :
-[source]
-----
-$ keytool -genkey -alias james -keyalg RSA -keystore conf/keystore
-----
-
-Once everything is set up, you just have to run the jar with :
-
-[source]
-----
-$ java -Dworking.directory=sample-configuration -jar 
target/james-server-jpa-smtp-${version}.jar
-----

http://git-wip-us.apache.org/repos/asf/james-project/blob/3b63f45f/server/container/guice/jpa-smtp/README.md
----------------------------------------------------------------------
diff --git a/server/container/guice/jpa-smtp/README.md 
b/server/container/guice/jpa-smtp/README.md
new file mode 100644
index 0000000..3d241d0
--- /dev/null
+++ b/server/container/guice/jpa-smtp/README.md
@@ -0,0 +1,4 @@
+# Install James JPA-Guice
+
+Follow this 
[guide](https://james.apache.org/server/install/guice-jpa-smtp.html) to install 
James JPA-SMTP-guice
+from command line.
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/james-project/blob/3b63f45f/src/site/markdown/server/install/guice-cassandra.md
----------------------------------------------------------------------
diff --git a/src/site/markdown/server/install/guice-cassandra.md 
b/src/site/markdown/server/install/guice-cassandra.md
new file mode 100644
index 0000000..3729d1f
--- /dev/null
+++ b/src/site/markdown/server/install/guice-cassandra.md
@@ -0,0 +1,68 @@
+# Guice-Cassandra installation guide
+
+## Building
+
+### Requirements
+
+ - Java 8 SDK
+ - Docker ∕ ElasticSearch 2.2.1 and Cassandra 2.2.3
+ - Maven 3
+
+### Building the artifacts
+
+An usual compilation using maven will produce two artifacts into 
server/container/guice/cassandra-guice/target directory:
+
+ * james-server-cassandra-guice.jar
+ * james-server-cassandra-guice.lib
+
+You can for example run in the base of [this git 
repository](https://github.com/apache/james-project):
+
+```
+mvn clean install
+```
+
+## Running
+
+### Requirements
+
+ * Cassandra
+ * ElasticSearch 1.5.2
+
+### James Launch
+
+To run james, you have to create a directory containing required configuration 
files.
+
+James requires the configuration to be in a subfolder of working directory 
that is called **conf**. You can get a sample
+directory for configuration from
+[dockerfiles/run/guice/cassandra/destination/conf](https://github.com/apache/james-project/tree/master/dockerfiles/run/guice/cassandra/destination/conf).
 You might need to adapt it to your needs.
+
+You also need to generate a keystore in your conf folder with the following 
command:
+
+```bash
+$ keytool -genkey -alias james -keyalg RSA -keystore conf/keystore
+```
+
+You need to have a Cassandra and an ElasticSearch instance running. You can 
either install the servers or launch them via docker:
+
+```bash
+$ docker run -d --port 9042:9042 --name=cassandra cassandra:2.2.3
+$ docker run -d --port 9200:9200 --port 9300:9300 --name=elasticsearch 
elasticsearch:2.2.1
+```
+
+Once everything is set up, you just have to run the jar with:
+
+```bash
+$ java -Dworking.directory=. -jar target/james-server-cassandra-guice.jar
+```
+
+## Guice-cassandra-ldap
+
+You can follow the same guide to build and run guice-cassandra-ldap artifact, 
except that:
+ - The **jar** and **libs** needs to be retrieve from 
server/container/guice/cassandra-ldap-guice/target after compilation
+ - The sample configuration can be found in 
[dockerfiles/run/guice/cassandra-ldap/destination/conf](https://github.com/apache/james-project/tree/master/dockerfiles/run/guice/cassandra-ldap/destination/conf)
+ - You need a running LDAP server to connect to.
+ - You can then launch James via this command:
+
+```bash
+$ java -Dworking.directory=. -jar target/james-server-cassandra-ldap-guice.jar
+```
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/james-project/blob/3b63f45f/src/site/markdown/server/install/guice-jpa-smtp.md
----------------------------------------------------------------------
diff --git a/src/site/markdown/server/install/guice-jpa-smtp.md 
b/src/site/markdown/server/install/guice-jpa-smtp.md
new file mode 100644
index 0000000..e2b28ad
--- /dev/null
+++ b/src/site/markdown/server/install/guice-jpa-smtp.md
@@ -0,0 +1,37 @@
+# Guice-JPA-SMTP installation guide
+
+## Building
+
+### Requirements
+
+ - Java 8 SDK
+ - Docker
+ - Maven
+
+### Building the artifacts
+
+An usual compilation using maven of this [Git repository 
content](https://github.com/apache/james-project) will produce
+two artifacts into server/container/guice/jpa-smtp/target directory :
+
+ - james-server-jpa-smtp-${version}.jar
+ - james-server-jpa-smtp-${version}.lib
+
+## Running
+
+### James Launch
+
+To run james, you have to create a directory containing required configuration 
files.
+
+A [sample 
directory](https://github.com/apache/james-project/tree/master/server/container/guice/jpa-smtp/sample-configuration)
 is provided with some default value you may need to replace.
+
+You also need to generate a keystore with the following command :
+
+```bash
+$ keytool -genkey -alias james -keyalg RSA -keystore conf/keystore
+```
+
+Once everything is set up, you just have to run the jar with :
+
+```bash
+$ java -Dworking.directory=sample-configuration -jar 
target/james-server-jpa-smtp-${version}.jar
+```
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/james-project/blob/3b63f45f/src/site/markdown/server/install/guice-jpa.md
----------------------------------------------------------------------
diff --git a/src/site/markdown/server/install/guice-jpa.md 
b/src/site/markdown/server/install/guice-jpa.md
new file mode 100644
index 0000000..b8e7587
--- /dev/null
+++ b/src/site/markdown/server/install/guice-jpa.md
@@ -0,0 +1,44 @@
+# Guice-JPA installation guide
+
+## Building
+
+### Requirements
+
+ - Java 8 SDK
+ - Docker
+ - Maven 3
+
+### Building the artifacts
+
+An usual compilation using maven of this [Git repository 
content](https://github.com/apache/james-project) will produce
+two artifacts into server/container/guice/jpa-guice/target directory:
+
+ - james-server-jpa-guice.jar
+ - james-server-jpa-guice.lib
+
+You can for example run in the base of this git repository:
+
+```
+mvn clean install
+```
+
+## Running
+
+### James Launch
+
+To run james, you have to create a directory containing required configuration 
files.
+
+James requires the configuration to be in a subfolder of working directory 
that is called **conf**. You can get a sample
+directory for configuration from 
[dockerfiles/run/guice/jpa/destination/conf](https://github.com/apache/james-project/tree/master/dockerfiles/run/guice/jpa/destination/conf).
 You might need to adapt it to your needs.
+
+You also need to generate a keystore in your conf folder with the following 
command:
+
+```bash
+$ keytool -genkey -alias james -keyalg RSA -keystore conf/keystore
+```
+
+Once everything is set up, you just have to run the jar with:
+
+```bash
+$ java -Dworking.directory=. -jar target/james-server-jpa-guice.jar
+```

http://git-wip-us.apache.org/repos/asf/james-project/blob/3b63f45f/src/site/site.xml
----------------------------------------------------------------------
diff --git a/src/site/site.xml b/src/site/site.xml
index 32c5ae0..1d62152 100644
--- a/src/site/site.xml
+++ b/src/site/site.xml
@@ -114,7 +114,12 @@
                         <item name="Security" 
href="/server/feature-security.html" />
                     </item>
                     <item name="2. Packaging" href="/server/packaging.html" />
-                    <item name="3. Install James" href="/server/install.html" 
/>
+                    <item name="3. Install James" href="/server/install.html" >
+                        <item name="Cassandra-guice" 
href="/server/install/guice-cassandra.html" />
+                        <item name="JPA-guice" 
href="/server/install/guice-jpa.html" />
+                        <item name="JPA-SMTP-guice" 
href="/server/install/guice-jpa-smtp.html" />
+
+                    </item>
                     <item name="4. Configure James" href="/server/config.html" 
collapse="true" >
                         <item name="System" href="/server/config-system.html" 
/>
                         <item name="Domain List" 
href="/server/config-domainlist.html" />

http://git-wip-us.apache.org/repos/asf/james-project/blob/3b63f45f/src/site/xdoc/server/install.xml
----------------------------------------------------------------------
diff --git a/src/site/xdoc/server/install.xml b/src/site/xdoc/server/install.xml
index c0de159..0edb131 100644
--- a/src/site/xdoc/server/install.xml
+++ b/src/site/xdoc/server/install.xml
@@ -90,6 +90,10 @@
       <p>Alternatively, if you don't want your build to be handled via Docker, 
you can follow <a href="quick-start-cassandra.html">
           Guice Cassandra quick-start</a> </p>
 
+      <p>Note that install instructions from command line are available for <a 
href="install/cassandra-guice.html">Cassandra-Guice</a>,
+          <a href="install/jpa-guice.html">JPA-Guice</a> and <a 
href="install/jpa-smtp-guice.html">JPA-SMTP-Guice</a>.
+      </p>
+
       <p>A <a 
href="https://github.com/apache/james-project/blob/9502cfebfd9a4eaebbba7dda802d1fe0ad3589b7/dockerfiles/run/docker-compose.yml";>
           docker-compose</a> is available for Guice + Cassandra + 
ElasticSearch</p>
   </section>

http://git-wip-us.apache.org/repos/asf/james-project/blob/3b63f45f/src/site/xdoc/server/packaging.xml
----------------------------------------------------------------------
diff --git a/src/site/xdoc/server/packaging.xml 
b/src/site/xdoc/server/packaging.xml
index fffa283..ac25549 100644
--- a/src/site/xdoc/server/packaging.xml
+++ b/src/site/xdoc/server/packaging.xml
@@ -193,6 +193,14 @@
                         <td>Experimental</td>
                         <td>No</td>
                     </tr>
+                    <tr>
+                        <td>Installation instructions</td>
+                        <td><a href="install.html">Here</a></td>
+                        <td><a 
href="install/guice-cassandra.html">Here</a></td>
+                        <td><a 
href="install/guice-cassandra.html">Here</a></td>
+                        <td><a href="install/guice-jpa.html">Here</a></td>
+                        <td><a href="install/guice-jpa-smtp.html">Here</a></td>
+                    </tr>
                 </table>
             </p>
         </section>


---------------------------------------------------------------------
To unsubscribe, e-mail: server-dev-unsubscr...@james.apache.org
For additional commands, e-mail: server-dev-h...@james.apache.org

Reply via email to