Skip to content

docs: update required dependency when Spring Boot 4.x #5412

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Naadiyaar wants to merge 2 commits into
base: master
Choose a base branch
from
+12 −1
Open

docs: update required dependency when Spring Boot 4.x #5412

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
aa60239
docs: update required dependency when Spring Boot 4.x
Naadiyaar Jun 3, 2026
040ad9b
docs: add warning about client's necessary dependency for Spring Boot 4
Naadiyaar Jun 3, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 12 additions & 1 deletion spring-boot-admin-docs/src/site/docs/01-getting-started/20-client-registration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,20 +19,31 @@ The Spring Boot Admin Client library enables applications to register themselves

### Step 1: Add Dependencies

Add the Spring Boot Admin Client starter to your application:
Add the Spring Boot Admin Client starter and the Spring Boot RestClient to your application:
Copy link
Copy Markdown
Contributor

@cdprete cdprete Jun 3, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Only when targeting Spring Boot > 3.x, though.

Copy link
Copy Markdown
Author

@Naadiyaar Naadiyaar Jun 3, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

True, I thought of adding an INFO / WARNING message but since documentation is already pointing at latest version (4+) already I thought that's not necessary.

I can add that if that's preferred.

P.S. Boot 3 open source support ends in 26 days. One should probably remove it then.

Copy link
Copy Markdown
Contributor

@cdprete cdprete Jun 3, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It doesn't hurt to be clearer 😉

Also, people may still use SBA 3.x with the docs of 4.x to a certain degree.

Copy link
Copy Markdown
Author

@Naadiyaar Naadiyaar Jun 3, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done


> [!IMPORTANT]
> Add `spring-boot-restclient` only if using Spring Boot 4.x and later. Otherwise only add the starter dependency.

```xml title="pom.xml"
<dependency>
<groupId>de.codecentric</groupId>
<artifactId>spring-boot-admin-starter-client</artifactId>
<version>@VERSION@</version>
</dependency>

<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-restclient</artifactId>
<version>@VERSION@</version>
<scope>compile</scope>
</dependency>
```

For Gradle:

```groovy title="build.gradle"
implementation 'de.codecentric:spring-boot-admin-starter-client:@VERSION@'
implementation 'org.springframework.boot:spring-boot-restclient:@VERSION@'
```

### Step 2: Configure the Admin Server URL
Expand Down