From f5482a33a346d9aff35a3e7e121c542fc973903f Mon Sep 17 00:00:00 2001 From: Stephane Nicoll Date: Fri, 24 Aug 2018 16:38:24 +0200 Subject: [PATCH] Document custom DispatcherServlet requirement Closes gh-14145 --- .../src/main/asciidoc/howto.adoc | 22 ++++++++++++++----- 1 file changed, 16 insertions(+), 6 deletions(-) diff --git a/spring-boot-project/spring-boot-docs/src/main/asciidoc/howto.adoc b/spring-boot-project/spring-boot-docs/src/main/asciidoc/howto.adoc index 2eb692f14f..4b0120f19c 100644 --- a/spring-boot-project/spring-boot-docs/src/main/asciidoc/howto.adoc +++ b/spring-boot-project/spring-boot-docs/src/main/asciidoc/howto.adoc @@ -1308,12 +1308,22 @@ source for more details. [[howto-switch-off-the-spring-mvc-dispatcherservlet]] === Switch Off the Spring MVC DispatcherServlet -Spring Boot wants to serve all content from the root of your application (`/`) down. If -you would rather map your own servlet to that URL, you can do it. However, you may lose -some of the other Boot MVC features. To add your own servlet and map it to the root -resource, declare a `@Bean` of type `Servlet` and give it the special bean name, -`dispatcherServlet`. (You can also create a bean of a different type with that name if -you want to switch it off and not replace it.) +By default, All content is served from the root of your application (`/`) down. If you +would rather map to a different path, you can configure one as follows: + +[source,properties,indent=0,subs="verbatim"] +---- + server.servlet.path=/acme +---- + +If you have additional servlets you can declare a `@Bean` of type `Servlet` or +`ServletRegistrationBean` for each and Spring Boot will register them transparently to the +container. Because servlets are registered that way, they can be mapped to a sub-context +of the `DispatcherServlet` without invoking it. + +Configuring the `DispatcherServlet` yourself is unusual but if you really need to do it, a +`@Bean` of type `DispatcherServletPath` must be provided as well to provide the path of +your custom `DispatcherServlet`.