Skip to content

Commit ea7ee3b

Browse files
Changing documentation
1 parent 3e99f6b commit ea7ee3b

File tree

2 files changed

+38
-22
lines changed

2 files changed

+38
-22
lines changed

details/integration_guide.md

Lines changed: 34 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -2,50 +2,62 @@
22

33
## Overview
44

5-
This guide outlines the steps needed to integrate the TuxCare Vetted repository into your Java application. The repository provides trusted, vetted Java libraries that can be easily integrated into your Maven project.
5+
This guide outlines the steps needed to integrate the TuxCare ELS Spring repository into your Java application. The repository provides trusted Java libraries that can be easily integrated into your Maven as well as Gradle project.
66

77
## Steps
88

9-
### Step 1: Locate the Repository
9+
### Step 1: Get user credntials
10+
You need username and password in order to use TuxCare ELS Spring repository. Anonymous access is disabled.
1011

11-
You can find the Trusted repository using the following link: [TuxCare Vetted Repository](https://nexus-repo.corp.cloudlinux.com/#browse/browse:tuxcare_vetted).
12+
### Step 2: Locate the Repository
1213

13-
### Step 2: Create or Modify Your Build Tool Settings
14+
You can find the Trusted repository using the following link: [TuxCare ELS Spring](https://nexus-repo.corp.cloudlinux.com/#browse/browse:els_spring).
1415

15-
If you are using Maven as your build automation tool, you will need to make changes in your `${MAVEN_HOME}/settings.xml` file. If the file does not already exist in your Maven home directory (`${MAVEN_HOME}`), you should create one. Open the `settings.xml` file with a text editor and include the following configuration:
16+
### Step 3: Create or Modify Your Build Tool Settings
17+
18+
#### Maven
19+
20+
If you are using Maven as your build automation tool, you will need to make changes in your `${MAVEN_HOME}/settings.xml` file. If the file does not already exist in your Maven home directory (`${MAVEN_HOME}`), you should create one. Open the `settings.xml` file with a text editor and include the following configuration:
1621

1722
```xml
1823
<?xml version="1.0" encoding="UTF-8"?>
1924
<settings xmlns="http://maven.apache.org/SETTINGS/1.1.0">
20-
<profiles>
21-
<profile>
22-
<id>tuxcare</id>
23-
<repositories>
24-
<repository>
25-
<id>tuxcare-vetted</id>
26-
<name>TuxCare Vetted Repository</name>
27-
<url>https://nexus-repo.corp.cloudlinux.com/repository/tuxcare-vetted/</url>
28-
</repository>
29-
</repositories>
30-
</profile>
31-
</profiles>
32-
<activeProfiles>
33-
<activeProfile>tuxcare</activeProfile>
34-
</activeProfiles>
25+
<servers>
26+
<server>
27+
<id>repository-id</id>
28+
<username>your-username</username>
29+
<password>your-password</password>
30+
</server>
31+
</servers>
3532
</settings>
3633
```
3734

38-
In this configuration, a profile named `tuxcare` is created. The TuxCare Vetted repository is added to this profile, and this profile is set to be activated by default in the `activeProfiles` section.
35+
In this configuration ```your-username``` and ```your-password``` are your credentials mentioed in the Step 1. You may choose an arbitrary allowed value instead of ```repository-id``` and use the same value in the following snippet from your `pom.xml` file:
36+
```xml
37+
<repositories>
38+
<repository>
39+
<id>repository-id</id>
40+
<url>https://nexus-repo.corp.cloudlinux.com/repository/els_spring/</url>
41+
</repository>
42+
</repositories>
43+
```
44+
45+
#### Gradle
3946

4047
If you are using Gradle as your build automation tool, make sure to include the following configuration in your project setup:
4148

4249
```gradle
4350
repositories {
4451
maven {
45-
url = uri("https://nexus-repo.corp.cloudlinux.com/repository/tuxcare-vetted/")
52+
url = uri("https://nexus-repo.corp.cloudlinux.com/repository/els_spring")
53+
credentials {
54+
username = "your-username"
55+
password = "your-password"
56+
}
4657
}
4758
}
4859
```
60+
In this configuration ```your-username``` and ```your-password``` are your credentials mentioed in the Step 1.
4961

5062
## Verification
5163

examples/maven/readme.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
Build it with the following command:
2+
```bash
3+
mvn --settings ./mvn/settings.xml clean install
4+
```

0 commit comments

Comments
 (0)