Spring Boot Documentation

This section provides a brief overview of Spring Boot reference documentation. It serves as a map for the rest of the document.

1. About the Documentation

The Spring Boot reference guide is available as:

The latest copy is available at docs.spring.io/spring-boot/docs/current/reference/.

2. Getting Help

If you have trouble with Spring Boot, we would like to help.

Try the How-to documents. They provide solutions to the most common questions.
Learn the Spring basics. Spring Boot builds on many other Spring projects. Check the spring.io web-site for a wealth of reference documentation. If you are starting out with Spring, try one of the guides.
Ask a question. We monitor stackoverflow.com for questions tagged with spring-boot.
Report bugs with Spring Boot at github.com/spring-projects/spring-boot/issues.

All of Spring Boot is open source, including the documentation. If you find problems with the docs or if you want to improve them, please get involved.

3. Upgrading from an Earlier Version

Instructions for how to upgrade from earlier versions of Spring Boot are provided on the project wiki. Follow the links in the release notes section to find the version that you want to upgrade to.

Upgrading instructions are always the first item in the release notes. If you are more than one release behind, please make sure that you also review the release notes of the versions that you jumped.

You should always ensure that you are running a supported version of Spring Boot.

4. First Steps

If you are getting started with Spring Boot or 'Spring' in general, start with the following topics:

From scratch: Overview | Requirements | Installation
Tutorial: Part 1 | Part 2
Running your example: Part 1 | Part 2

5. Working with Spring Boot

Ready to actually start using Spring Boot? We have you covered:

Build systems: Maven | Gradle | Ant | Starters
Best practices: Code Structure | @Configuration | @EnableAutoConfiguration | Beans and Dependency Injection
Running your code: IDE | Packaged | Maven | Gradle
Packaging your app: Production jars
Spring Boot CLI: Using the CLI

6. Learning about Spring Boot Features

Need more details about Spring Boot’s core features? The following content is for you:

Core Features: SpringApplication | External Configuration | Profiles | Logging
Web Applications: MVC | Embedded Containers
Working with data: SQL | NO-SQL
Messaging: Overview | JMS
Testing: Overview | Boot Applications | Utils
Extending: Auto-configuration | @Conditions

7. Moving to Production

When you are ready to push your Spring Boot application to production, we have some tricks that you might like:

Management endpoints: Overview
Connection options: HTTP | JMX
Monitoring: Metrics | Auditing | HTTP Tracing | Process

8. Advanced Topics

Finally, we have a few topics for more advanced users:

Spring Boot Applications Deployment: Cloud Deployment | OS Service
Build tool plugins: Maven | Gradle
Appendix: Application Properties | Configuration Metadata | Auto-configuration Classes | Test Auto-configuration Annotations | Executable Jars | Dependency Versions