Edit This Page
Before you continue, make sure you have a Maven repository on your Repsy Open Source instance (see Creating a Private Maven Repository).It is now time to use this repository in your projects. Instead of inserting the credentials of your private repository to each of your Maven projects, you may create a global Maven settings file which includes your credentials and is automatically used by all of your projects.
Let’s begin creating the settings file.
Creating settings.xml file
In Linux and Mac
You can create the .m2 directory under the home directory first - which is supposed to be created earlier by Maven - and the settings file by typing the following commands in the command line. Please do not forget to change the MY REPSY USERNAME and MY REPSY PASSWORD place holders with the username and password of a user of your Repsy Open Source instance. Instead of a password you can use a deploy token: put the token in the password field, and the username is not checked.
mkdir -p ~/.m2/
cat << EOF > ~/.m2/settings.xml
<settings xmlns="http://maven.apache.org/SETTINGS/1.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.0.0
http://maven.apache.org/xsd/settings-1.0.0.xsd">
<servers>
<server>
<id>repsy</id>
<username>MY REPSY USERNAME</username>
<password>MY REPSY PASSWORD</password>
</server>
</servers>
</settings>
EOF
In Windows
Press Win + R key and write %USERPROFILE% in the prompt section to go to your home directory. You can now create a .m2 folder.
Inside the .m2 folder create a text file and rename it as settings.xml. Copy the following content into this file. Please do not forget to change the MY REPSY USERNAME and MY REPSY PASSWORD place holders as described above.
<settings xmlns="http://maven.apache.org/SETTINGS/1.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.0.0
http://maven.apache.org/xsd/settings-1.0.0.xsd">
<servers>
<server>
<id>repsy</id>
<username>MY REPSY USERNAME</username>
<password>MY REPSY PASSWORD</password>
</server>
</servers>
</settings>
You can now save and close the settings file.
Deploying your Java library to Private Maven Repository
If you consider deploying your Java library to your private Maven repository, you should first define a distribution repository in your pom.xml file as seen in the following example. In order to adapt the following content to your needs, please modify the host and the <repo-name> field in the repository URL to match your project.
<project>
<!-- ... Other project settings -->
<groupId>com.example</groupId>
<artifactId>demo</artifactId>
<version>0.0.1-SNAPSHOT</version>
<name>demo</name>
<distributionManagement>
<!-- ... Some other Distribution repository definitions -->
<repository>
<id>repsy</id>
<name>My Private Maven Repository on Repsy</name>
<url>https://<your-repsy-host>/<repo-name></url>
</repository>
<!-- ... Some other Distribution repository definitions -->
</distributionManagement>
<!-- ... Other project settings -->
</project>
You are now ready to deploy! Please run:
mvn deploy
from the command line. If Maven has not been installed before, you can run ./mvnw deploy for Linux/Mac or mvnw deploy for Windows.
Meanwhile, most modern IDEs and editors also provide other methodologies for executing maven commands.
Using your Java library from your Private Maven Repository
You have deployed your Java library and now want to use it in your Java projects. First, you need to add a repository section in your pom.xml file, similar to distribution repository. Please do not forget to modify the host and the <repo-name> field in the repository URL to match your project.
<project>
<!-- ... Other project settings -->
<repositories>
<!-- ... some other repository definitions -->
<repository>
<id>repsy</id>
<name>My Private Maven Repository on Repsy</name>
<url>https://<your-repsy-host>/<repo-name></url>
</repository>
<!-- ... some other repository definitions -->
</repositories>
<!-- ... Other project settings -->
</project>
Secondly, you need to define your dependency in pom.xml as well.
<project>
<!-- ... Other project settings -->
<dependencies>
<!-- ... some other dependency definitions -->
<dependency>
<groupId>com.example</groupId>
<artifactId>demo</artifactId>
<version>0.0.1-SNAPSHOT</version>
</dependency>
<!-- ... some other dependency definitions -->
</dependencies>
<!-- ... Other project settings -->
</project>
You are now ready to compile the project!
Please run
mvn compile
from the command line.
If Maven has not been installed before, you can run ./mvnw compile for Linux/Mac or mvnw compile for Windows.
Further Reading
Please refer to the official documentation of Apache Maven Deploy Plug-in for further information.
