Note | ||
---|---|---|
| ||
The content below is for Apache Syncope <= 1.2 - for later versions the Getting Started guide is available. |
Table of Contents | ||
---|---|---|
|
Introduction
This document describes how to create a new Syncope project.
A Syncope project includes (at least) two web applications: the core and the console. This page helps you get both web applications up and running with your own project as quickly as possible.
...
The preferred way to create a Syncope project is to generate a Maven project starting from published archetype.
Hence you need:
- Java SE Development Kit 6 (version 1.6.0-23 or higher) installed;
- Apache Maven (version 3.0.3 or higher) installed;
- Some basic knowledge about Maven;
- Some basic knowledge about Maven WAR overlays;
- Some basic knowledge about Maven archetypes.
...
Maven archetypes are templates of projects. Maven can generate a new project from such a template. For a project using Syncope, you need the website archetype. In the folder in which the new project folder should be created, type the command shown below. On Windows, run the command on a single line and leave out the line continuation characters ('\').
Code Block |
---|
mvn archetype:generate \ -DarchetypeGroupId=org.apache.syncope \ -DarchetypeArtifactId=syncope-archetype \ -DarchetypeRepository=http://repo1.maven.org/maven2 \ -DarchetypeVersion=1.0.0-RC1-incubating2.11 |
The archetype is configured with default values for all properties required by the archetype. If you want to customize any of these property values, type 'n' when prompted for confirmation.
You will be asked for:
- the groupId, (
something like 'com.mycompany') - the artifactId (
something like 'myproject') - the version number (you
You can use the default, ; it is good practice to have 'SNAPSHOT' in the version number during development and the maven release plugin makes use of that string. But ensure to comply to the desired numbering scheme for your project). - the package name. This is the
The java package name. A folder structure according to this name will be generated automatically. Use the ; by default, which is equal to the groupId - (for archetypeVersion >= 1.0.5), the secretKey
Provide any pseudo-random, 16 character length, string here that will be used in the generated project for AES ciphering.
Maven will create a project for you (in a newly created directory named after the value of the artifactId property you specified) containing two subprojects:
...
If you want to test a snapshot release, be sure to:
change
toCode Block http://repo1.maven.org/maven2
in the mvn command aboveCode Block mvn org.apache.maven.plugins:maven-archetype-plugin:2.4:generate \ -DarchetypeGroupId=org.apache.syncope \ -DarchetypeArtifactId=syncope-archetype \ -DarchetypeRepository=http://repository.apache.org/content/repositories/snapshots
\ -DarchetypeVersion=1.2.11-SNAPSHOT
add the following code right before
</project>
in rootpom.xml
of the generated project:Code Block <repositories> <repository> <id>ASF</id> <url>https://repository.apache.org/content/repositories/snapshots/</url> <snapshots> <enabled>true</enabled> </snapshots> </repository> </repositories>
...
Now build your project using the following command in the root folder of your project:
Code Block |
---|
mvn clean package
|
This will produce two WAR files:
...