github
/
jumpserver
mirror of https://github.com/jumpserver/jumpserver
1
0
Fork 0
Code Issues Releases Wiki Activity
jumpserver/README.md

17 KiB
Raw Blame History

JumpServer

Popular Open-Source Bastion Host

English · 简体中文 · Documents · Report Bug · Request Feature

For 9 years, pouring heart and soul into creating a high-quality open-source bastion host.

[To-do]: Need to design the graphics.

Table of contents

TOC


Getting Started

Step right into our online demonstration environment, where you can effortlessly experience our product without the need for time-consuming software installations. With just a few clicks, you'll quickly grasp the functionality and features of our product. In the demonstration environment, you can explore the various features of our product to your heart's content and experience our innovative design and exceptional performance.

Whether you're new to the experience or a seasoned expert, we invite you to join our Discord community right away! Here, our developers and enthusiastic users come together to offer support and assistance. No matter what challenges you encounter during your usage, we are committed to answering your questions and providing guidance.

No installation or registration necessary! Visit our website to experience it firsthand.
Join our Discord community! This is where you can connect with developers and other enthusiastic users of JumpServer. 
!IMPORTANT]

**Star Us**, You will receive all release notifications from GitHub without any delay \~ ⭐️

Star History 
!TIP]

This is a demonstration video that can quickly help you understand the page design and product features of JumpServer.

[To-do]: Need to design the video.

Introduction

JumpServer is a widely acclaimed open-source bastion host, serving as a professional operational security auditing system compliant with the 4A standards. It helps businesses securely manage and access all types of assets in a more secure manner, enabling pre-authorization, real-time monitoring, and post-audit capabilities.

JumpServer aims to become the industry's preferred platform, assisting businesses in securely and efficiently managing and accessing all types of assets. By offering a professional operational security auditing system compliant with 4A standards, JumpServer is committed to delivering advanced asset management and access solutions, meeting enterprises' needs for security, reliability, and efficiency.

JumpServer's vision is to become a leader in the enterprise-level asset management and access control field, providing comprehensive solutions for users to securely and efficiently manage and utilize their assets. Through continuous innovation and enhancement of product features, JumpServer is committed to driving the development of the entire industry and becoming a key supporter and promoter of enterprise digital transformation.

[To-do]: Need to design the graphics.

Why JumpServer

  1. Open Source: JumpServer is an open-source software, meaning users can freely access, use, and modify its source code to meet individual needs, while also benefiting from community support and collaboration.
  2. Plugin-Free: JumpServer provides comprehensive functionality without the need for additional plugins or extensions. This simplifies deployment and management processes, reducing potential compatibility and security risks.
  3. Distributed: JumpServer supports a distributed architecture, allowing easy scaling across multiple nodes for high availability and fault tolerance. This makes it suitable for large-scale deployments and complex network environments.
  4. Multi-Cloud: JumpServer offers support for various cloud platforms, including AWS, Azure, Google Cloud, etc., enabling users to manage and access assets seamlessly across different cloud environments.
  5. Cloud Storage: JumpServer supports storing critical data such as audit logs and configuration files in the cloud, ensuring data security and reliability, as well as facilitating cross-region and cross-device access.
  6. Organizational: JumpServer provides a flexible organizational structure, supporting multi-level organizational hierarchies and permission management. This allows administrators to finely control user access permissions, ensuring asset security and compliance.

Installation

JumpServer supports multiple installation methods to cater to diverse user scenarios and preferences:

See Docs: https://docs.jumpserver.org/zh/v3/

1. Online

Ideal for users with internet access, this method involves downloading installation scripts or packages directly from the internet. It ensures easy access to the latest updates and dependencies during installation.

Quick installation of JumpServer in just two steps:

  1. Prepare a 64-bit Linux host with at least 4 cores and 8 GB of RAM, which has internet access.
  2. Execute the following command as the root user for one-click installation of JumpServer.
curl -sSL https://github.com/jumpserver/jumpserver/releases/latest/download/quick_start.sh | bash

2. Offline

Suited for environments without internet connectivity, this method allows users to download all necessary installation files and dependencies beforehand. It ensures seamless installation even in isolated or restricted network environments.

Download offline package: https://community.fit2cloud.com/#/products/jumpserver/downloads

3. Kubernetes (K8s)

JumpServer supports installation on Kubernetes clusters. You can deploy JumpServer as containerized applications on Kubernetes, leveraging the scalability and management features of Kubernetes for running JumpServer.

4. All-in-One

This method provides a simplified installation process where all components of JumpServer are installed on a single server or machine. It's suitable for small-scale deployments or testing purposes where separate component deployment is not required.

5. Enterprise Edition Trial

JumpServer offers a trial version of its enterprise edition, allowing users to test out the enterprise features and functionalities before committing to a full deployment. This trial version typically comes with limited duration or features to provide a glimpse of the capabilities of the enterprise edition.

Each installation method caters to different use cases and deployment scenarios, offering flexibility and options for users based on their requirements and infrastructure setup.

Applying for the Enterprise Edition: https://jumpserver.org/enterprise.html

Product Architecture & Components

1. Architecture Diagram

Below is the schematic diagram of the JumpServer system architecture, providing a more comprehensive understanding of the product features of JumpServer. [To-do]: Need to design the graphics.

2. Supporting Components

Project Status Description
Lina Lina release JumpServer Web UI
Luna Luna release JumpServer Web Terminal
KoKo Koko release JumpServer Character Protocol Connector
Lion Lion release JumpServer Graphical Protocol Connector, dependent on Apache Guacamole
Razor Chen JumpServer RDP Proxy Connector
Tinker Tinker JumpServer Remote Application Connector (Windows)
Panda Panda JumpServer Remote Application Connector (Linux)
Magnus Magnus release JumpServer Database Proxy Connector
Chen Chen release JumpServer Web DB
Kael Kael release JumpServer GPT Assets Connector
Wisp Magnus release JumpServer Inter-Project Communication Component with Core API
Clients Clients release JumpServer Client
Installer Installer release JumpServer Installation Tool

JumpServer consists of multiple key components, which collectively form the functional framework of JumpServer, providing users with comprehensive capabilities for operations management and security control.

Features

Below are the features supported by JumpServer, covering various aspects of operations management and security control, providing you with a comprehensive solution.

  1. User Authentication Supporting Integration with Multiple Single Sign-On Systems (SSO)
  2. User Management Based on Role-based Access Control (RBAC)
  3. Asset Management of Everything is an Asset
  4. Asset Account Management
  5. Asset Authorization Management
  6. Asset Permission Management Based Access Control Logic (ACL)
  7. Remote Application Management for Everything
  8. Support for Multiple Asset Connection Methods
  9. Comprehensive and Detailed User Behavior Audit System
  10. Organization Management with Resource Isolation
  11. Ticket Management

For details, See Docs.

Contributing

Welcome to submit PR to contribute. Please refer to CONTRIBUTING.md for guidelines.

Security

JumpServer is a secure product. Please refer to the Basic Security Recommendations for installation and deployment. If you encounter any security-related issues, please contact us directly:

License

Copyright (c) 2014-2024 飞致云 FIT2CLOUD, All rights reserved.

Licensed under The GNU General Public License version 3 (GPLv3) (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

https://www.gnu.org/licenses/gpl-3.0.html

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an " AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.