Versions Compared

Old Version 35

changes.mady.by.user Fabio Martelli

Saved on

compared with

New Version Current

changes.mady.by.user Francesco Chicchiriccò

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Note
titleVersion warning

The content below is for Apache Syncope <= 1.2 - for later versions the Getting Started guide is available.

Table of Contents
styledecimal

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.

...

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.12.511

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.

...

Take a look at available releases of the archetype project at central Maven repository, then change the archetypeVersion in the mvn command above accordingly.

...

...

A bug (SYNCOPE-452) has been found in Apache Syncope 1.1.5.

If you are running 1.1.5, remove the file core/src/test/resources/rest.properties before starting the embedded evironment.

Warning
titleBugs in Apache Syncope 1.1.0

A couple of bugs (SYNCOPE-352, SYNCOPE-356) have been found in Apache Syncope 1.1.0, already fixed for release versions >= 1.1.1.

Upgrade to 1.1.1 is strongly suggested.

If you are running 1.1.0,

  • download this class and save it under core/src/main/java/org/apache/syncope/core/init/ (create intermediate directories if needed)
  • download this class and save it under console/src/main/java/org/apache/syncope/console/pages/panels/ (create intermediate directories if needed)

Snapshot (development) releases

...

If you want to test a snapshot release, be sure to:

  1. change

    Code Block
    http://repo1.maven.org/maven2
    to
    Code 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
    in the mvn command above
     \
    -DarchetypeVersion=1.2.11-SNAPSHOT

  2. add the following code right before </project> in root pom.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:

...