# JumpServer

> An open-source PAM platform (Bastion Host)

## Docs

- [JumpServer Quickstart Guide](https://www.jumpserver.com/docs/quickstart.md): Install, sign in, orient yourself in Console, and complete your first asset connection and audit.
- [Installation](https://www.jumpserver.com/docs/installation.md): Install JumpServer Community Edition with the online one-line installer, or install JumpServer Enterprise Edition from an offline package.
- [Upgrade](https://www.jumpserver.com/docs/upgrade.md): Upgrade JumpServer Community Edition with the online installer, or upgrade JumpServer Enterprise Edition from an offline package.
- [Feature Overview](https://www.jumpserver.com/docs/features/index.md): Find the JumpServer workspace for setting up access, connecting to assets, or reviewing audit evidence.
- [General Overview](https://www.jumpserver.com/docs/features/general/index.md)
- [Dashboards](https://www.jumpserver.com/docs/features/general/dashboards.md): Understand the Console, PAM, and Audits dashboards and the metrics they summarize.
- [Workspace](https://www.jumpserver.com/docs/features/general/workspace/index.md): Switch organizations, search resources, and manage notifications and announcements.
- [Organizations](https://www.jumpserver.com/docs/features/general/workspace/organizations.md): Understand organization isolation, switch the active organization, and manage organization membership.
- [Global Search](https://www.jumpserver.com/docs/features/general/workspace/global-search.md): Use the global search panel to find users, groups, assets, accounts, and authorizations.
- [Notifications](https://www.jumpserver.com/docs/features/general/workspace/notifications.md): Read site messages and manage personal notification channels.
- [Announcements](https://www.jumpserver.com/docs/features/general/workspace/announcements.md): Configure and read the platform-wide announcement banner.
- [Account](https://www.jumpserver.com/docs/features/general/account/index.md): Manage your profile, credentials, access keys, tokens, passkeys, and preferences.
- [Profile](https://www.jumpserver.com/docs/features/general/account/profile.md): Manage your personal profile, authentication settings, notifications, and biometrics.
- [Password & SSH Key](https://www.jumpserver.com/docs/features/general/account/password-and-ssh-key.md): Change your login password and manage the SSH public key used to sign in to JumpServer.
- [Access Keys](https://www.jumpserver.com/docs/features/general/account/access-keys.md): Create and manage API access keys for signed requests to the JumpServer API.
- [Tokens](https://www.jumpserver.com/docs/features/general/account/tokens.md): Understand connection tokens and access tokens and how they are used for client connections.
- [Passkeys](https://www.jumpserver.com/docs/features/general/account/passkeys.md): Register and use passkeys as a passwordless MFA method.
- [Preferences](https://www.jumpserver.com/docs/features/general/account/preferences.md): Set your interface language, export encryption password, and Web terminal defaults.
- [Support](https://www.jumpserver.com/docs/features/general/support/index.md): Get help from the documentation and use the built-in AI assistant.
- [Help & Support](https://www.jumpserver.com/docs/features/general/support/help.md): Open the built-in help menu for documentation, support, and version information.
- [AI Assistant](https://www.jumpserver.com/docs/features/general/support/ai-assistant.md): Use the AI Assistant inside the Web Terminal and JumpServer Client to query assets, work with active sessions, and prepare operations.
- [Console Overview](https://www.jumpserver.com/docs/features/console/index.md): Browse Console documentation for users, groups, assets, accounts, authorizations, ACLs, and tags.
- [Console Dashboard](https://www.jumpserver.com/docs/features/console/dashboard.md): Monitor live sessions, user and asset statistics, activity trends, and login rankings on the Console Dashboard.
- [Users](https://www.jumpserver.com/docs/features/console/users/index.md): Create, invite, import, and manage JumpServer users, including MFA settings, user groups, login rules, and bulk operations.
- [Groups](https://www.jumpserver.com/docs/features/console/users/groups.md): Organize users into groups so that asset authorizations and account access can be managed at group level.
- [Assets](https://www.jumpserver.com/docs/features/console/assets/index.md): Organize, create, import, and maintain assets in JumpServer Console, including nodes, platforms, protocols, and account binding.
- [Zones](https://www.jumpserver.com/docs/features/console/assets/zones.md): Define network zones and gateways so JumpServer can reach assets that are not directly accessible.
- [Cloud Sync](https://www.jumpserver.com/docs/features/console/assets/cloud-sync.md): Import hosts and database instances from cloud platforms into JumpServer assets with cloud accounts, sync policies, and scheduled sync tasks.
- [Accounts](https://www.jumpserver.com/docs/features/console/accounts/index.md): Manage asset accounts and their credentials in JumpServer Console, including templates, secrets, discovery, and virtual accounts.
- [Account Templates](https://www.jumpserver.com/docs/features/console/accounts/templates.md): Create reusable account templates so that identical credentials can be added to many assets without repeated manual entry.
- [Policies](https://www.jumpserver.com/docs/features/console/policies/index.md): Control who can connect to which assets and which actions are allowed.
- [Authorizations](https://www.jumpserver.com/docs/features/console/policies/authorizations.md): Grant users and groups access to assets or nodes, and constrain the accounts, protocols, and actions they can use.
- [ACLs Overview](https://www.jumpserver.com/docs/features/console/policies/acls/index.md)
- [Command Filter](https://www.jumpserver.com/docs/features/console/policies/acls/command-filter.md): Block or control commands sent to assets during sessions by matching command groups against users, assets, and accounts.
- [User Login](https://www.jumpserver.com/docs/features/console/policies/acls/user-login.md): Audit and restrict JumpServer sign-in by source IP address and time period with global user login controls.
- [Asset Connect](https://www.jumpserver.com/docs/features/console/policies/acls/asset-connect.md): Restrict asset connections by user, asset, account, source IP, and time period with asset connect controls.
- [Data Masking](https://www.jumpserver.com/docs/features/console/policies/acls/data-masking.md): Mask sensitive columns in database query results by defining data masking rules for users, assets, and accounts.
- [Clipboard](https://www.jumpserver.com/docs/features/console/policies/acls/clipboard.md): Control copy and paste operations during asset connections and limit clipboard text and file transfer sizes.
- [Connect Method](https://www.jumpserver.com/docs/features/console/policies/acls/connect-method.md): Limit which connection methods users can use to reach assets, with global connect method controls.
- [Tags](https://www.jumpserver.com/docs/features/console/tags.md): Create tags and attach them to assets and other resources to make inventory easier to filter and manage.
- [PAM Overview](https://www.jumpserver.com/docs/features/pam/index.md)
- [PAM Dashboard](https://www.jumpserver.com/docs/features/pam/dashboard.md): Monitor account inventory, automation task activity, secret-change results, and account risk from the PAM Dashboard.
- [Accounts](https://www.jumpserver.com/docs/features/pam/accounts.md): Browse, filter, create, and template-manage the privileged accounts that JumpServer PAM protects.
- [Automation Overview](https://www.jumpserver.com/docs/features/pam/automation/index.md)
- [Discover Accounts](https://www.jumpserver.com/docs/features/pam/automation/discover-accounts.md): Collect the accounts that exist on managed assets, review them, and sync them into the JumpServer account inventory.
- [Push Accounts](https://www.jumpserver.com/docs/features/pam/automation/push-accounts.md): Create or update accounts on managed assets and set their secrets from a scheduled or on-demand push task.
- [Backup Accounts](https://www.jumpserver.com/docs/features/pam/automation/backup-accounts.md): Export the secrets of managed accounts by platform type and deliver encrypted backups by email or SFTP.
- [Security Overview](https://www.jumpserver.com/docs/features/pam/security/index.md)
- [Change Secrets](https://www.jumpserver.com/docs/features/pam/security/change-secrets.md): Rotate account passwords and SSH keys on managed assets with scheduled or on-demand change secret tasks.
- [Risk Detection](https://www.jumpserver.com/docs/features/pam/security/risk-detection.md): Scan managed account credentials for weak, repeated, and commonly leaked passwords, then review and resolve the results.
- [Integration Overview](https://www.jumpserver.com/docs/features/pam/integration/index.md)
- [Applications](https://www.jumpserver.com/docs/features/pam/integration/applications.md): Publish PAM account secrets to external systems through a scoped, IP-restricted REST API application.
- [Activities Overview](https://www.jumpserver.com/docs/features/pam/activities/index.md)
- [Account Sessions](https://www.jumpserver.com/docs/features/pam/activities/account-sessions.md): Review live and completed sessions opened with PAM-managed accounts, including playback and termination.
- [Account Activities](https://www.jumpserver.com/docs/features/pam/activities/account-activities.md): Audit who created, viewed, modified, or deleted PAM-managed accounts, with before-and-after change details.
- [Audits Overview](https://www.jumpserver.com/docs/features/audits/index.md)
- [Audits Dashboard](https://www.jumpserver.com/docs/features/audits/dashboard.md): Monitor login, session, command, file-transfer, and job activity for the selected organization and time range.
- [Sessions Overview](https://www.jumpserver.com/docs/features/audits/sessions/index.md)
- [Asset Sessions](https://www.jumpserver.com/docs/features/audits/sessions/asset-sessions.md): Review online and historical asset sessions, terminate active connections, replay recordings, and export session records.
- [Session Commands](https://www.jumpserver.com/docs/features/audits/sessions/session-commands.md): Inspect the commands users executed in asset sessions, including command output, risk level, and the related session.
- [File Transfer](https://www.jumpserver.com/docs/features/audits/sessions/file-transfer.md): Review file upload, download, delete, and rename records, and download retained files for investigation.
- [Online Devices](https://www.jumpserver.com/docs/features/audits/sessions/online-devices.md): View users currently signed in to JumpServer through the web interface and force logout selected devices.
- [Activities Overview](https://www.jumpserver.com/docs/features/audits/activities/index.md)
- [Login Logs](https://www.jumpserver.com/docs/features/audits/activities/login-logs.md): Review successful and failed JumpServer sign-ins, including authentication method, source, and failure reason.
- [Password Change Logs](https://www.jumpserver.com/docs/features/audits/activities/password-change-logs.md): Track password changes for JumpServer platform users, including who changed the password and from where.
- [Operate Logs](https://www.jumpserver.com/docs/features/audits/activities/operate-logs.md): Review changes to platform resources, inspect field-level before-and-after values, and export operation records.
- [Job Audits Overview](https://www.jumpserver.com/docs/features/audits/jobs/index.md)
- [Job Audits](https://www.jumpserver.com/docs/features/audits/jobs/job-audits.md): Review jobs created in Workbench Job Center, their execution cycle, creator, and periodic execution state.
- [Job Executions](https://www.jumpserver.com/docs/features/audits/jobs/job-executions.md): Review job run history, check completion and success, open execution output, and stop a running job.
- [Ticket Audits](https://www.jumpserver.com/docs/features/audits/tickets.md): Review ticket history for asset applications and login or command approvals, inspect ticket details, and export records.
- [Reports Overview](https://www.jumpserver.com/docs/features/audits/reports/index.md)
- [User Reports](https://www.jumpserver.com/docs/features/audits/reports/user-reports.md): Analyze user sign-in and password-change activity with report charts, trends, and rankings.
- [Asset Reports](https://www.jumpserver.com/docs/features/audits/reports/asset-reports.md): Analyze asset inventory, asset activity, login methods, protocols, and operating system distribution.
- [Account Reports](https://www.jumpserver.com/docs/features/audits/reports/account-reports.md): Analyze account inventory, connectivity, password changes, and account automation task results.
- [Workbench Overview](https://www.jumpserver.com/docs/features/workbench/index.md): The Workbench landing page, with recent sessions, pending approvals, your profile, and recent login activity.
- [My Assets](https://www.jumpserver.com/docs/features/workbench/my-assets/index.md): Browse authorized assets, transfer files, and manage personal credentials.
- [Access Assets](https://www.jumpserver.com/docs/features/workbench/my-assets/access-assets.md): Browse authorized assets in the Workbench, inspect allowed accounts, save favorites, and start a connection.
- [File Transfer](https://www.jumpserver.com/docs/features/workbench/my-assets/file-transfer.md): Upload local files to one or more authorized Linux assets from the Workbench and review the per-asset results.
- [Personal Credentials](https://www.jumpserver.com/docs/features/workbench/my-assets/personal-credentials.md): Store your own asset credentials, reuse them when connecting with manual input, and test or remove them from the Workbench.
- [Web Terminal Overview](https://www.jumpserver.com/docs/features/workbench/web-terminal/index.md): Use the browser-based Web Terminal to connect to authorized assets, manage sessions, and transfer files without installing a client.
- [Connect Assets](https://www.jumpserver.com/docs/features/workbench/web-terminal/connect-assets.md): Choose a protocol, account, and connection method in the Web Terminal, then manage the resulting session.
- [Web Terminal Settings](https://www.jumpserver.com/docs/features/workbench/web-terminal/settings.md): Configure Web Terminal language, character set, terminal behavior, resolution, theme, and appearance.
- [SSH Terminal](https://www.jumpserver.com/docs/features/workbench/ssh-terminal.md): Connect to JumpServer from a local SSH terminal and open authorized assets without the Web UI.
- [Job Center Overview](https://www.jumpserver.com/docs/features/workbench/job-center/index.md)
- [Adhoc](https://www.jumpserver.com/docs/features/workbench/job-center/adhoc.md): Run a command once across many authorized assets from the Job Center and review the combined output.
- [Jobs](https://www.jumpserver.com/docs/features/workbench/job-center/jobs.md): Create reusable script or Playbook jobs, run them on demand or on a schedule, and review their results.
- [Templates](https://www.jumpserver.com/docs/features/workbench/job-center/templates.md): Maintain reusable script and Playbook templates that Adhoc commands and jobs can reference.
- [Execution History](https://www.jumpserver.com/docs/features/workbench/job-center/execution-history.md): Review the Job Center executions you started, including command, task type, completion, success, and duration.
- [Tickets & Approvals Overview](https://www.jumpserver.com/docs/features/workbench/tickets/index.md)
- [My Tickets](https://www.jumpserver.com/docs/features/workbench/tickets/my-tickets.md): Submit access requests, track their approval progress, continue the conversation, and cancel tickets you no longer need.
- [Awaiting Approval](https://www.jumpserver.com/docs/features/workbench/tickets/awaiting-approval.md): Review tickets assigned to you as a handler, adjust the requested scope, and approve or reject requests.
- [Ticket Flow](https://www.jumpserver.com/docs/features/workbench/tickets/ticket-flow.md): Configure the approval flows that tickets use, including approval levels, handlers, and CC users.
- [Tools](https://www.jumpserver.com/docs/features/workbench/tools.md): Run Ping, Telnet, Nmap, and Traceroute diagnostics from JumpServer to check network reachability.
- [Client Overview](https://www.jumpserver.com/docs/features/client/index.md): JumpServer Client is a cross-platform desktop app for connecting to and managing authorized Windows, Linux, database, and web assets.
- [Installation](https://www.jumpserver.com/docs/features/client/installation.md): Download and install JumpServer Client for Windows, macOS, or Linux.
- [Connection Settings](https://www.jumpserver.com/docs/features/client/connection-settings.md): Configure JumpServer Client language, character set, terminal, display, appearance, and local application paths.
- [Asset Connection](https://www.jumpserver.com/docs/features/client/asset-connection.md): Connect to Linux, Windows, Kubernetes, database, and web assets from JumpServer Client.
- [Workspace, Files, and Scripts](https://www.jumpserver.com/docs/features/client/workspace.md): Organize client sessions with split views, work with files in the file workspace, reuse scripts, and open SFTP Server connections.
- [Recording Tools](https://www.jumpserver.com/docs/features/client/tools.md): Play downloaded JumpServer session recordings and transcode recording archives to MP4.
- [System Settings Overview](https://www.jumpserver.com/docs/features/system-settings/index.md)
- [General Settings](https://www.jumpserver.com/docs/features/system-settings/general/index.md): Configure the site, organizations, roles, platforms, notifications, and feature switches.
- [Basic Settings](https://www.jumpserver.com/docs/features/system-settings/general/basic.md): Set the public site URL and the navigation links that JumpServer uses in generated links and in the top navigation bar.
- [Organizations](https://www.jumpserver.com/docs/features/system-settings/general/organizations.md): Create isolated organizations and work inside each one to manage its own users, assets, accounts, and authorizations.
- [Roles](https://www.jumpserver.com/docs/features/system-settings/general/roles.md): Understand built-in and custom roles, their permissions, and how role management differs between Community and Enterprise editions.
- [Platforms](https://www.jumpserver.com/docs/features/system-settings/general/platforms.md): Review built-in asset platforms and create custom platforms that define protocols, encoding, account switching, and automation defaults.
- [Notifications](https://www.jumpserver.com/docs/features/system-settings/general/notifications.md): Configure the outgoing email service, SMS verification, and the recipients and channels used for platform alerts.
- [Features](https://www.jumpserver.com/docs/features/system-settings/general/features.md): Enable and configure optional platform capabilities: announcements, tickets, the job center, account storage, SSH certificate issuance, the AI assistant, and VirtualApp.
- [Security Settings](https://www.jumpserver.com/docs/features/system-settings/security/index.md): Configure authentication and platform security policies.
- [Authentication](https://www.jumpserver.com/docs/features/system-settings/security/authentication.md): Choose how users sign in to JumpServer: local accounts, directory services, single sign-on protocols, social identity providers, or passkeys.
- [Security](https://www.jumpserver.com/docs/features/system-settings/security/security.md): Harden user sign-in, passwords, and asset sessions with authentication limits, MFA policy, password rules, and session controls.
- [Infrastructure](https://www.jumpserver.com/docs/features/system-settings/infrastructure/index.md): Manage storage, components, RemoteApp, system tasks, and device management.
- [Storage](https://www.jumpserver.com/docs/features/system-settings/infrastructure/storage.md): Configure object storage for session recordings and command storage for session command logs, including defaults and connectivity tests.
- [Components](https://www.jumpserver.com/docs/features/system-settings/infrastructure/components.md): Configure terminal components, review registered components and their load, and define the service endpoints used to reach assets.
- [RemoteApp](https://www.jumpserver.com/docs/features/system-settings/infrastructure/remote-app.md): Publish Windows applications through RemoteApp machines and Linux applications through VirtualApp, and manage the providers that run them.
- [System Tasks](https://www.jumpserver.com/docs/features/system-settings/infrastructure/system-tasks.md): Review scheduled automation, inspect task history and worker health, and configure retention for logs, records, and session evidence.
- [Device Manager](https://www.jumpserver.com/docs/features/system-settings/infrastructure/device-manager.md): Open the JDMC operations console to manage the server that hosts JumpServer, including network, disk, license, high availability, and container operations.
- [Appearance & Tools](https://www.jumpserver.com/docs/features/system-settings/appearance-tools/index.md): Customize the interface and use system maintenance tools.
- [Appearance](https://www.jumpserver.com/docs/features/system-settings/appearance-tools/appearance.md): Customize the login page title, theme, logos, login image, and footer to match your organization's brand.
- [System Tools](https://www.jumpserver.com/docs/features/system-settings/appearance-tools/tools.md): Run network diagnostics such as ping, telnet, nmap, tcpdump, and traceroute from the JumpServer server to validate connectivity to assets.
- [License](https://www.jumpserver.com/docs/features/system-settings/license.md): View the edition and licensed asset count of this deployment and import an enterprise license file.
- [Role Guides](https://www.jumpserver.com/docs/roles/index.md)
- [Role Model](https://www.jumpserver.com/docs/roles/role-model.md): Understand the difference between system roles and organization roles, the default built-in roles, and how effective permissions are combined.
- [Administrator Guide](https://www.jumpserver.com/docs/roles/administrator.md): Understand System Admin and Organization Admin roles and the JumpServer features each role can use.
- [Operator Guide](https://www.jumpserver.com/docs/roles/operator.md): Understand System Operator and Organization Operator roles and the Workbench features operators use.
- [Auditor Guide](https://www.jumpserver.com/docs/roles/auditor.md): Understand System Auditor and Organization Auditor roles and the Audits evidence each role can review.
- [Operations Overview](https://www.jumpserver.com/docs/operations/index.md): Plan, deploy, secure, and maintain a JumpServer installation.
- [Architecture](https://www.jumpserver.com/docs/operations/architecture.md): Understand the JumpServer layered architecture, its protocol components, and how a request flows from the browser to the target asset.
- [Deployment Topologies](https://www.jumpserver.com/docs/operations/deployment-topologies.md): Choose between a single-node, two-node high-availability, and fully distributed JumpServer deployment topology.
- [Configuration](https://www.jumpserver.com/docs/operations/configuration.md): Understand the JumpServer config.txt configuration file, the main setting groups, and how to apply changes safely.
- [Network Ports](https://www.jumpserver.com/docs/operations/network-ports.md): Reference the network ports JumpServer components use, and open them in the host firewall before deployment.
- [Backup & Restore](https://www.jumpserver.com/docs/operations/backup-restore.md): Back up and restore the JumpServer database and static files, and understand the constraints when moving data between environments.
- [Command-Line Tools](https://www.jumpserver.com/docs/operations/cli-tools.md): Use the jmsctl management script and its configuration helper to install, start, stop, back up, restore, and inspect JumpServer services.
- [Upgrade & Maintenance](https://www.jumpserver.com/docs/operations/upgrade-maintenance.md): Plan a JumpServer upgrade, follow the supported version path, and keep an installation healthy with routine maintenance tasks.
- [Enable HTTPS](https://www.jumpserver.com/docs/operations/enable-https.md): Configure HTTPS for JumpServer with your own certificate, update config.txt, and restart the service.
- [Security Hardening](https://www.jumpserver.com/docs/operations/security-hardening.md): Harden a JumpServer deployment by reducing network exposure, enabling TLS, protecting secrets, enforcing MFA and least privilege, and retaining audit evidence.
- [Troubleshooting](https://www.jumpserver.com/docs/operations/troubleshooting.md): Diagnose common JumpServer operational problems using service status, component logs, health endpoints, and the audit trail.
- [Device Manager](https://www.jumpserver.com/docs/operations/device-manager.md): Use Device Manager (JDMC) to monitor and maintain the server and containers that run JumpServer.
- [Developer Guide Overview](https://www.jumpserver.com/docs/developer-guide/index.md): Use the JumpServer REST API and integration surfaces.
- [REST API](https://www.jumpserver.com/docs/developer-guide/rest-api.md): Use the JumpServer REST API: authentication methods, organization context, pagination, permissions, and the generated API reference.
- [Integrations](https://www.jumpserver.com/docs/developer-guide/integrations.md): Connect JumpServer to external systems through the REST API, notification channels, Syslog, and PAM integration applications.
- [What's new in V5](https://www.jumpserver.com/docs/reference/whats-new.md): Highlights of JumpServer V5 versions, with links to the documentation for each new or changed capability.
- [Changelog](https://www.jumpserver.com/docs/reference/changelog.md): Release notes for each JumpServer V5 version, including new features, improvements, bug fixes, and security changes.
- [Community vs Enterprise](https://www.jumpserver.com/docs/reference/compare-editions.md): Compare JumpServer Community Edition and Enterprise Edition features, scales, authentication methods, and support options.
- [Import license](https://www.jumpserver.com/docs/reference/license.md): Import a JumpServer Enterprise Edition license and verify that licensed features are activated.
- [Glossary](https://www.jumpserver.com/docs/reference/glossary.md): Definitions of the core JumpServer terms: organization, asset, account, node, zone, authorization, ACL, PAM, session, audit, ticket, job, client, and component.
- [Reference](https://www.jumpserver.com/docs/reference/index.md): Version history, edition comparison, license, and glossary.