# Installing Rundeck

  1. Review the system requirements
  2. Install Rundeck with chosen method
  3. Configure database
  4. Configure Rundeck

# Installation


Docker is fastest way to try out Rundeck


# Database Configuration


Rundeck will initialize an on-disk database using the embedded H2 database on first start using the stock configurations. Production installations of Rundeck running H2 are not supported! Choose a supported database below to configure a production installation.

# Edit Database Config


The Rundeck database(or schema) should be setup in advance. The following assumes the database is named rundeck.

Update your rundeck-config.properties file with settings from the following database list and restart Rundeck. This file is located in different locations depending on your installation method:

  • RPM/DEB: /etc/rundeck/rundeck-config.properties
  • WAR/Custom: $RDECK_BASE/server/config/rundeck-config.properties
  • Docker: Check out the Docker Zoo (opens new window) for configuration examples of each database using Docker Compose!

Replace the following tokens in the instructions for each database:

  • <host>: The database server hostname.
  • <rundeckuser>: The database user with permissions on the rundeck database.
  • <rundeckpassword>: The password for the Rundeck database user.


When using passwords with special characters, ensure there are no spaces between the equal sign and the value provided: dataSource.password=<rundeckpassword>

# Rundeck Configuration

# Server URL


The configuration option grails.serverUrl must be set properly. The value should match the URL users would use to access Rundeck(ie the URL they would enter into the browser).

For Docker this should be configured with the RUNDECK_GRAILS_URL environment variable.

For deb, rpm, and war this will be set as grails.serverUrl= in the rundeck-config.properties file.

# Configuration Reference

Configuration file reference

Last Updated: 12/22/2022, 10:41:39 PM