Skip to content

Commit c860dc4

Browse files
fdevansfdevans
committed
default file fixups
1 parent cbcf367 commit c860dc4

File tree

4 files changed

+227
-5
lines changed

4 files changed

+227
-5
lines changed

‎docs/.vuepress/sidebar-menus/administration.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -209,8 +209,9 @@ export default [{
209209
{
210210
text: 'Security',
211211
collapsible: true,
212-
link: '/administration/security/default-users',
212+
link: '/administration/security/',
213213
children: [
214+
'/administration/security/',
214215
'/administration/security/default-users',
215216
'/administration/security/authentication',
216217
'/administration/security/authorization',
@@ -228,7 +229,6 @@ export default [{
228229
]
229230
},
230231
'/administration/security/webapp-http-headers',
231-
'/administration/security/project-acl',
232232
'/administration/security/password-security',
233233
'/administration/security/ratelimiting',
234234
'/administration/security/blocklist',

‎docs/administration/index.md‎

Lines changed: 50 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,53 @@
11
# Administrator Guide
22

3-
This the Rundeck Administration Guide.
3+
This is the Rundeck Administration Guide covering installation, configuration, security, and maintenance of Rundeck and Runbook Automation.
44

5-
For information about using Rundeck, see the [User Manual](/manual/03-getting-started.md).
5+
For information about using Rundeck, see the [User Manual](/manual/).
6+
7+
## Installation
8+
9+
Get Rundeck up and running on your preferred platform. Choose from RPM/DEB packages, Docker containers, JAR installation, AWS deployment, or build from source.
10+
11+
[View Installation Guide →](/administration/install/)
12+
13+
## Upgrading
14+
15+
Upgrade your Rundeck installation to the latest version. Includes version-specific upgrade guides and best practices.
16+
17+
[View Upgrading Guide →](/upgrading/)
18+
19+
## Licensing
20+
21+
Manage your Rundeck Enterprise or Process Automation licenses, including installation and activation.
22+
23+
[View Licensing Guide →](/administration/license)
24+
25+
## Enterprise Runner
26+
27+
Deploy and manage Enterprise Runners for distributed job execution. Runners enable secure, scalable execution across multiple environments without requiring SSH access.
28+
29+
[View Runner Guide →](/administration/runner/)
30+
31+
## Configuration
32+
33+
Configure Rundeck to meet your needs including database setup, Docker configuration, email settings, GUI customization, plugin management, and more.
34+
35+
[View Configuration Guide →](/administration/configuration/)
36+
37+
## Maintenance
38+
39+
Keep Rundeck running smoothly with guidance on startup, logging, backups, and performance tuning.
40+
41+
[View Maintenance Guide →](/administration/maintenance/)
42+
43+
## Clustering
44+
45+
Set up Rundeck in a clustered environment for high availability and load balancing, including log storage and automatic takeover configuration.
46+
47+
[View Clustering Guide →](/administration/cluster/)
48+
49+
## Security
50+
51+
Secure your Rundeck installation with authentication, authorization, SSL/TLS, SSO integration, access control policies, and audit trails.
52+
53+
[View Security Guide →](/administration/security/default-users)

‎docs/administration/security/index.md‎

Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
# Security
2+
3+
This guide covers security configuration for Rundeck and Runbook Automation, including authentication, authorization, SSL/TLS, and audit capabilities.
4+
5+
## Default Users
6+
7+
Learn about the default admin user account and initial security setup when first installing Rundeck.
8+
9+
[View Default Users →](/administration/security/default-users)
10+
11+
## Authentication
12+
13+
Configure how users authenticate to Rundeck including LDAP, Active Directory, PAM, and other authentication providers.
14+
15+
[View Authentication →](/administration/security/authentication)
16+
17+
## Authorization
18+
19+
Set up access control and permissions using Rundeck's Access Control List (ACL) system to control what users can see and do.
20+
21+
[View Authorization →](/administration/security/authorization)
22+
23+
## ACL Policy Editor
24+
25+
Use the web-based ACL Policy Editor to create and test access control policies with a guided interface.
26+
27+
[View ACL Policy Editor →](/administration/security/acl-policy-editor)
28+
29+
## SSL/TLS Configuration
30+
31+
Configure SSL/TLS encryption for secure HTTPS communication, including certificate setup and cipher configuration.
32+
33+
[View SSL Configuration →](/administration/security/ssl)
34+
35+
## Single Sign-On (SSO)
36+
37+
Integrate Rundeck with enterprise SSO providers including Azure AD, Okta, and Ping Identity for seamless authentication.
38+
39+
[View SSO Configuration →](/administration/security/sso/)
40+
41+
## HTTP Security Headers
42+
43+
Configure HTTP security headers to protect against common web vulnerabilities and enhance browser security.
44+
45+
[View HTTP Headers →](/administration/security/webapp-http-headers)
46+
47+
## Project-Level ACLs
48+
49+
Configure access control policies at the project level to manage permissions for specific projects.
50+
51+
[View Project ACLs →](/administration/security/project-acl)
52+
53+
## Password Security
54+
55+
Enhance password security with configuration options for password hashing, encryption, and secure credential handling.
56+
57+
[View Password Security →](/administration/security/password-security)
58+
59+
## Rate Limiting
60+
61+
Protect your Rundeck instance from abuse by configuring rate limiting for API requests and user actions.
62+
63+
[View Rate Limiting →](/administration/security/ratelimiting)
64+
65+
## IP Blocklist
66+
67+
Restrict access to Rundeck by blocking specific IP addresses or ranges using the built-in blocklist feature.
68+
69+
[View Blocklist →](/administration/security/blocklist)
70+
71+
## Audit Trail
72+
73+
Track user actions and system events with Rundeck's audit logging capabilities for compliance and troubleshooting.
74+
75+
[View Audit Trail →](/administration/security/audit-trail)
76+
77+
## Audit Stream Plugin
78+
79+
Integrate Rundeck's audit events with external logging and SIEM systems using the audit stream plugin framework.
80+
81+
[View Audit Stream Plugin →](/administration/security/audit-stream-plugin)
82+

‎docs/manual/index.md‎

Lines changed: 93 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,95 @@
11
# User Guide Overview
22

3-
This User Guide section provides details about the usage of the Rundeck Product for automation authors.
3+
This User Guide provides comprehensive information for automation authors and users of Rundeck and Runbook Automation.
4+
5+
For information about installing and administering Rundeck, see the [Administration Guide](/administration/).
6+
7+
## Projects
8+
9+
Create and manage projects, configure SCM integration, set up resource model sources, and configure node execution methods. Projects are the foundation for organizing your automation work.
10+
11+
[View Projects Guide →](/manual/projects/)
12+
13+
## Jobs
14+
15+
Create and manage automation jobs with workflows, options, notifications, and hundreds of plugin integrations. Jobs are the core automation units in Rundeck.
16+
17+
[View Jobs Guide →](/manual/jobs/)
18+
19+
## Plugins
20+
21+
Explore Rundeck's extensive plugin ecosystem including integrations with AWS, Azure, GCP, Kubernetes, Datadog, Jira, PagerDuty, ServiceNow, and many more platforms.
22+
23+
[View Plugins Overview →](/manual/plugins/)
24+
25+
## Nodes
26+
27+
Manage your infrastructure nodes, configure node filters, set up health checks, and use node enhancers to enrich node data.
28+
29+
[View Nodes Guide →](/manual/05-nodes)
30+
31+
## Key Storage
32+
33+
Securely store and manage passwords, private keys, and other sensitive data using Rundeck's built-in key storage or integrations with AWS Secrets Manager, Azure Key Vault, HashiCorp Vault, CyberArk, and Delinea.
34+
35+
[View Key Storage Guide →](/manual/key-storage/)
36+
37+
## Commands
38+
39+
Execute ad-hoc commands across your nodes directly from the Rundeck interface.
40+
41+
[View Commands Guide →](/manual/06-commands)
42+
43+
## Activity
44+
45+
Monitor job executions, view execution history, and analyze automation activity across your projects.
46+
47+
[View Activity Guide →](/manual/08-activity)
48+
49+
## Schedules (Commercial)
50+
51+
Manage project-level schedules and configure job scheduling policies for Rundeck Enterprise and Process Automation.
52+
53+
[View Schedules Guide →](/manual/schedules/project-schedules)
54+
55+
## Calendars (Commercial)
56+
57+
Define blackout windows and maintenance calendars to control when jobs can execute in Rundeck Enterprise and Process Automation.
58+
59+
[View Calendars Guide →](/manual/calendars)
60+
61+
## Webhooks
62+
63+
Configure incoming webhooks to trigger jobs from external systems like GitHub, PagerDuty, Datadog, AWS SNS, and more.
64+
65+
[View Webhooks Guide →](/manual/webhooks)
66+
67+
## Project Settings
68+
69+
Configure project-level settings including defaults, integrations, and behavior.
70+
71+
[View Project Settings →](/manual/project-settings)
72+
73+
## System Menu
74+
75+
Access system-wide configurations, user management, and system reports.
76+
77+
[View System Menu Guide →](/manual/system-configs)
78+
79+
## Profile Menu
80+
81+
Manage your user profile, preferences, and personal settings.
82+
83+
[View Profile Menu →](/manual/10-user.md)
84+
85+
## Integrations
86+
87+
Connect Rundeck with external platforms and services for enhanced automation workflows.
88+
89+
[View Integrations →](/manual/integrations/)
90+
91+
## Document Formats
92+
93+
Reference documentation for Rundeck's file formats including ACL policies, job definitions, and resource models.
94+
95+
[View Document Formats →](/manual/document-format-reference/)

0 commit comments

Comments
 (0)