Skip to content
This repository has been archived by the owner on Feb 12, 2022. It is now read-only.

Commit

Permalink
Update readme [skip ci]
Browse files Browse the repository at this point in the history
  • Loading branch information
jkutner committed Feb 24, 2016
1 parent adb9006 commit c9acdf4
Showing 1 changed file with 29 additions and 24 deletions.
53 changes: 29 additions & 24 deletions README.md
Expand Up @@ -88,6 +88,8 @@ Use the following command to open the application on the browser:

### Customizing your deployment

#### Include Files

You can include additional files in your slug with the `--includes` option.

```
Expand All @@ -96,6 +98,33 @@ heroku deploy:war --war myapp.war --includes newrelic.jar:newrelic.xml

The character separating the included files is platform specific, just like [File.pathSeparator](http://docs.oracle.com/javase/8/docs/api/java/io/File.html#pathSeparator). On Windows it will be `;` (semi-colon) and on Mac and Linux it will be `:` (colon).

#### Configure Tomcat Options

You can configure how the WAR file executes on the server by setting the
WEBAPP_RUNNER_OPTS configuration variable on your application. For example,
you might set the following option:

```term
$ heroku config:set WEBAPP_RUNNER_OPTS="--uri-encoding=UTF-8"
```

The `heroku-deploy` plugin uses Tomcat Webapp Runner as a container for the
WAR file. Thus, all Webapp Runner options are available to the app. A full list
options is described in the
[Webapp Runner documentation](https://github.com/jsimone/webapp-runner#options).

#### Configure Java Options

You can also configure the underlying JVM that runs the Tomcat container by
setting the JAVA_OPTS configuration variable. For example, you set the
following option:

```term
$ heroku config:set JAVA_OPTS="-Xss512k"
```

However, [the Heroku platform will select a good set of defaults](https://devcenter.heroku.com/articles/java-support#environment) for you.

## Executable JAR Files

You can also use this tool to deploy executable JAR files. To do so, run a command like this:
Expand Down Expand Up @@ -123,27 +152,3 @@ web: java -cp my-uberjar.jar com.foo.MyMain opt1 opt2

You can view your current Procfile command by running `heroku ps`.

## Configuration

You can configure how the WAR file executes on the server by setting the
WEBAPP_RUNNER_OPTS configuration variable on your application. For example,
you might set the following option:

```term
$ heroku config:set WEBAPP_RUNNER_OPTS="--uri-encoding=UTF-8"
```

The `heroku-deploy` plugin uses Tomcat Webapp Runner as a container for the
WAR file. Thus, all Webapp Runner options are available to the app. A full list
options is described in the
[Webapp Runner documentation](https://github.com/jsimone/webapp-runner#options).

You can also configure the underlying JVM that runs the Tomcat container by
setting the JAVA_OPTS configuration variable. For example, you set the
following option:

```term
$ heroku config:set JAVA_OPTS="-Xss512k"
```

However, [the Heroku platform will select a good set of defaults](https://devcenter.heroku.com/articles/java-support#environment) for you.

0 comments on commit c9acdf4

Please sign in to comment.