Spring/spring-boot
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Add image banner documentation

Browse Source 
Closes gh-4647
This commit is contained in:
Phillip Webb
2016-04-07 23:10:48 -07:00
parent 43d1d92611
commit d058ddbe3b
3 changed files with 12 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
spring-boot-docs/src/main/asciidoc/appendix-application-properties.adoc
View File

@@ -31,6 +31,11 @@ content into your application; rather pick only the properties that you need.
# BANNER
banner.charset=UTF-8 # Banner file encoding.
banner.location=classpath:banner.txt # Banner file location.
banner.image.location=classpath:banner.gif # (Banner image file location, jpg/png can also be used).
banner.image.width= # Width of the banner image in chars (default 76)
banner.image.hight= # Height of the banner image in chars (default based on image height)
banner.image.margin= # Left hand image margin in chars (default 2)
banner.image.invert= # If images should be inverted for dark terminal themes (default false)
# LOGGING
logging.config= # Location of the logging configuration file. For instance `classpath:logback.xml` for Logback

6
spring-boot-docs/src/main/asciidoc/howto.adoc
View File

@@ -212,8 +212,8 @@ might have.
[source,properties,indent=0,subs="verbatim,quotes,attributes"]
----
spring.main.web_environment=false
spring.main.banner_mode=off
spring.main.web-environment=false
spring.main.banner-mode=off
----
and then the Spring Boot banner will not be printed on startup, and the application will
@@ -239,7 +239,7 @@ used with the following configuration:
[source,properties,indent=0,subs="verbatim,quotes,attributes"]
----
spring.main.sources=com.acme.Config,com.acme.ExtraConfig
spring.main.banner_mode=console
spring.main.banner-mode=console
----
The actual application will _now_ show the banner (as overridden by configuration) and use

5
spring-boot-docs/src/main/asciidoc/spring-boot-features.adoc
View File

@@ -52,8 +52,11 @@ such as the user that launched the application.
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 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.
You can use the following variables inside your `banner.txt` file:
Inside your `banner.txt` file you can use any of the following placeholders:
.Banner variables
|===