Skip to content

Latest commit

 

History

History
131 lines (79 loc) · 3.76 KB

README.md

File metadata and controls

131 lines (79 loc) · 3.76 KB
Raw

Rundeck

Travis Deb RPM War
Travis CI Download Download Download

Rundeck is an open source automation service with a web console, command line tools and a WebAPI. It lets you easily run automation tasks across a set of nodes.

See the Release Notes for the latest version information.

To Build:

Primary build is supported with gradle. More info in the wiki.

Gradle Build

./gradlew build

Artifacts:

  • rundeckapp/build/libs/rundeck-X.Y.war

RPM and DEB package builds

To build .rpm and .deb packages, you must first clone the rundeck packaging repo into the rundeck repo. A sample list of simple build steps is below, where $RELEASE_VERSION is the version you want to build, i.e. 3.4.3

git clone https://github.com/rundeck/rundeck
cd rundeck
git checkout refs/tags/v$RELEASE_VERSION
git clone https://github.com/rundeck/packaging
./gradlew build -Penvironment=release
cd packaging

For 3.2.x builds, check out the maint-3.4.x branch of packaging

git checkout maint-3.4.x
mkdir -p artifacts
cp ../rundeckapp/build/libs/rundeck*.war artifacts/
./gradlew -PpackageRelease=$RELEASE_VERSION clean packageArtifacts

To build clean:

make clean

Installation

There are several install options: a self-contained war file, or RPM, or Debian.

To start from the rundeck-X.Y.war, put it in a directory named ~/rundeck, then execute:

java -Xmx1024m -Xms256m -XX:MaxMetaspaceSize=256m -server -jar rundeck-X.Y.war

If you'd like to install via RPM, you can use Yum:

rpm -Uvh http://repo.rundeck.org/latest.rpm
yum install rundeck

OR install directly from RPM:

rpm -ivh rundeck-2.0.0-xxx.rpm rundeck-config-2.0.0-xxx.rpm

Once the RPM is installed, execute:

sudo /etc/init.d/rundeckd start

The server should launch on port 4440, with default username/password of admin/admin.

For Debian, download the .deb from the downloads page, then run:

dpkg -i rundeck-2.0.0-x.deb
  • For more info and configuration information, see the Rundeck docs.

Requirements

Java 8 (openjdk, oracle)

Node JS 12

Documentation

Available online at https://docs.rundeck.com/docs

FAQ: https://github.com/rundeck/rundeck/wiki/FAQ

Development

Refer to the IDE Development Environment to get set up using IntelliJ IDEA or Eclipse/STS.

Do you have changes to contribute? Please see the Development wiki page.

License

Copyright 2020 Rundeck, Inc.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.