Rundeck by PagerDuty is an open source runbook automation service with a web console, command line tools and a WebAPI. It lets you easily standardize tasks to improve operational quality by deploying automation across a set of nodes.
- [Visit the Website](https://www.rundeck.com)
- [Read the latest documentation](https://docs.rundeck.com/docs/)
- [Get help from the Community](https://community.pagerduty.com/ask-a-product-question-2)
- [Install Rundeck](https://docs.rundeck.com/docs/administration/install/installing-rundeck.html)
See the [Release Notes](https://docs.rundeck.com/docs/history/) for the latest version information.
# How To Build:
Primary build is supported with gradle. More info in the [wiki](https://github.com/rundeck/rundeck/wiki/Building-and-Testing).
Requirements: Java 11, NodeJs 18
## Build with Gradle
Produces: `rundeckapp/build/libs/rundeck-X.Y.war`
./gradlew build
## Docker Build
Uses the war artifact and creates the `rundeck/rundeck:SNAPSHOT` docker image:
```
./gradlew :docker:officialBuild
```
- `dockerTags` adds additional tags on the image
- - Ex: `-PdockerTags=local,local-RUN-123`
- `jreVersion=openjdk-17-jre-headless` specifies the JRE version for the image
- Ex: `-PjreVersion=openjdk-17-jre-headless`
## Run UI Tests
Run jest unit tests for Core UI
```shell
CORE_UI=rundeckapp/grails-spa/packages/ui-trellis
npm run --prefix "$CORE_UI" dev:test:unit
```
## Watch UI Tests
Run jest unit tests for Core UI and watch for changes
```shell
CORE_UI=rundeckapp/grails-spa/packages/ui-trellis
npm run --prefix "$CORE_UI" dev:test:watch
```
## Build UI in Dev Mode
Build the core UI components in dev mode, which copies the artifacts immediately to the
assets dir of the running application.
```shell
CORE_UI=rundeckapp/grails-spa/packages/ui-trellis
npm run --prefix "$CORE_UI" dev
```
# Documentation
Available online at
FAQ:
# Development
Refer to the [IDE Development Environment](https://github.com/rundeck/rundeck/wiki/IDE-Development-Environment) to get set up using IntelliJ IDEA or Eclipse/STS.
- [Issue tracker](https://github.com/rundeck/rundeck/issues) at github.com
Do you have changes to contribute? Please see the [Development](https://github.com/rundeck/rundeck/wiki/Development) wiki page.
# License
Copyright 2024 PagerDuty, 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.