From 125483e7aa7d76b77ce0a0594db1993a6f1a1632 Mon Sep 17 00:00:00 2001 From: Andy Wilkinson Date: Wed, 20 Apr 2016 17:46:36 +0100 Subject: [PATCH] Add a note in the docs that default launch script only works on Linux Closes gh-5446 --- spring-boot-docs/src/main/asciidoc/deployment.adoc | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/spring-boot-docs/src/main/asciidoc/deployment.adoc b/spring-boot-docs/src/main/asciidoc/deployment.adoc index 329f36c19f..8417dada03 100644 --- a/spring-boot-docs/src/main/asciidoc/deployment.adoc +++ b/spring-boot-docs/src/main/asciidoc/deployment.adoc @@ -367,11 +367,8 @@ of this guide. [[deployment-install]] == Installing Spring Boot applications In additional to running Spring Boot applications using `java -jar` it is also possible -to make fully executable applications for Unix systems (Linux, OSX, FreeBSD etc). -This makes it very easy to install and manage Spring Boot applications in common -production environments. As long as you are generating '`fully executable`' jars from your -build, and you are not using a custom `embeddedLaunchScript`, the following techniques -can be used. +to make fully executable applications for Unix systems. This makes it very easy to install +and manage Spring Boot applications in common production environments. To create a '`fully executable`' jar with Maven use the following plugin configuration: @@ -401,6 +398,10 @@ NOTE: Fully executable jars work by embedding an extra script at the front of th Not all tools currently accept this format so you may not always be able to use this technique. +NOTE: The default script supports most Linux distributions and is tested on CentOS and +Ubuntu. Other platforms, such as OS X and FreeBSD, will require the use of a custom +`embeddedLaunchScript`. + NOTE: When a fully executable jar is run, it uses the jar's directory as the working directory.