Installing Rundeck

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

Installation

TIP

Docker is fastest way to try out Rundeck

Quick Start

docker run --rm -it -p 4440:4440 rundeckpro/enterprise:3.4.10

Docker Compose

Check out the Docker Zoo (opens new window) for configuration examples in Docker Compose! These examples cover common configuration scenarios including connecting to each supported database.

Detailed Docker instructions can be found here.

Quick Install

curl https://raw.githubusercontent.com/rundeck/packaging/main/scripts/deb-setup.sh 2> /dev/null | sudo bash -s rundeckpro
sudo apt-get install rundeckpro-enterprise

Manual Install

Import the repo signing key:

curl -L https://packages.rundeck.com/pagerduty/rundeckpro/gpgkey | sudo apt-key add -

Add the following to /etc/apt/sources.list.d/rundeck.list replacing existing entries:

deb https://packages.rundeck.com/pagerduty/rundeckpro/any/ any main
deb-src https://packages.rundeck.com/pagerduty/rundeckpro/any/ any main

Update apt cache and install:

sudo apt-get update
sudo apt-get install rundeckpro-enterprise

Detailed deb instructions can be found here.

Quick Install

curl https://raw.githubusercontent.com/rundeck/packaging/main/scripts/rpm-setup.sh 2> /dev/null | sudo bash -s rundeckpro
sudo yum install java rundeckpro-enterprise

Manual Install

Remove bintray-rundeckpro-rpm.repo if it exists.

Add the following entries to /etc/yum.repos.d/rundeck.repo replacing any existing entries:

[rundeckpro]
name=rundeckpro
baseurl=https://packages.rundeck.com/pagerduty/rundeck/rpm_any/rpm_any/$basearch
repo_gpgcheck=1
gpgcheck=0
enabled=1
gpgkey=https://packages.rundeck.com/pagerduty/rundeck/gpgkey
sslverify=1
sslcacert=/etc/pki/tls/certs/ca-bundle.crt
metadata_expire=300

sudo yum install java rundeckpro-enterprise

Detailed rpm instructions can be found here.

Check here for detailed Tomcat installation instructions.

Check here for detailed Windows installation instructions.

#

Database Configuration

WARNING

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

TIP

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.

dataSource.url = jdbc:mysql://<host>/rundeck?autoReconnect=true&useSSL=false
dataSource.username = <rundeckuser>
dataSource.password = <rundeckpassword>
dataSource.driverClassName = org.mariadb.jdbc.Driver

Detailed MySQL instructions.

dataSource.driverClassName = org.postgresql.Driver
dataSource.url = jdbc:postgresql://<host>/rundeck
dataSource.username=<rundeckuser>
dataSource.password=<rundeckpassword>

Detailed PostgreSQL instructions.

dataSource.driverClassName = com.microsoft.sqlserver.jdbc.SQLServerDriver
dataSource.url = jdbc:sqlserver://<host>;DatabaseName=RUNDECK
dataSource.username = <rundeckuser>
dataSource.password = <rundeckpassword>

Detailed SQL Server instructions.

dataSource.url = jdbc:oracle:thin:@<host>:1521:orcl # (change server name and instance name)
dataSource.driverClassName = oracle.jdbc.OracleDriver
dataSource.username = <rundeckuser>
dataSource.password = <rundeckpassword>
dataSource.dialect = org.rundeck.hibernate.RundeckOracleDialect
dataSource.properties.validationQuery = SELECT 1 FROM DUAL

Detailed Oracle instructions.

Rundeck Configuration

Server URL

WARNING

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

Docker
Configuration file reference