Repository: syncope Updated Branches: refs/heads/master c95ca2fd2 -> 73b9f6d67
installer, SYNCOPE-700 Project: http://git-wip-us.apache.org/repos/asf/syncope/repo Commit: http://git-wip-us.apache.org/repos/asf/syncope/commit/97b202db Tree: http://git-wip-us.apache.org/repos/asf/syncope/tree/97b202db Diff: http://git-wip-us.apache.org/repos/asf/syncope/diff/97b202db Branch: refs/heads/master Commit: 97b202db1650470e4d2789cb6e088fcbba5a1e89 Parents: c95ca2f Author: Massimiliano Perrone <massimiliano.perr...@tirasa.net> Authored: Wed Dec 16 12:20:02 2015 +0100 Committer: Massimiliano Perrone <massimiliano.perr...@tirasa.net> Committed: Wed Dec 16 12:20:11 2015 +0100 ---------------------------------------------------------------------- src/main/asciidoc/images/installer-1.png | Bin 0 -> 170640 bytes src/main/asciidoc/images/installer-10.png | Bin 0 -> 45301 bytes src/main/asciidoc/images/installer-11.png | Bin 0 -> 55982 bytes src/main/asciidoc/images/installer-12.png | Bin 0 -> 375102 bytes src/main/asciidoc/images/installer-13.png | Bin 0 -> 72643 bytes src/main/asciidoc/images/installer-14.png | Bin 0 -> 39897 bytes src/main/asciidoc/images/installer-2.png | Bin 0 -> 69467 bytes src/main/asciidoc/images/installer-3.png | Bin 0 -> 61796 bytes src/main/asciidoc/images/installer-4.png | Bin 0 -> 42771 bytes src/main/asciidoc/images/installer-5.png | Bin 0 -> 58758 bytes src/main/asciidoc/images/installer-6.png | Bin 0 -> 47589 bytes src/main/asciidoc/images/installer-7.png | Bin 0 -> 44672 bytes src/main/asciidoc/images/installer-8.png | Bin 0 -> 45854 bytes src/main/asciidoc/images/installer-9.png | Bin 0 -> 44522 bytes src/main/asciidoc/reference-guide.adoc | 3 - .../installation/deb.adoc | 118 +++++++++++++++++++ .../installation/installation.adoc | 30 +++++ .../installation/installer.adoc | 118 +++++++++++++++++++ .../installation/maven.adoc | 118 +++++++++++++++++++ .../workingwithapachesyncope.adoc | 2 + 20 files changed, 386 insertions(+), 3 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/syncope/blob/97b202db/src/main/asciidoc/images/installer-1.png ---------------------------------------------------------------------- diff --git a/src/main/asciidoc/images/installer-1.png b/src/main/asciidoc/images/installer-1.png new file mode 100644 index 0000000..145735d Binary files /dev/null and b/src/main/asciidoc/images/installer-1.png differ http://git-wip-us.apache.org/repos/asf/syncope/blob/97b202db/src/main/asciidoc/images/installer-10.png ---------------------------------------------------------------------- diff --git a/src/main/asciidoc/images/installer-10.png b/src/main/asciidoc/images/installer-10.png new file mode 100644 index 0000000..ec0b151 Binary files /dev/null and b/src/main/asciidoc/images/installer-10.png differ http://git-wip-us.apache.org/repos/asf/syncope/blob/97b202db/src/main/asciidoc/images/installer-11.png ---------------------------------------------------------------------- diff --git a/src/main/asciidoc/images/installer-11.png b/src/main/asciidoc/images/installer-11.png new file mode 100644 index 0000000..351aef6 Binary files /dev/null and b/src/main/asciidoc/images/installer-11.png differ http://git-wip-us.apache.org/repos/asf/syncope/blob/97b202db/src/main/asciidoc/images/installer-12.png ---------------------------------------------------------------------- diff --git a/src/main/asciidoc/images/installer-12.png b/src/main/asciidoc/images/installer-12.png new file mode 100644 index 0000000..692790f Binary files /dev/null and b/src/main/asciidoc/images/installer-12.png differ http://git-wip-us.apache.org/repos/asf/syncope/blob/97b202db/src/main/asciidoc/images/installer-13.png ---------------------------------------------------------------------- diff --git a/src/main/asciidoc/images/installer-13.png b/src/main/asciidoc/images/installer-13.png new file mode 100644 index 0000000..0bc120e Binary files /dev/null and b/src/main/asciidoc/images/installer-13.png differ http://git-wip-us.apache.org/repos/asf/syncope/blob/97b202db/src/main/asciidoc/images/installer-14.png ---------------------------------------------------------------------- diff --git a/src/main/asciidoc/images/installer-14.png b/src/main/asciidoc/images/installer-14.png new file mode 100644 index 0000000..8fbf70f Binary files /dev/null and b/src/main/asciidoc/images/installer-14.png differ http://git-wip-us.apache.org/repos/asf/syncope/blob/97b202db/src/main/asciidoc/images/installer-2.png ---------------------------------------------------------------------- diff --git a/src/main/asciidoc/images/installer-2.png b/src/main/asciidoc/images/installer-2.png new file mode 100644 index 0000000..cba6a93 Binary files /dev/null and b/src/main/asciidoc/images/installer-2.png differ http://git-wip-us.apache.org/repos/asf/syncope/blob/97b202db/src/main/asciidoc/images/installer-3.png ---------------------------------------------------------------------- diff --git a/src/main/asciidoc/images/installer-3.png b/src/main/asciidoc/images/installer-3.png new file mode 100644 index 0000000..b283b50 Binary files /dev/null and b/src/main/asciidoc/images/installer-3.png differ http://git-wip-us.apache.org/repos/asf/syncope/blob/97b202db/src/main/asciidoc/images/installer-4.png ---------------------------------------------------------------------- diff --git a/src/main/asciidoc/images/installer-4.png b/src/main/asciidoc/images/installer-4.png new file mode 100644 index 0000000..7e3439e Binary files /dev/null and b/src/main/asciidoc/images/installer-4.png differ http://git-wip-us.apache.org/repos/asf/syncope/blob/97b202db/src/main/asciidoc/images/installer-5.png ---------------------------------------------------------------------- diff --git a/src/main/asciidoc/images/installer-5.png b/src/main/asciidoc/images/installer-5.png new file mode 100644 index 0000000..c2691e8 Binary files /dev/null and b/src/main/asciidoc/images/installer-5.png differ http://git-wip-us.apache.org/repos/asf/syncope/blob/97b202db/src/main/asciidoc/images/installer-6.png ---------------------------------------------------------------------- diff --git a/src/main/asciidoc/images/installer-6.png b/src/main/asciidoc/images/installer-6.png new file mode 100644 index 0000000..c97d5f2 Binary files /dev/null and b/src/main/asciidoc/images/installer-6.png differ http://git-wip-us.apache.org/repos/asf/syncope/blob/97b202db/src/main/asciidoc/images/installer-7.png ---------------------------------------------------------------------- diff --git a/src/main/asciidoc/images/installer-7.png b/src/main/asciidoc/images/installer-7.png new file mode 100644 index 0000000..2153073 Binary files /dev/null and b/src/main/asciidoc/images/installer-7.png differ http://git-wip-us.apache.org/repos/asf/syncope/blob/97b202db/src/main/asciidoc/images/installer-8.png ---------------------------------------------------------------------- diff --git a/src/main/asciidoc/images/installer-8.png b/src/main/asciidoc/images/installer-8.png new file mode 100644 index 0000000..d744b0d Binary files /dev/null and b/src/main/asciidoc/images/installer-8.png differ http://git-wip-us.apache.org/repos/asf/syncope/blob/97b202db/src/main/asciidoc/images/installer-9.png ---------------------------------------------------------------------- diff --git a/src/main/asciidoc/images/installer-9.png b/src/main/asciidoc/images/installer-9.png new file mode 100644 index 0000000..62ce3f9 Binary files /dev/null and b/src/main/asciidoc/images/installer-9.png differ http://git-wip-us.apache.org/repos/asf/syncope/blob/97b202db/src/main/asciidoc/reference-guide.adoc ---------------------------------------------------------------------- diff --git a/src/main/asciidoc/reference-guide.adoc b/src/main/asciidoc/reference-guide.adoc index d34d1e8..70689d4 100644 --- a/src/main/asciidoc/reference-guide.adoc +++ b/src/main/asciidoc/reference-guide.adoc @@ -71,6 +71,3 @@ include::extensions/extensions.adoc[] // TO DO include::usecases/usecases.adoc[] - -// Chapters will be placed in separate .adoc files in the same directory -//include::XXX.adoc[] http://git-wip-us.apache.org/repos/asf/syncope/blob/97b202db/src/main/asciidoc/workingwithapachesyncope/installation/deb.adoc ---------------------------------------------------------------------- diff --git a/src/main/asciidoc/workingwithapachesyncope/installation/deb.adoc b/src/main/asciidoc/workingwithapachesyncope/installation/deb.adoc new file mode 100644 index 0000000..096530e --- /dev/null +++ b/src/main/asciidoc/workingwithapachesyncope/installation/deb.adoc @@ -0,0 +1,118 @@ +// +// 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> +---- + +image::installer-11.png[installer-11] + +image::installer-12.png[installer-12] + +image::installer-13.png[installer-13] + +image::installer-14.png[installer-14] + +The latest images shows how the installer print some feedback directly on the GUI or following the log + +[source] +-- +/var/tmp/syncope_2_0_0/install.log +-- \ No newline at end of file http://git-wip-us.apache.org/repos/asf/syncope/blob/97b202db/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 new file mode 100644 index 0000000..06f419f --- /dev/null +++ b/src/main/asciidoc/workingwithapachesyncope/installation/installation.adoc @@ -0,0 +1,30 @@ +// +// 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. +// +=== Installation +There are many ways to install the Apache Syncope components + +* from Maven command line; +* from the Installer; +* from the .deb packages. + +include::maven.adoc[] + +include::installer.adoc[] + +include::deb.adoc[] http://git-wip-us.apache.org/repos/asf/syncope/blob/97b202db/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 new file mode 100644 index 0000000..096530e --- /dev/null +++ b/src/main/asciidoc/workingwithapachesyncope/installation/installer.adoc @@ -0,0 +1,118 @@ +// +// 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> +---- + +image::installer-11.png[installer-11] + +image::installer-12.png[installer-12] + +image::installer-13.png[installer-13] + +image::installer-14.png[installer-14] + +The latest images shows how the installer print some feedback directly on the GUI or following the log + +[source] +-- +/var/tmp/syncope_2_0_0/install.log +-- \ No newline at end of file http://git-wip-us.apache.org/repos/asf/syncope/blob/97b202db/src/main/asciidoc/workingwithapachesyncope/installation/maven.adoc ---------------------------------------------------------------------- diff --git a/src/main/asciidoc/workingwithapachesyncope/installation/maven.adoc b/src/main/asciidoc/workingwithapachesyncope/installation/maven.adoc new file mode 100644 index 0000000..096530e --- /dev/null +++ b/src/main/asciidoc/workingwithapachesyncope/installation/maven.adoc @@ -0,0 +1,118 @@ +// +// 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> +---- + +image::installer-11.png[installer-11] + +image::installer-12.png[installer-12] + +image::installer-13.png[installer-13] + +image::installer-14.png[installer-14] + +The latest images shows how the installer print some feedback directly on the GUI or following the log + +[source] +-- +/var/tmp/syncope_2_0_0/install.log +-- \ No newline at end of file http://git-wip-us.apache.org/repos/asf/syncope/blob/97b202db/src/main/asciidoc/workingwithapachesyncope/workingwithapachesyncope.adoc ---------------------------------------------------------------------- diff --git a/src/main/asciidoc/workingwithapachesyncope/workingwithapachesyncope.adoc b/src/main/asciidoc/workingwithapachesyncope/workingwithapachesyncope.adoc index 7b62493..112c4ba 100644 --- a/src/main/asciidoc/workingwithapachesyncope/workingwithapachesyncope.adoc +++ b/src/main/asciidoc/workingwithapachesyncope/workingwithapachesyncope.adoc @@ -18,6 +18,8 @@ // == Working with Apache Syncope +include::installation/installation.adoc[] + === Using the Admin Console include::cli/cli.adoc[]