Guides
Quickstart

Quickstart for JumpServer

This topic walks you through JumpServer’s features quickly and efficiently, helping you try them out in 10 minutes or less.

Introduction

For more information about JumpServer, see Introduction to JumpServer.

Next, we will complete the following steps: prerequisites, creating an asset, authorizing the asset to the Administrator, connecting to the asset via the web as the Administrator, and auditing sessions and commands.

You can watch the video below or follow the steps to quickly get started.

Prerequisites

Before starting, please install JumpServer, and log in as an Administrator. For more information, see JumpServer installation guide.

Creating an asset

1
On the left side of the page, hover over the , and click Console.image
2

Navigate to Console > Assets > Host tab.

3

Click Create to open the platform selection page on the right side.

4

Select the Linux platform and open the asset creation page.

5

In the Name field, type a name for the asset, such as "Demo Linux".

6

In the IP/Host field, type the IP address of the asset, such as "172.16.10.110".

7

In the Linux field, keep the "Linux" platform selected.

8

In the Nodes field, select the "/DEFAULT" node.

9

In the Accounts field, click the Add and follow the steps in the pop-up to complete the account creation.

1

In the Name field, type a name for the account, such as "root".

2

In the Username field, type the username for the account, such as "root".

3

In the Secret type field, select "Password".

4

In the Password field, type the password for the account.

5

For other fields, keep the default values.

6

click Confirm.

10

For other fields, keep the default values.

11

Click Submit.

Authorizing asset for admin

1
On the left side of the page, hover over the , and click Console.image
2

Navigate to Console > Authorization page.

3

Click Create to open the authorization creation form on the right-side page.

4

In the Name field, type a name for the authorization, such as "Authorize Demo Linux to Administrator".

5

In the Users field, select the "Administrator(admin)".

6

In the Assets field, select the "Demo Linux".

7

In the Accounts field, check only the box for "All existing accounts".

8

For other fields, keep the default values.

9

Click Submit.

Connecting to asset via web

1
In the upper-right corner of any page in JumpServer, click .image
2

At this point, the Web Terminal page should be open in a new browser tab.

In the authorization tree on the left side, search for and click the "Demo Linux" asset.

3

An asset connection pop-up will appear, select connection parameters and establish the connection.

1

Select the "SSH" tab, under the "Connect - Demo Linux".

2

In the Select account section, Select "root".

3

In the Connect method section, Select "Web > Web CLI".

4

Click CONNECT.

4

By this time, you should have successfully connected to the asset.

5

Next, you can try executing commands such as ls -al, whoami or pwd, etc.

6

Finally, run exit to end the current session.

Auditing connected sessions

1
On the left side of the page, hover over the , and click Audits.image
2

Navigate to Audits > Asset sessions > Historical sessions tab.

3

You can view the history of asset connection sessions.

4

In the Actions column, click "Playback" to watch the recording online or "Download" to save it.

Auditing executed commands

1
On the left side of the page, hover over the , and click Audits.image
2

Navigate to Audits > Session commands page.

3

You can view all executed commands.

4

Click at the end of the row to view the command result.


Next steps

Now that you’ve completed the quickstart guide, it’s time to explore more advanced features of JumpServer!

Please note, the documentation is still being updated, and we’ll continue to add more details. Stay tuned for future updates!