Docs
Quickstart

Quickstart Guide

Try out the features of JumpServer in 10 minutes or less.


Introduction

JumpServer is an open-source PAM tool (Bastion Host) that provides efficient and secure asset management and operation auditing capabilities. This guide will walk you through the quick installation and deployment of JumpServer, as well as basic operations such as creating users, assets, and authorizations, user login, connecting to assets, and auditing sessions and login logs.

Installing and Deploying

How to install JumpServer please refer to the Installation Docs.

Administrator Login

You have successfully installed JumpServer. You can now access the JumpServer service using your web browser by navigating to http://your-jumpserver-ip/. For the best experience, we recommend using Google Chrome.

Please log in using the default administrator credentials:

  • Username: admin
  • Password: ChangeMe

Login

Upon your first login, you will be prompted to change your password. Simply make the change and log in again.

Create User

After logging in to JumpServer, let's create a user first:

  1. Navigate to the Console and access the User Management page.

Console User

  1. Click the +Create button.

  2. Fill in the user information.

  • Name: First User
  • Username: first_user
  • Email: first-user@example.com
  • Password setting: Set Password, and enter pwd@123

Please keep the other information at their default values.

Create User

  1. Click "Submit" to complete the user creation.

Create Asset

Next, let's create an Linux asset:

  1. Navigate to the Asset Management page.

  2. Switch to the Host tab, and click the +Create button. In the popup window, select the built-in Linux platform to open the host creation page.

Nav Asset

  1. Fill in the asset information.
  • Name: First Asset
  • IP/Host: 172.17.200.27
  • Platform: Linux
  • Nodes: /Default
  • Protocols: ssh/22, sftp/22

To Ensure Successful Connection in the Following Steps, please enter the correct IP/Host and SSH protocol port.

Create Asset

  1. Add an account to the asset.

Click the Add button in the Accounts section to add an account. In the popup window, enter the correct Name, Username, and Password. Keep the other information as default. Click Confirm to complete the account addition.

  • Name: root
  • Username: root
  • Password: your-password

Create Asset

  1. Click Submit to complete the asset creation.

Create Authorization

Finally, let's create an authorization.

  1. Navigate to the Authorization Management page.

Nav Authorization

  1. Click the +Create button.

  2. Fill in the authorization information.

  • Name: First Authorization
  • Users: Select First User
  • Assets: Select First Linux

Keep the other information as default.

Create Authorization

  1. Click "Submit" to complete the authorization creation.

User Login

Excellent, we have successfully created one user and one asset, and authorized the asset for the user. Next, let's proceed to log in to JumpServer using the user First User.

  1. To log in simultaneously with both the Administrator and First User, please open a new browser window in incognito mode.

  2. After logging in with the username first_user and password pwd@123, you will be prompted to reset your password. Simply follow the steps to reset your password, and then log in again using the new password.

  3. After successfully logging in, you will see a page to complete personal information. Check "I agree" and click Submit.

Complete Personal Info

  1. Navigate to the Workbench > Access assets page, where you can view the assets authorized to you. Here, you will see that the asset named First Linux has been authorized to you.

Workbench Asset

Simply click the Connect button here to access the asset.

Access Asset

After clicking the asset connection button, a new tab (Web Terminal) will open in your current browser, and the connection information for logging into the asset will also be displayed.

  1. Confirm the connection information: select root as the account and choose "Web CLI" as the connection method.

Connect Asset

  1. Click the CONNECT button to log in to the asset.

  2. Congratulations, you have successfully accessed the assets you have permission to use.

Connect Asset Finished

Audit logs

Next, while keeping the current user's asset session active, let's switch to the Administrator page. Navigate to the Audits to review the actions performed by the current user.

  1. Navigate to the Audits > Asset sessions page.

We observe that there is a session where the First User is connected to the First Linux asset using the root account.

Asset sessions

  1. Navigate to the Audits > Session commands page, we can view the commands executed by the user.

Session commands

  1. Navigate to the Audits > Login logs page, We can view detailed login logs for the user.

Login Logs

Congratulations! Following this guide, you should have successfully installed JumpServer, created users and assets, authorized access, and learned to connect to assets and audit logs.

Next Steps

Regarding more advanced features of JumpServer, it's your turn to explore!

JumpServer documentation is continually being updated. Please stay tuned for more details.