You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@syncope.apache.org by ma...@apache.org on 2015/12/16 14:14:13 UTC
syncope git commit: removed old images and added common directory,
SYNCOPE-700
Repository: syncope
Updated Branches:
refs/heads/master 73b9f6d67 -> 2a9f92e61
removed old images and added common directory, SYNCOPE-700
Project: http://git-wip-us.apache.org/repos/asf/syncope/repo
Commit: http://git-wip-us.apache.org/repos/asf/syncope/commit/2a9f92e6
Tree: http://git-wip-us.apache.org/repos/asf/syncope/tree/2a9f92e6
Diff: http://git-wip-us.apache.org/repos/asf/syncope/diff/2a9f92e6
Branch: refs/heads/master
Commit: 2a9f92e614c044222d84e59b9380b557a2f57dd5
Parents: 73b9f6d
Author: Massimiliano Perrone <ma...@tirasa.net>
Authored: Wed Dec 16 14:13:52 2015 +0100
Committer: Massimiliano Perrone <ma...@tirasa.net>
Committed: Wed Dec 16 14:13:52 2015 +0100
----------------------------------------------------------------------
src/main/asciidoc/commondocs/guiinstaller.adoc | 129 +++++++++++++++++++
src/main/asciidoc/images/installer1.png | Bin 160690 -> 0 bytes
src/main/asciidoc/images/installer10.png | Bin 45440 -> 0 bytes
src/main/asciidoc/images/installer2.png | Bin 53017 -> 0 bytes
src/main/asciidoc/images/installer3.png | Bin 46889 -> 0 bytes
src/main/asciidoc/images/installer4.png | Bin 38073 -> 0 bytes
src/main/asciidoc/images/installer5.png | Bin 48416 -> 0 bytes
src/main/asciidoc/images/installer6.png | Bin 39613 -> 0 bytes
src/main/asciidoc/images/installer7.png | Bin 40130 -> 0 bytes
src/main/asciidoc/images/installer8.png | Bin 41467 -> 0 bytes
src/main/asciidoc/images/installer9.png | Bin 42059 -> 0 bytes
src/main/asciidoc/obtain.adoc | 74 +----------
.../installation/installation.adoc | 9 +-
.../installation/installer.adoc | 120 -----------------
.../workingwithapachesyncope.adoc | 9 +-
15 files changed, 139 insertions(+), 202 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/syncope/blob/2a9f92e6/src/main/asciidoc/commondocs/guiinstaller.adoc
----------------------------------------------------------------------
diff --git a/src/main/asciidoc/commondocs/guiinstaller.adoc b/src/main/asciidoc/commondocs/guiinstaller.adoc
new file mode 100644
index 0000000..168be1f
--- /dev/null
+++ b/src/main/asciidoc/commondocs/guiinstaller.adoc
@@ -0,0 +1,129 @@
+//
+// Licensed to the Apache Software Foundation (ASF) under one
+// or more contributor license agreements. See the NOTICE file
+// distributed with this work for additional information
+// regarding copyright ownership. The ASF licenses this file
+// to you under the Apache License, Version 2.0 (the
+// "License"); you may not use this file except in compliance
+// with the License. You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing,
+// software distributed under the License is distributed on an
+// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+// KIND, either express or implied. See the License for the
+// specific language governing permissions and limitations
+// under the License.
+//
+=== GUI Installer
+
+GUI application for configuring and deploying Apache Syncope on supported
+<<internal-storage,DBMSes>> and <<java-ee-container, Java EE containers>>.
+
+[CAUTION]
+.Target Audience
+Getting up and running quickly on any supported DBMS and Java EE container, independently from the underlying
+operating system. +
+*Difficult to extend beyond pre-sets.*
+
+==== Prerequisites
+
+ . http://maven.apache.org/[Apache Maven^] (version 3.0.3 or higher) installed
+ . one of the supported <<internal-storage,DBMSes>> up and running
+ . one of the supported <<java-ee-container, Java EE containers>> up and running
+ . A datasource with the name `syncopeDataSource` configured in the selected Java EE container, for a database instance in the
+ DBMS of choice
+
+[WARNING]
+====
+When deploying on Apache Tomcat, don't forget to configure a `manager` user; if not done yet, ensure that the content
+of `$CATALINA_HOME/conf/tomcat-users.xml` looks like:
+
+[source,xml]
+<?xml version='1.0' encoding='utf-8'?>
+<tomcat-users>
+ <role rolename="manager-gui"/>
+ <role rolename="manager-script"/>
+ <role rolename="manager-jmx"/>
+ <role rolename="manager-status"/>
+ <user username="manager" password="s3cret" roles="manager-script"/>
+</tomcat-users>
+====
+
+==== Usage
+
+Once http://syncope.apache.org/downloads.html[downloaded^], double-click the JAR file or execute via the command-line:
+
+[source,bash]
+java -jar syncope-installer-*-uber.jar
+
+image::installer-1.png[installer-1]
+
+image::installer-2.png[installer-2]
+
+image::installer-3.png[installer-3]
+
+image::installer-4.png[installer-4]
+
+Installation path::
+* installation path: is the directory where Syncope overlay will be created
+
+image::installer-5.png[installer-5]
+
+Maven::
+* *Maven home directory:* is the Maven home directory;
+* *Group ID:* something like 'com.mycompany' - maven overlay property;
+* *Artifact ID:* something like 'myproject' - maven overlay property;
+* *Secret Key:* Provide any pseudo-random, 16 character length, string here that will be used in the generated project for AES ciphering;
+* *Anonimous Key:* - Provide any pseudo-random, 16 character length, string here that will be used in the generated project for AES ciphering;
+* *Configuration directory:* where Syncope configuration files are stored;
+* *Log directory:* where Syncope logs are stored;
+* *Bundle directory:* where ConnId bundles are stored;
+* *Syncope version:* the project version that would be to install.
+
+image::installer-6.png[installer-6]
+
+Syncope options::
+* *Swagger:* check if you want to install Swagger UI;
+* *Camel:* check if you want to install Camel provisioning;
+* *Activiti workflow modeler:* check if you want to install Activiti modeler (default is true);
+
+image::installer-7.png[installer-7]
+
+Database::
+* DBMS where Syncope will be installed;
+
+image::installer-8.png[installer-8]
+
+Database settings::
+* Depends on DBMS selected (in the example: PostgreSQL)
+** Database JDBS url;
+** Database user;
+** Database password;
+
+image::installer-9.png[installer-9]
+
+Application server::
+* Container where Syncope will be deployed;
+
+image::installer-10.png[installer-10]
+
+Application server settings::
+* Depends on container selected (in the example: Tomcat)
+
+The next images shows how the installer print some feedback directly on the GUI or reading the log file under the
+configuration directory:
+
+[source]
+--
+/var/tmp/syncope_2_0_0/install.log
+--
+
+image::installer-11.png[installer-11]
+
+image::installer-12.png[installer-12]
+
+image::installer-13.png[installer-13]
+
+image::installer-14.png[installer-14]
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/syncope/blob/2a9f92e6/src/main/asciidoc/images/installer1.png
----------------------------------------------------------------------
diff --git a/src/main/asciidoc/images/installer1.png b/src/main/asciidoc/images/installer1.png
deleted file mode 100644
index 271e40d..0000000
Binary files a/src/main/asciidoc/images/installer1.png and /dev/null differ
http://git-wip-us.apache.org/repos/asf/syncope/blob/2a9f92e6/src/main/asciidoc/images/installer10.png
----------------------------------------------------------------------
diff --git a/src/main/asciidoc/images/installer10.png b/src/main/asciidoc/images/installer10.png
deleted file mode 100644
index 1e48504..0000000
Binary files a/src/main/asciidoc/images/installer10.png and /dev/null differ
http://git-wip-us.apache.org/repos/asf/syncope/blob/2a9f92e6/src/main/asciidoc/images/installer2.png
----------------------------------------------------------------------
diff --git a/src/main/asciidoc/images/installer2.png b/src/main/asciidoc/images/installer2.png
deleted file mode 100644
index f8498a6..0000000
Binary files a/src/main/asciidoc/images/installer2.png and /dev/null differ
http://git-wip-us.apache.org/repos/asf/syncope/blob/2a9f92e6/src/main/asciidoc/images/installer3.png
----------------------------------------------------------------------
diff --git a/src/main/asciidoc/images/installer3.png b/src/main/asciidoc/images/installer3.png
deleted file mode 100644
index b7e52aa..0000000
Binary files a/src/main/asciidoc/images/installer3.png and /dev/null differ
http://git-wip-us.apache.org/repos/asf/syncope/blob/2a9f92e6/src/main/asciidoc/images/installer4.png
----------------------------------------------------------------------
diff --git a/src/main/asciidoc/images/installer4.png b/src/main/asciidoc/images/installer4.png
deleted file mode 100644
index 341e2e0..0000000
Binary files a/src/main/asciidoc/images/installer4.png and /dev/null differ
http://git-wip-us.apache.org/repos/asf/syncope/blob/2a9f92e6/src/main/asciidoc/images/installer5.png
----------------------------------------------------------------------
diff --git a/src/main/asciidoc/images/installer5.png b/src/main/asciidoc/images/installer5.png
deleted file mode 100644
index 0151666..0000000
Binary files a/src/main/asciidoc/images/installer5.png and /dev/null differ
http://git-wip-us.apache.org/repos/asf/syncope/blob/2a9f92e6/src/main/asciidoc/images/installer6.png
----------------------------------------------------------------------
diff --git a/src/main/asciidoc/images/installer6.png b/src/main/asciidoc/images/installer6.png
deleted file mode 100644
index 4c50a22..0000000
Binary files a/src/main/asciidoc/images/installer6.png and /dev/null differ
http://git-wip-us.apache.org/repos/asf/syncope/blob/2a9f92e6/src/main/asciidoc/images/installer7.png
----------------------------------------------------------------------
diff --git a/src/main/asciidoc/images/installer7.png b/src/main/asciidoc/images/installer7.png
deleted file mode 100644
index c2d135e..0000000
Binary files a/src/main/asciidoc/images/installer7.png and /dev/null differ
http://git-wip-us.apache.org/repos/asf/syncope/blob/2a9f92e6/src/main/asciidoc/images/installer8.png
----------------------------------------------------------------------
diff --git a/src/main/asciidoc/images/installer8.png b/src/main/asciidoc/images/installer8.png
deleted file mode 100644
index 006fa3f..0000000
Binary files a/src/main/asciidoc/images/installer8.png and /dev/null differ
http://git-wip-us.apache.org/repos/asf/syncope/blob/2a9f92e6/src/main/asciidoc/images/installer9.png
----------------------------------------------------------------------
diff --git a/src/main/asciidoc/images/installer9.png b/src/main/asciidoc/images/installer9.png
deleted file mode 100644
index cea0f0c..0000000
Binary files a/src/main/asciidoc/images/installer9.png and /dev/null differ
http://git-wip-us.apache.org/repos/asf/syncope/blob/2a9f92e6/src/main/asciidoc/obtain.adoc
----------------------------------------------------------------------
diff --git a/src/main/asciidoc/obtain.adoc b/src/main/asciidoc/obtain.adoc
index 6dfffcd..23357dd 100644
--- a/src/main/asciidoc/obtain.adoc
+++ b/src/main/asciidoc/obtain.adoc
@@ -155,79 +155,7 @@ Credentials: `admin` / `password`
|===
-=== GUI Installer
-
-GUI application for configuring and deploying Apache Syncope on supported
-<<internal-storage,DBMSes>> and <<java-ee-container, Java EE containers>>.
-
-[CAUTION]
-.Target Audience
-Getting up and running quickly on any supported DBMS and Java EE container, independently from the underlying
-operating system. +
-*Difficult to extend beyond pre-sets.*
-
-==== Prerequisites
-
- . http://maven.apache.org/[Apache Maven^] (version 3.0.3 or higher) installed
- . one of the supported <<internal-storage,DBMSes>> up and running
- . one of the supported <<java-ee-container, Java EE containers>> up and running
- . A datasource with the name `syncopeDataSource` configured in the selected Java EE container, for a database instance in the
- DBMS of choice
-
-[WARNING]
-====
-When deploying on Apache Tomcat, don't forget to configure a `manager` user; if not done yet, ensure that the content
-of `$CATALINA_HOME/conf/tomcat-users.xml` looks like:
-
-[source,xml]
-<?xml version='1.0' encoding='utf-8'?>
-<tomcat-users>
- <role rolename="manager-gui"/>
- <role rolename="manager-script"/>
- <role rolename="manager-jmx"/>
- <role rolename="manager-status"/>
- <user username="manager" password="s3cret" roles="manager-script"/>
-</tomcat-users>
-====
-
-==== Usage
-
-Once http://syncope.apache.org/downloads.html[downloaded^], double-click the JAR file or execute via the command-line:
-
-[source,bash]
-java -jar syncope-installer-*-uber.jar
-
-image:installer1.png[width="500",role="thumb",link="images/installer1.png"]
-
-image:installer2.png[width="500",role="thumb",link="images/installer2.png"]
-
-image:installer3.png[width="500",role="thumb",link="images/installer3.png"]
-
-image:installer4.png[width="500",role="thumb",link="images/installer4.png"]
-
-Installation path:: working directory where the Apache Syncope project will be created and built
-
-image:installer5.png[width="500",role="thumb",link="images/installer5.png"]
-
-Maven home directory:: directory where Apache Maven is installed
-GroupId:: something like 'com.mycompany'
-ArtifactId:: something like 'mySyncopeProject'
-Secret Key:: provide any pseudo-random string here that will be used in the generated project for AES ciphering
-Anonymous Key:: provide any pseudo-random string here that will be used as an authentication key for anonymous requests
-Configuration directory:: directory for configuration files
-Log directory:: directory for log files
-Bundle directory:: directory where ConnId bundles are put
-Syncope version:: Apache Syncope version selected for installation
-
-image:installer6.png[width="500",role="thumb",link="images/installer6.png"]
-
-image:installer7.png[width="500",role="thumb",link="images/installer7.png"]
-
-image:installer8.png[width="500",role="thumb",link="images/installer8.png"]
-
-image:installer9.png[width="500",role="thumb",link="images/installer9.png"]
-
-image:installer10.png[width="500",role="thumb",link="images/installer10.png"]
+include::commondocs/guiinstaller.adoc[]
==== Components
http://git-wip-us.apache.org/repos/asf/syncope/blob/2a9f92e6/src/main/asciidoc/workingwithapachesyncope/installation/installation.adoc
----------------------------------------------------------------------
diff --git a/src/main/asciidoc/workingwithapachesyncope/installation/installation.adoc b/src/main/asciidoc/workingwithapachesyncope/installation/installation.adoc
index 06f419f..f7ff705 100644
--- a/src/main/asciidoc/workingwithapachesyncope/installation/installation.adoc
+++ b/src/main/asciidoc/workingwithapachesyncope/installation/installation.adoc
@@ -16,15 +16,8 @@
// specific language governing permissions and limitations
// under the License.
//
-=== Installation
-There are many ways to install the Apache Syncope components
-
-* from Maven command line;
-* from the Installer;
-* from the .deb packages.
+include::../../commondocs/guiinstaller.adoc[]
include::maven.adoc[]
-include::installer.adoc[]
-
include::deb.adoc[]
http://git-wip-us.apache.org/repos/asf/syncope/blob/2a9f92e6/src/main/asciidoc/workingwithapachesyncope/installation/installer.adoc
----------------------------------------------------------------------
diff --git a/src/main/asciidoc/workingwithapachesyncope/installation/installer.adoc b/src/main/asciidoc/workingwithapachesyncope/installation/installer.adoc
deleted file mode 100644
index f626cc3..0000000
--- a/src/main/asciidoc/workingwithapachesyncope/installation/installer.adoc
+++ /dev/null
@@ -1,120 +0,0 @@
-//
-// Licensed to the Apache Software Foundation (ASF) under one
-// or more contributor license agreements. See the NOTICE file
-// distributed with this work for additional information
-// regarding copyright ownership. The ASF licenses this file
-// to you under the Apache License, Version 2.0 (the
-// "License"); you may not use this file except in compliance
-// with the License. You may obtain a copy of the License at
-//
-// http://www.apache.org/licenses/LICENSE-2.0
-//
-// Unless required by applicable law or agreed to in writing,
-// software distributed under the License is distributed on an
-// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
-// KIND, either express or implied. See the License for the
-// specific language governing permissions and limitations
-// under the License.
-//
-==== Installer
-Starting from Apache Syncope 1.2.0 an installer package is http://syncope.apache.org/downloads.html[available],
-its purpose is to download, configure and deploy a Syncope instance in one of the supported servers.
-
-===== Prerequisites
-
-* http://maven.apache.org/[Apache Maven] (version 3.0.3 or higher) installed
-* Configure data source in your application server
-* Supported container up and running
-* Supported DBMS up and running
-
-===== Running
-Just double-click the downloaded JAR file or execute via CLI:
-[source]
---
-$ java -jar syncope-installer-*-uber.jar
---
-
-===== Installation step by step
-image::installer-1.png[installer-1]
-
-image::installer-2.png[installer-2]
-
-image::installer-3.png[installer-3]
-
-image::installer-4.png[installer-4]
-
-Installation path::
-* installation path: is the directory where Syncope overlay will be created
-
-image::installer-5.png[installer-5]
-
-Maven::
-* *Maven home directory:* is the Maven home directory;
-* *Group ID:* something like 'com.mycompany' - maven overlay property;
-* *Artifact ID:* something like 'myproject' - maven overlay property;
-* *Secret Key:* Provide any pseudo-random, 16 character length, string here that will be used in the generated project for AES ciphering;
-* *Anonimous Key:* - Provide any pseudo-random, 16 character length, string here that will be used in the generated project for AES ciphering;
-* *Configuration directory:* where Syncope configuration files are stored;
-* *Log directory:* where Syncope logs are stored;
-* *Bundle directory:* where ConnId bundles are stored;
-* *Syncope version:* the project version that would be to install.
-
-image::installer-6.png[installer-6]
-
-Syncope options::
-* *Swagger:* check if you want to install Swagger UI;
-* *Camel:* check if you want to install Camel provisioning;
-* *Activiti workflow modeler:* check if you want to install Activiti modeler (default is true);
-
-image::installer-7.png[installer-7]
-
-Database::
-* DBMS where Syncope will be installed;
-
-image::installer-8.png[installer-8]
-
-Database settings::
-* Depends on DBMS selected (in the example: PostgreSQL)
-** Database JDBS url;
-** Database user;
-** Database password;
-
-image::installer-9.png[installer-9]
-
-Application server::
-* Container where Syncope will be deployed;
-
-image::installer-10.png[installer-10]
-
-Application server settings::
-* Depends on container selected (in the example: Tomcat)
-Remember to configure right DataSource on it and to configure Tomcat user like:
-
-[source, xml]
-----
-<?xml version='1.0' encoding='utf-8'?>
-<tomcat-users>
-<role rolename="manager-gui"/>
-<role rolename="manager-script"/>
-<role rolename="manager-jmx"/>
-<role rolename="manager-status"/>
-<user username="manager" password="s3cret" roles="manager-script"/>
-</tomcat-users>
-----
-
-
-The next images shows how the installer print some feedback directly on the GUI or reading the log file under the
-configuration directory:
-
-[source]
---
-/var/tmp/syncope_2_0_0/install.log
---
-
-image::installer-11.png[installer-11]
-
-image::installer-12.png[installer-12]
-
-image::installer-13.png[installer-13]
-
-image::installer-14.png[installer-14]
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/syncope/blob/2a9f92e6/src/main/asciidoc/workingwithapachesyncope/workingwithapachesyncope.adoc
----------------------------------------------------------------------
diff --git a/src/main/asciidoc/workingwithapachesyncope/workingwithapachesyncope.adoc b/src/main/asciidoc/workingwithapachesyncope/workingwithapachesyncope.adoc
index 112c4ba..a451889 100644
--- a/src/main/asciidoc/workingwithapachesyncope/workingwithapachesyncope.adoc
+++ b/src/main/asciidoc/workingwithapachesyncope/workingwithapachesyncope.adoc
@@ -16,10 +16,17 @@
// specific language governing permissions and limitations
// under the License.
//
-== Working with Apache Syncope
+== Installation
+There are many ways to install the Apache Syncope components
+
+* from Maven command line;
+* from the Installer;
+* from the .deb packages.
include::installation/installation.adoc[]
+== Working with Apache Syncope
+
=== Using the Admin Console
include::cli/cli.adoc[]