Skip to content

Welcome to the SingleJump Documentation

SingleJump is a secure SSH access and automation platform designed to help teams manage servers, execute commands across multiple devices, control user permissions, and maintain complete auditability of all operations.

This documentation provides a complete overview of how to configure, manage, and operate SingleJump.
Use the navigation menu on the left or the links below to explore each section.

📦 Setup

Start by configuring SingleJump for the first time:

  • Installation and initial configuration

Begin with the Auto Setup Guide or the Manual Setup Guide.

🚀 Get Started

Launch your SingleJump:

  • Database initialization
  • Requirements for SSL and Let’s Encrypt
  • Preparing your environment and users

Begin go to Get Started.

⚙️ Settings

Learn how to configure the core behavior of SingleJump:

  • Database initialization
  • General system limits
  • SSL and Let’s Encrypt
  • Security and Two-Factor Authentication

Go to Settings for more details.

🔒 ACLs

Access Control Lists define where and how users can access the system:

  • IP restrictions
  • Web or SSH access
  • Global or user-specific rules

Visit the ACLs page.

🧩 Device Groups

Organize devices into logical groups like Production, Dev, or QA, making management easier:

  • Group-based access
  • Environment segmentation
  • Efficient filtering

Explore Device Groups.

👤 Users

Manage user accounts and authentication:

  • Create new users
  • Assign roles
  • Enable 2FA
  • Control device group membership

See the Users section.

💻 Devices

Devices are the servers and machines you connect to using SSH:

  • Add or edit devices
  • Upload or generate keys
  • Test SSH connectivity
  • Assign devices to groups

Learn more in the Devices page.

🛡️ Roles

Roles define what users are allowed to do inside SingleJump:

  • Permissions for all resources
  • Page access
  • Widget visibility

Configure permissions in the Roles page.

⚡ Command Batches

Execute commands across many devices in parallel:

  • Launch commands
  • Set concurrency limits
  • View per-device output
  • Inspect batch history

Go to Command Batches.

🧭 Command Templates

Command Templates allow administrators to define safe, reusable commands that users can execute without needing SSH access. They help prevent command injection and ensure that every variable in a command is strictly validated.

Use Command Templates to:

  • Delegate operational tasks securely
  • Restrict user input with validation rules
  • Prevent command injection and unsafe characters
  • Run predefined commands across multiple devices

Learn more in the Command Templates page.

📜 Audits

Audits track all important actions in the system:

  • Device changes
  • User modifications
  • Settings updates

Review the full log in the Audits page.

🛫 Start Exploring

Use the menu or the links above to navigate through the documentation.
If you're setting up the system for the first time, begin with Setup and Settings before adding Devices, Users, and Roles.