Maven setup

Maven is a tool for managing project dependencies and building your Magnolia project.

This page describes how to configure Maven to download Magnolia modules and webapps from our Nexus server, with appropriate access credentials.

Install Maven

Download and Install Maven. In order to verify Maven has been installed correctly:

1. Open a terminal or a shell.
2. Issue the command  mvn -v . The command should produce an output similar to this:

mvn -v

Apache Maven 3.9.1 (2e178502fcdbffc201671fb2537d0cb4b4cc58f8)
Maven home: /usr/local/apache-maven-3.9.1
Java version: 17.0.6, vendor: Eclipse Adoptium, runtime: path/to/install
Default locale: fr_FR, platform encoding: UTF-8
OS name: "<OPERATING_SYSTEM>"

Maven keeps your user configuration and local repository under the ${user.home}/.m2/ directory. See also Configuring Maven.

Set up Magnolia repositories

For DX Core projects, or for community releases in maintenance mode, add the following repository to your project POM (or Maven settings profile), and follow the next sections to set up authentication:

<repositories>
  <repository>
    <id>magnolia.nexus.enterprise</id>
    <url>https://nexus.magnolia-cms.com/repository/enterprise</url>
  </repository>
</repositories>

For Community Edition projects, simply use the repositories below:

<repositories>
  <repository>
    <id>magnolia.nexus.public</id>
    <url>https://nexus.magnolia-cms.com/repository/public</url>
  </repository>
   <repository>
    <id>vaadin-addons</id>
    <url>https://maven.vaadin.com/vaadin-addons/</url>
  </repository>
 </repositories>

See also: Maven – Setting up Multiple Repositories

Create a master password (recommended)

Run the following command:

mvn --encrypt-master-password

This command will produce an encrypted version of the password, something like

{jSMOWnoPFgsHVpMvz5VrIt5kRbzGpI8u+9EF1iFQyJQ=}

Store this password in your ~/.m2/settings-security.xml; it should look like

<settingsSecurity>
  <master>{jSMOWnoPFgsHVpMvz5VrIt5kRbzGpI8u+9EF1iFQyJQ=}</master>
</settingsSecurity>

See more: Maven – Password Encryption

Set up credentials in Maven settings

Log into Nexus with your regular credentials. Go to your Profile from the user menu, then select User Token in the drop-down.

See more: Security Setup with User Tokens

If you have created a master password above, run the following command with your user token pass code.

mvn --encrypt-password {userTokenPassCode} 

You will use the encrypted pass code in the <server> credentials below, instead of your {userTokenPassCode} in clear text.

Add the following to your Maven settings at ~/.m2/settings.xml, with your Nexus user tokens obtained above:

<servers>
  <server>
    <!-- must match the repository id in your project pom -->
    <id>magnolia.nexus.enterprise</id>
    <username>{userTokenNameCode}</username>
    <password>{userTokenPassCode}</password>
  </server>
</servers>

The server id must match the repository id in your project pom or 'magnolia-repositories' profile in maven settings.

Using Magnolia Maven archetypes

In order to use Magnolia Maven archetypes, add the following to your Maven settings:

<profiles>
  <profile>
    <id>magnolia-repositories</id>
    <activation>
      <activeByDefault>true</activeByDefault>
    </activation>
    <repositories>
      <!-- required for Magnolia Maven archetypes -->
      <repository>
        <id>magnolia.nexus.public</id>
        <url>https://nexus.magnolia-cms.com/repository/public</url>
      </repository>
    </repositories>
  </profile>
</profiles> 

See also: Maven Archetype Plugin — Archetype repository

Download Magnolia Maven settings (advanced)

For deploying and releasing purposes, mostly for Magnolia staff, a download script and template is available in the 'onboarding' repository on Bitbucket.

Mirroring

If you have your own Repository Manager, below are the repositories you can mirror: