README.md

@@ -1,5 +1,13 @@
# Rundeck

This is a Docker image of Rundeck (http://rundeck.org)
based on `debian:latest`

## Upgrading

Since version 3.0 /etc/rundeck/profile will be overriden!
To customize JVM options use environment variable:
`RDECK_JVM_SETTINGS`. See section "Configuration" below.

## Usage

@@ -8,7 +16,7 @@
```

Rundeck should be available at http://127.0.0.1:4440/
(user/password pairs: user/user and admin/admin)
(user/password pairs: `user`/`user` and `admin`/`admin`)

By default it uses H2 database and Docker data volumes
for storage persistence.
@@ -27,7 +35,7 @@

### Local volumes

You use local storage instead of data volumes:
You can use local storage instead of data volumes:

```bash
docker run -d --name=rundeck -p 4440:4440 \
@@ -61,7 +69,7 @@
```

Then set the following options in
/srv/rundeck/etc/rundeck-config.properties
`/srv/rundeck/etc/rundeck-config.properties`

```
dataSource.url = jdbc:mysql://rundeck-db/rundeck?autoReconnect=true
@@ -78,4 +86,21 @@
## Configuration

You can change Java system properties and JVM options by modifying
`RDECK_JVM` property in /etc/rundeck/profile (which is persisted).
`RDECK_JVM_SETTINGS` environment variable, which defaults to:

```
-Xmx1024m -Xms256m -XX:MaxMetaspaceSize=256m -server
```

Sample:

```
docker run -d --name=rundeck -p 4440:4440 \
   -v /srv/rundeck/etc:/etc/rundeck \
   -v /srv/rundeck/data:/var/lib/rundeck/data \
   -v /srv/rundeck/logs:/var/lib/rundeck/logs \
   -v /srv/rundeck/rundeck:/var/rundeck \
   -v /srv/rundeck/ssh:/var/lib/rundeck/.ssh \
   -e RDECK_JVM_SETTINGS="-Xms1024m -Xmx1024" \
   jacekkow/rundeck
```