Spring Boot Change Application Root or Context Path

By default, Spring boot applications are accessed by context path “/” which is default for embedded servers i.e. you can access the application directly at http://localhost:PORT/. But in production, you will deploy the application under some context root – so that you can refer the URLs for other places. Also, it is desirable to configure security and there you will need application’s context root.

Spring boot is pretty much flexible and provide you multiple options to configure applications context root path.

1) Change context root from application.properties file

You can do lots of wonderful things by simply making few entries in application.properties file in any spring boot application. Changing context root path is one of them.

### Default server path #########
server.port=8080

### Context root path ########
server.contextPath=/home

2) Implement EmbeddedServletContainerCustomizer interface

EmbeddedServletContainerCustomizer interface is used for customizing auto-configured embedded servlet containers. Any beans of this type will get a callback with the container factory before the container itself is started, so you can set the port, address, error pages etc.

import org.springframework.boot.context.embedded.ConfigurableEmbeddedServletContainer;
import org.springframework.boot.context.embedded.EmbeddedServletContainerCustomizer;
import org.springframework.stereotype.Component;

@Component
public class AppContainerCustomizer implements EmbeddedServletContainerCustomizer {

	@Override
	public void customize(ConfigurableEmbeddedServletContainer container) {

		container.setPort(8080);
		container.setContextPath("/home");

	}
}

3) Change context root from command line

If you application is built as uber jar, you may consider this option as well.

java -jar -Dserver.contextPath=/home spring-boot-demo.jar

Let me know if you know any other way to accomplish this change in spring boot application context root path.

Happy Learning !!