23.2 Customizing the Banner
The banner that is printed on start up can be changed by adding a banner.txt file to your classpath, or by setting banner.location to the location of such a file. If the file has an unusual encoding you can set banner.charset (default is UTF-8). In addition to a text file, you can also add a banner.gif, banner.jpg or banner.png image file to your classpath, or set a banner.image.location property. Images will be converted into an ASCII art representation and printed above any text banner.
Inside your banner.txt file you can use any of the following placeholders:
Table 23.1. Banner variables
| Variable | Description |
|---|---|
${application.version} |
The version number of your application as declared in MANIFEST.MF. For example Implementation-Version: 1.0 is printed as 1.0. |
${application.formatted-version} |
The version number of your application as declared in MANIFEST.MF formatted for display (surrounded with brackets and prefixed with v). For example (v1.0). |
${spring-boot.version} |
The Spring Boot version that you are using. For example 1.4.1.BUILD-SNAPSHOT. |
${spring-boot.formatted-version} |
The Spring Boot version that you are using formatted for display (surrounded with brackets and prefixed with v). For example (v1.4.1.BUILD-SNAPSHOT). |
${Ansi.NAME} (or ${AnsiColor.NAME}, ${AnsiBackground.NAME}, ${AnsiStyle.NAME}) |
Where NAME is the name of an ANSI escape code. See AnsiPropertySource for details. |
${application.title} |
The title of your application as declared in MANIFEST.MF. For example Implementation-Title: MyApp is printed as MyApp. |
![[Tip]](Spring Boot Reference Guide_files/tip.png) |
Tip |
|---|---|
The SpringApplication.setBanner(…) method can be used if you want to generate a banner programmatically. Use the org.springframework.boot.Banner interface and implement your own printBanner() method. |
You can also use the spring.main.banner-mode property to determine if the banner has to be printed on System.out (console), using the configured logger (log) or not at all (off).
The printed banner will be registered as a singleton bean under the name springBootBanner.
![[Note]](Spring Boot Reference Guide_files/note.png) |
Note |
|---|---|
YAML maps off to false so make sure to add quotes if you want to disable the banner in your application. |