You are viewing a plain text version of this content. The canonical link for it is here.
Posted to server-dev@james.apache.org by bt...@apache.org on 2018/11/15 13:11:51 UTC
[2/5] james-project git commit: JAMES-2593 update documentations
JAMES-2593 update documentations
Project: http://git-wip-us.apache.org/repos/asf/james-project/repo
Commit: http://git-wip-us.apache.org/repos/asf/james-project/commit/d524f960
Tree: http://git-wip-us.apache.org/repos/asf/james-project/tree/d524f960
Diff: http://git-wip-us.apache.org/repos/asf/james-project/diff/d524f960
Branch: refs/heads/master
Commit: d524f9608fd73f89072884c3407fdcf2ae0b2234
Parents: 6b41eef
Author: tran tien duc <dt...@linagora.com>
Authored: Mon Nov 12 17:00:36 2018 +0700
Committer: Benoit Tellier <bt...@linagora.com>
Committed: Thu Nov 15 20:10:34 2018 +0700
----------------------------------------------------------------------
README.adoc | 12 ++--
.../install/guice-cassandra-rabbitmq-swift.md | 62 ++++++++++++++++++++
.../server/install/guice-cassandra-rabbitmq.md | 60 -------------------
src/site/site.xml | 2 +-
4 files changed, 71 insertions(+), 65 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/james-project/blob/d524f960/README.adoc
----------------------------------------------------------------------
diff --git a/README.adoc b/README.adoc
index 679050f..5e70d41 100644
--- a/README.adoc
+++ b/README.adoc
@@ -44,7 +44,7 @@ There is many other ways one can help us: packaging, communication, etc ...
* https://github.com/apache/james-project/#how-to-release-via-maven-release-plugin[How to release via maven release plugin]
* https://github.com/apache/james-project/#how-to-check-the-compilation[How to check the compilation]
* https://github.com/apache/james-project/#how-to-run-james-in-docker[How to run James in Docker]
- ** https://github.com/apache/james-project/#run-james-with-java-8--guice--cassandra-rabbitmq-elasticsearch[Run James with Java 8 + Guice + Cassandra + RabbitMQ + ElasticSearch]
+ ** https://github.com/apache/james-project/#run-james-with-java-8--guice--cassandra-rabbitmq-swift-elasticsearch[Run James with Java 8 + Guice + Cassandra + RabbitMQ + Swift + ElasticSearch]
** https://github.com/apache/james-project/#run-james-with-java-8--guice--cassandra--elasticsearch[Run James with Java 8 + Guice + Cassandra + ElasticSearch]
** https://github.com/apache/james-project/#run-james-with-java-8--guice--jpa--lucene[Run James with Java 8 + Guice + JPA + Lucene]
** https://github.com/apache/james-project/#run-james-with-java-8--spring--jpa[Run James with Java 8 + Spring + JPA]
@@ -195,13 +195,13 @@ If you are using a a fresh installation of Docker, your DOCKER_HOST should be un
This feature is available for three configurations :
- * Java 8 + Guice + Cassandra + RabbitMQ + ElasticSearch
+ * Java 8 + Guice + Cassandra + RabbitMQ + Swift + ElasticSearch
* Java 8 + Guice + Cassandra + ElasticSearch
* Java 8 + Guice + JPA + Lucene
* Java 8 + Spring + JPA
-=== Run James with Java 8 + Guice + Cassandra + RabbitMQ + ElasticSearch
+=== Run James with Java 8 + Guice + Cassandra + RabbitMQ + Swift + ElasticSearch
==== Requirements
@@ -223,6 +223,10 @@ You need a running *rabbitmq* in docker. To achieve this run:
$ docker run -d --name=rabbitmq rabbitmq:3.7.7-management
+You need a running *swift* objectstorage in docker. To achieve this run:
+
+ $ docker run -d --name=swift jeantil/openstack-keystone-swift:pike
+
You need a running *ElasticSearch* in docker. To achieve this run:
$ docker run -d --name=elasticsearch elasticsearch:2.4.6
@@ -246,7 +250,7 @@ Then we need to build james container :
To run this container :
$ docker run --hostname HOSTNAME -p "25:25" -p 80:80 -p "110:110" -p "143:143" -p "465:465" -p "587:587" -p "993:993" --link cassandra:cassandra --link rabbitmq:rabbitmq
- --link elasticsearch:elasticsearch --link tika:tika --name james_run -t james_run
+ --link elasticsearch:elasticsearch --link tika:tika --link swift:swift --name james_run -t james_run
Where :
http://git-wip-us.apache.org/repos/asf/james-project/blob/d524f960/src/site/markdown/server/install/guice-cassandra-rabbitmq-swift.md
----------------------------------------------------------------------
diff --git a/src/site/markdown/server/install/guice-cassandra-rabbitmq-swift.md b/src/site/markdown/server/install/guice-cassandra-rabbitmq-swift.md
new file mode 100644
index 0000000..99b2d8f
--- /dev/null
+++ b/src/site/markdown/server/install/guice-cassandra-rabbitmq-swift.md
@@ -0,0 +1,62 @@
+# Guice-Cassandra-Rabbitmq-Swift installation guide
+
+## Building
+
+### Requirements
+
+ - Java 8 SDK
+ - Docker ∕ ElasticSearch 2.4.6, RabbitMQ Management 3.3.7, Swift ObjectStorage and Cassandra 3.11.3
+ - Maven 3
+
+### Building the artifacts
+
+An usual compilation using maven will produce two artifacts into server/container/guice/cassandra-rabbitmq-guice/target directory:
+
+ * james-server-cassandra-rabbitmq-guice.jar
+ * james-server-cassandra-rabbitmq-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 3.11.3
+ * ElasticSearch 2.4.6
+ * RabbitMQ-Management 3.7.7
+ * Swift ObjectStorage
+### 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-rabbitmq/destination/conf](https://github.com/apache/james-project/tree/master/dockerfiles/run/guice/cassandra-rabbitmq/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, ElasticSearch and RabbitMQ instance running. You can either install the servers or launch them via docker:
+
+```bash
+$ docker run -d --port 9042:9042 --name=cassandra cassandra:3.11.3
+$ docker run -d --port 9200:9200 --port 9300:9300 --name=elasticsearch elasticsearch:2.4.6
+$ docker run -d --port 5672:5672 --port 15672:15672 --name=rabbitmq rabbitmq:3.7.7-management
+$ docker run -d --port 5000:5000 --port 8080:8080 --port 35357:35357 --name=swift jeantil/openstack-keystone-swift:pike
+```
+
+Once everything is set up, you just have to run the jar with:
+
+```bash
+$ java -Dworking.directory=. -jar target/james-server-cassandra-rabbitmq-guice.jar
+```
+
+## Guice-cassandra-rabbitmq-ldap
+### Note: this product is not supported yet
http://git-wip-us.apache.org/repos/asf/james-project/blob/d524f960/src/site/markdown/server/install/guice-cassandra-rabbitmq.md
----------------------------------------------------------------------
diff --git a/src/site/markdown/server/install/guice-cassandra-rabbitmq.md b/src/site/markdown/server/install/guice-cassandra-rabbitmq.md
deleted file mode 100644
index 78fe687..0000000
--- a/src/site/markdown/server/install/guice-cassandra-rabbitmq.md
+++ /dev/null
@@ -1,60 +0,0 @@
-# Guice-Cassandra-Rabbitmq installation guide
-
-## Building
-
-### Requirements
-
- - Java 8 SDK
- - Docker ∕ ElasticSearch 2.4.6 and Cassandra 3.11.3
- - Maven 3
-
-### Building the artifacts
-
-An usual compilation using maven will produce two artifacts into server/container/guice/cassandra-rabbitmq-guice/target directory:
-
- * james-server-cassandra-rabbitmq-guice.jar
- * james-server-cassandra-rabbitmq-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 3.11.3
- * ElasticSearch 2.4.6
- * RabbitMQ-Management 3.7.7
-### 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-rabbitmq/destination/conf](https://github.com/apache/james-project/tree/master/dockerfiles/run/guice/cassandra-rabbitmq/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, ElasticSearch and RabbitMQ instance running. You can either install the servers or launch them via docker:
-
-```bash
-$ docker run -d --port 9042:9042 --name=cassandra cassandra:3.11.3
-$ docker run -d --port 9200:9200 --port 9300:9300 --name=elasticsearch elasticsearch:2.4.6
-$ docker run -d --port 5672:5672 --port 15672:15672 --name=rabbitmq rabbitmq:3.7.7-management
-```
-
-Once everything is set up, you just have to run the jar with:
-
-```bash
-$ java -Dworking.directory=. -jar target/james-server-cassandra-rabbitmq-guice.jar
-```
-
-## Guice-cassandra-rabbitmq-ldap
-### Note: this product is not supported yet
http://git-wip-us.apache.org/repos/asf/james-project/blob/d524f960/src/site/site.xml
----------------------------------------------------------------------
diff --git a/src/site/site.xml b/src/site/site.xml
index fe99462..2ed8d54 100644
--- a/src/site/site.xml
+++ b/src/site/site.xml
@@ -107,7 +107,7 @@
</item>
<item name="2. Packaging" href="/server/packaging.html" />
<item name="3. Install James" href="/server/install.html" collapse="true">
- <item name="Cassandra-RabbitMQ-guice" href="/server/install/guice-cassandra-rabbitmq.html" />
+ <item name="Cassandra-RabbitMQ-Swift-guice" href="/server/install/guice-cassandra-rabbitmq.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" />
---------------------------------------------------------------------
To unsubscribe, e-mail: server-dev-unsubscribe@james.apache.org
For additional commands, e-mail: server-dev-help@james.apache.org