Repository: syncope Updated Branches: refs/heads/master b7f88690c -> 546ea0bf3
Added debian packages, SYNCOPE-700 Project: http://git-wip-us.apache.org/repos/asf/syncope/repo Commit: http://git-wip-us.apache.org/repos/asf/syncope/commit/546ea0bf Tree: http://git-wip-us.apache.org/repos/asf/syncope/tree/546ea0bf Diff: http://git-wip-us.apache.org/repos/asf/syncope/diff/546ea0bf Branch: refs/heads/master Commit: 546ea0bf32cfd247a39058ad3f818e9ddc2dc4f4 Parents: b7f8869 Author: Massimiliano Perrone <massimiliano.perr...@tirasa.net> Authored: Wed Dec 16 15:56:43 2015 +0100 Committer: Massimiliano Perrone <massimiliano.perr...@tirasa.net> Committed: Wed Dec 16 15:56:50 2015 +0100 ---------------------------------------------------------------------- src/main/asciidoc/commondocs/debpackages.adoc | 88 ++++++++++++++ src/main/asciidoc/obtain.adoc | 72 +---------- .../installation/deb.adoc | 118 ------------------- .../installation/installation.adoc | 2 +- .../installation/maven.adoc | 101 +--------------- 5 files changed, 91 insertions(+), 290 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/syncope/blob/546ea0bf/src/main/asciidoc/commondocs/debpackages.adoc ---------------------------------------------------------------------- diff --git a/src/main/asciidoc/commondocs/debpackages.adoc b/src/main/asciidoc/commondocs/debpackages.adoc new file mode 100644 index 0000000..ebaa299 --- /dev/null +++ b/src/main/asciidoc/commondocs/debpackages.adoc @@ -0,0 +1,88 @@ +// +// 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. +// +=== Debian packages + +Debian packages are available for use with http://www.debian.org/[Debian GNU / Linux^], +http://www.ubuntu.com/[Ubuntu^] and their derivatives. + +[CAUTION] +.Target Audience +Getting up and running quickly on Debian / Ubuntu. + +*Difficult to extend beyond pre-sets.* + +Download:: +http://syncope.apache.org/downloads.html[Download^] the latest .deb packages +Prepare:: +. Install Apache Tomcat 8 and PostgreSQL ++ +[source,bash] +sudo apt-get install tomcat8 libpostgresql-jdbc-java postgresql postgresql-client ++ +. Use the PostgreSQL JDBC driver with Tomcat ++ +[source,bash] +sudo ln -s /usr/share/java/postgresql-jdbc4.jar /usr/share/tomcat8/lib/ ++ +. Replace `JAVA_OPTS` in `/etc/default/tomcat8` with the following: ++ +[source,bash] +---- +JAVA_OPTS="-Djava.awt.headless=true -Dfile.encoding=UTF-8 -server \ + -Xms1536m -Xmx1536m -XX:NewSize=256m -XX:MaxNewSize=256m + -XX:PermSize=256m -XX:MaxPermSize=256m -XX:+DisableExplicitGC" +---- ++ +Install:: +. Stop Tomcat ++ +[source,bash] +sudo service tomcat8 stop ++ +. Install Apache Syncope core and console via the downloaded packages ++ +[source,bash] +sudo dpkg -i apache-syncope-*.deb ++ +. Create a database for use with Apache Syncope ++ +[source,bash] +sudo SYNCOPE_USER="syncope" SYNCOPE_PASS="syncope" sh /usr/share/apache-syncope/dbinit-postgresql.sh ++ +. Start Tomcat ++ +[source,bash] +sudo service tomcat8 start + +==== Components + +CAUTION: The following assumes that Apache Tomcat is reachable on host `host.domain` and port `port`. + +[cols="1,2"] +|=== + +| Complete REST API reference +| http://host.domain:port/syncope/index.html + +| http://swagger.io/[Swagger^] UI +| http://host.domain:port/syncope/swagger/ + +| Administration console +| http://host.domain:port/syncope-console/ + + +|=== \ No newline at end of file http://git-wip-us.apache.org/repos/asf/syncope/blob/546ea0bf/src/main/asciidoc/obtain.adoc ---------------------------------------------------------------------- diff --git a/src/main/asciidoc/obtain.adoc b/src/main/asciidoc/obtain.adoc index 23357dd..c87cf7a 100644 --- a/src/main/asciidoc/obtain.adoc +++ b/src/main/asciidoc/obtain.adoc @@ -83,77 +83,7 @@ This will create H2 database files in the home directory of the user running Apa Please refer to the http://www.h2database.com/[H2 documentation^] for more options. ==== -=== Debian packages - -Debian packages are available for use with http://www.debian.org/[Debian GNU / Linux^], -http://www.ubuntu.com/[Ubuntu^] and their derivatives. - -[CAUTION] -.Target Audience -Getting up and running quickly on Debian / Ubuntu. + -*Difficult to extend beyond pre-sets.* - -Download:: -http://syncope.apache.org/downloads.html[Download^] the latest .deb packages -Prepare:: -. Install Apache Tomcat 8 and PostgreSQL -+ -[source,bash] -sudo apt-get install tomcat8 libpostgresql-jdbc-java postgresql postgresql-client -+ -. Use the PostgreSQL JDBC driver with Tomcat -+ -[source,bash] -sudo ln -s /usr/share/java/postgresql-jdbc4.jar /usr/share/tomcat8/lib/ -+ -. Replace `JAVA_OPTS` in `/etc/default/tomcat8` with the following: -+ -[source,bash] ----- -JAVA_OPTS="-Djava.awt.headless=true -Dfile.encoding=UTF-8 -server \ - -Xms1536m -Xmx1536m -XX:NewSize=256m -XX:MaxNewSize=256m - -XX:PermSize=256m -XX:MaxPermSize=256m -XX:+DisableExplicitGC" ----- -+ -Install:: -. Stop Tomcat -+ -[source,bash] -sudo service tomcat8 stop -+ -. Install Apache Syncope core and console via the downloaded packages -+ -[source,bash] -sudo dpkg -i apache-syncope-*.deb -+ -. Create a database for use with Apache Syncope -+ -[source,bash] -sudo SYNCOPE_USER="syncope" SYNCOPE_PASS="syncope" sh /usr/share/apache-syncope/dbinit-postgresql.sh -+ -. Start Tomcat -+ -[source,bash] -sudo service tomcat8 start - -==== Components - -CAUTION: The following assumes that Apache Tomcat is reachable on host `host.domain` and port `port`. - -[cols="1,2"] -|=== - -| Complete REST API reference -| http://host.domain:port/syncope/index.html - -| http://swagger.io/[Swagger^] UI -| http://host.domain:port/syncope/swagger/ - -| Administration console -| http://localhost:9080/syncope-console/ + -Credentials: `admin` / `password` - -|=== +include::commondocs/debpackages.adoc[] include::commondocs/guiinstaller.adoc[] http://git-wip-us.apache.org/repos/asf/syncope/blob/546ea0bf/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 deleted file mode 100644 index 096530e..0000000 --- a/src/main/asciidoc/workingwithapachesyncope/installation/deb.adoc +++ /dev/null @@ -1,118 +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> ----- - -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/546ea0bf/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 f7ff705..409997a 100644 --- a/src/main/asciidoc/workingwithapachesyncope/installation/installation.adoc +++ b/src/main/asciidoc/workingwithapachesyncope/installation/installation.adoc @@ -20,4 +20,4 @@ include::../../commondocs/guiinstaller.adoc[] include::maven.adoc[] -include::deb.adoc[] +include::../../commondocs/debpackages.adoc[] http://git-wip-us.apache.org/repos/asf/syncope/blob/546ea0bf/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 index 096530e..12e6d69 100644 --- a/src/main/asciidoc/workingwithapachesyncope/installation/maven.adoc +++ b/src/main/asciidoc/workingwithapachesyncope/installation/maven.adoc @@ -16,103 +16,4 @@ // 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 +==== Maven \ No newline at end of file