From 02750e56d996c041683f6aa4dc854b897d9668ff Mon Sep 17 00:00:00 2001 From: Bai Date: Mon, 1 Apr 2024 17:09:08 +0800 Subject: [PATCH 1/9] perf: Update README.md --- README.md | 59 ++++++++++++++++++++++++++++++++++++++++++++++--------- 1 file changed, 50 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 9c76dffd1..80c89152b 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,7 @@ [![][github-release-shield]][github-release-link] [![][github-stars-shield]][github-stars-link] -**English** · [简体中文](./README.zh-CN.md) · [Documents][docs] · [Report Bug][github-issues-link] · [Request Feature][github-issues-link] +**English** · [简体中文](./README.zh-CN.md) · [Documents][docs-link] · [Report Bug][github-issues-link] · [Request Feature][github-issues-link] For 9 years, pouring heart and soul into creating a high-quality open-source bastion host.
@@ -102,6 +102,40 @@ _[To-do: Display a diagram of supported asset types.]_ ## Installation +JumpServer supports multiple installation methods to cater to diverse user scenarios and preferences: + +See documentation: 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. + +```sh +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 + ## System Architecture ## Features @@ -133,26 +167,33 @@ _[To-do: Display a diagram of supported asset types.]_ ## Contact ## License + +[official-website-en-link]: https://jumpserver.org/ +[docs-link]: https://docs.jumpserver.org/ +[community-link]: https://community.fit2cloud.com/#/products/jumpserver/downloads +[demo-link]: https://demo.jumpserver.org/ +[discord-link]: https://discord.gg/DVz6Hckx - -[license-shield]: https://img.shields.io/github/license/jumpserver/jumpserver + + [license-link]: https://www.gnu.org/licenses/gpl-3.0.html -[docker-shield]: https://img.shields.io/docker/pulls/jumpserver/jms_all.svg [docker-link]: https://hub.docker.com/u/jumpserver [github-release-shield]: https://img.shields.io/github/v/release/jumpserver/jumpserver [github-release-link]: https://github.com/jumpserver/jumpserver/releases/latest [github-stars-shield]: https://img.shields.io/github/stars/jumpserver/jumpserver?color=%231890FF&style=flat-square [github-stars-link]: https://github.com/jumpserver/jumpserver - -[docs]: https://docs.jumpserver.org/ [github-issues-link]: https://github.com/jumpserver/jumpserver/issues + + + +[docker-shield]: https://img.shields.io/docker/pulls/jumpserver/jms_all.svg +[license-shield]: https://img.shields.io/github/license/jumpserver/jumpserver [demo-shield-badge]: https://img.shields.io/badge/ONLINE-online?style=plastic&logo=jameson&logoColor=white&label=TRY%20JUMPSERVER&labelColor=black&color=%23148f76 -[demo-link]: https://demo.jumpserver.org/ [discord-shield-badge]: https://img.shields.io/badge/JOIN_US_NOW-ONLINE?style=plastic&logo=discord&logoColor=white&label=DISCORD&labelColor=black&color=%23404eed -[discord-link]: https://discord.gg/DVz6Hckx [version-ee-shield-badge]: https://img.shields.io/badge/Enterprise-black?style=flat-square&logo=vagrant -[official-website-en-link]: https://jumpserver.org/ + + [image-jumpserver]: https://download.jumpserver.org/images/jumpserver-logo.svg [image-dashboard]: https://github.com/jumpserver/jumpserver/assets/32935519/014c2230-82d3-4b53-b907-8149ce44bbd0 From 10435788bcaa648fa558dc1cb55cb60346aa5aca Mon Sep 17 00:00:00 2001 From: Bryan Date: Mon, 1 Apr 2024 17:37:11 +0800 Subject: [PATCH 2/9] Update README.md --- README.md | 28 +++++++++++++++++++++------- 1 file changed, 21 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 80c89152b..fe91ede2d 100644 --- a/README.md +++ b/README.md @@ -43,7 +43,6 @@ _[To-do]: Need to design the graphics._ - [`11` Ticket Management](#11-ticket-management) [![][version-ee-shield-badge]][official-website-en-link] - [Contributing](#contributing) - [Security](#security) -- [Contact](#contact) - [License](#license) #### @@ -106,7 +105,7 @@ JumpServer supports multiple installation methods to cater to diverse user scena See documentation: https://docs.jumpserver.org/zh/v3/ -### `1` Online +#### `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: @@ -118,18 +117,18 @@ Quick installation of JumpServer in just two steps: curl -sSL https://github.com/jumpserver/jumpserver/releases/latest/download/quick_start.sh | bash ``` -### `2` Offline +#### `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) +#### `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 +#### `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 +#### `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. @@ -163,9 +162,24 @@ Applying for the Enterprise Edition: https://jumpserver.org/enterprise.html ### `11` Ticket Management ## Contributing +Welcome to submit PR to contribute. Please refer to CONTRIBUTING.md for guidelines. + ## Security -## Contact +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: + +Email: support@fit2cloud.com +Phone: 400-052-0755 + ## 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. + + [official-website-en-link]: https://jumpserver.org/ From ff3865d1a7cd963f816e9a1efbb3815b33e98f7b Mon Sep 17 00:00:00 2001 From: Bryan Date: Mon, 1 Apr 2024 18:01:56 +0800 Subject: [PATCH 3/9] Update README.md --- README.md | 29 ++++++++++++++++++++++++++--- 1 file changed, 26 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index fe91ede2d..0050e9da4 100644 --- a/README.md +++ b/README.md @@ -89,7 +89,8 @@ JumpServer aims to become the industry's preferred platform, assisting businesse 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: Display a diagram of supported asset types.]_ +![][image-supported-asset-type] +_[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. @@ -137,6 +138,26 @@ Applying for the Enterprise Edition: https://jumpserver.org/enterprise.html ## System Architecture +![][image-system-architecture] +_[To-do]: Need to design the graphics._ + +| Project | Status | Description | +|--------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------| +| [Lina](https://github.com/jumpserver/lina) | Lina release | JumpServer Web UI +| [Luna](https://github.com/jumpserver/luna) | Luna release | JumpServer Web Terminal | +| [KoKo](https://github.com/jumpserver/koko) | Koko release | JumpServer Character Protocol Connector | +| [Lion](https://github.com/jumpserver/lion-release) | Lion release | JumpServer Graphical Protocol Connector, dependent on [Apache Guacamole](https://guacamole.apache.org/) | +| [Razor](https://github.com/jumpserver/razor) | Chen | JumpServer RDP Proxy Connector | +| [Tinker](https://github.com/jumpserver/tinker) | Tinker | JumpServer Remote Application Connector (Windows) | +| [Panda](https://github.com/jumpserver/Panda) | Panda | JumpServer Remote Application Connector (Linux) | +| [Magnus](https://github.com/jumpserver/magnus-release) | Magnus release | JumpServer Database Proxy Connector | +| [Chen](https://github.com/jumpserver/chen-release) | Chen release | JumpServer Web DB | +| [Kael](https://github.com/jumpserver/kael) | Kael release | JumpServer GPT Assets Connector | +| [Wisp](https://github.com/jumpserver/wisp) | Magnus release | JumpServer Inter-Project Communication Component with Core API | +| [Clients](https://github.com/jumpserver/clients) | Clients release | JumpServer Client | +| [Installer](https://github.com/jumpserver/installer) | Installer release | JumpServer Installation Tool | + + ## Features ### `1` User Authentication Supporting Integration with Multiple Single Sign-On Systems @@ -200,7 +221,6 @@ Unless required by applicable law or agreed to in writing, software distributed - [docker-shield]: https://img.shields.io/docker/pulls/jumpserver/jms_all.svg [license-shield]: https://img.shields.io/github/license/jumpserver/jumpserver [demo-shield-badge]: https://img.shields.io/badge/ONLINE-online?style=plastic&logo=jameson&logoColor=white&label=TRY%20JUMPSERVER&labelColor=black&color=%23148f76 @@ -208,7 +228,10 @@ Unless required by applicable law or agreed to in writing, software distributed [version-ee-shield-badge]: https://img.shields.io/badge/Enterprise-black?style=flat-square&logo=vagrant - [image-jumpserver]: https://download.jumpserver.org/images/jumpserver-logo.svg [image-dashboard]: https://github.com/jumpserver/jumpserver/assets/32935519/014c2230-82d3-4b53-b907-8149ce44bbd0 [image-star]: https://github.com/jumpserver/jumpserver/assets/32935519/76158e65-783d-4f11-81cd-45556a388e63 +[image-supported-asset-type]: https://github.com/jumpserver/jumpserver/assets/32935519/8e769007-5449-4e86-b34b-d04e8e484257 +[image-system-architecture]: https://github.com/jumpserver/jumpserver/assets/32935519/8a720b4e-19ed-4e3c-a8aa-325d7581005a + + From 1cf0b155286e07b3be7fda92e65da8127844552c Mon Sep 17 00:00:00 2001 From: Bryan Date: Mon, 1 Apr 2024 18:08:47 +0800 Subject: [PATCH 4/9] Update README.md --- README.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 0050e9da4..dc4aeb897 100644 --- a/README.md +++ b/README.md @@ -104,7 +104,7 @@ _[To-do]: Need to design the graphics._ JumpServer supports multiple installation methods to cater to diverse user scenarios and preferences: -See documentation: https://docs.jumpserver.org/zh/v3/ +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. @@ -137,10 +137,11 @@ Each installation method caters to different use cases and deployment scenarios, Applying for the Enterprise Edition: https://jumpserver.org/enterprise.html ## System Architecture - +Below is the schematic diagram of the JumpServer system architecture, providing a more comprehensive understanding of the product features of JumpServer. ![][image-system-architecture] _[To-do]: Need to design the graphics._ +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. | Project | Status | Description | |--------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------| | [Lina](https://github.com/jumpserver/lina) | Lina release | JumpServer Web UI From bda6037b2abc8be909a64c574a6f233cded322fe Mon Sep 17 00:00:00 2001 From: Bryan Date: Mon, 1 Apr 2024 18:21:35 +0800 Subject: [PATCH 5/9] Update README.md --- README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index dc4aeb897..6b8fb92bf 100644 --- a/README.md +++ b/README.md @@ -28,7 +28,7 @@ _[To-do]: Need to design the graphics._ - [Introduction](#introduction) - [Why JumpServer](#why-jumpserver) - [Installation](#installation) -- [System Architecture](#system-architecture) +- [Product Architecture & Components](#product-architecture--components) - [Features](#features) - [`1` User Authentication Supporting Integration with Multiple Single Sign-On Systems](#1-user-authentication-supporting-integration-with-multiple-single-sign-on-systems) - [`2` User Management Based on Role-based Access Control](#2-user-management-based-on-role-based-access-control) @@ -136,11 +136,13 @@ Each installation method caters to different use cases and deployment scenarios, Applying for the Enterprise Edition: https://jumpserver.org/enterprise.html -## System Architecture +## Product Architecture & Components +#### Architecture Diagram Below is the schematic diagram of the JumpServer system architecture, providing a more comprehensive understanding of the product features of JumpServer. ![][image-system-architecture] _[To-do]: Need to design the graphics._ +#### Supporting Components 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. | Project | Status | Description | |--------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------| From 169254a1c7c710312404dc30ed711ec301231e08 Mon Sep 17 00:00:00 2001 From: Bryan Date: Mon, 1 Apr 2024 18:22:11 +0800 Subject: [PATCH 6/9] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 6b8fb92bf..81a6496c1 100644 --- a/README.md +++ b/README.md @@ -143,7 +143,6 @@ Below is the schematic diagram of the JumpServer system architecture, providing _[To-do]: Need to design the graphics._ #### Supporting Components -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. | Project | Status | Description | |--------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------| | [Lina](https://github.com/jumpserver/lina) | Lina release | JumpServer Web UI @@ -160,6 +159,7 @@ JumpServer consists of multiple key components, which collectively form the func | [Clients](https://github.com/jumpserver/clients) | Clients release | JumpServer Client | | [Installer](https://github.com/jumpserver/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 From 99c94166bb101f7708b27ff0739ddea92d1eb0f5 Mon Sep 17 00:00:00 2001 From: Bryan Date: Mon, 1 Apr 2024 18:38:59 +0800 Subject: [PATCH 7/9] Update README.md --- README.md | 70 +++++++++++++++++++++---------------------------------- 1 file changed, 26 insertions(+), 44 deletions(-) diff --git a/README.md b/README.md index 81a6496c1..797bbc96e 100644 --- a/README.md +++ b/README.md @@ -30,17 +30,6 @@ _[To-do]: Need to design the graphics._ - [Installation](#installation) - [Product Architecture & Components](#product-architecture--components) - [Features](#features) - - [`1` User Authentication Supporting Integration with Multiple Single Sign-On Systems](#1-user-authentication-supporting-integration-with-multiple-single-sign-on-systems) - - [`2` User Management Based on Role-based Access Control](#2-user-management-based-on-role-based-access-control) - - [`3` Asset Management of Everything is an Asset](#3-asset-management-of-everything-is-an-asset) - - [`4` Asset Account Management](#4-asset-account-management) - - [`5` Asset Authorization Management](#5-asset-authorization-management) - - [`6` Asset Permission Management Based Access Control Logic](#6-asset-permission-management-based-access-control-logic) - - [`7` Remote Application Management for Everything](#7-remote-application-management-for-everything) - - [`8` Support for Multiple Asset Connection Methods](#8-support-for-multiple-asset-connection-methods) - - [`9` Comprehensive and Detailed User Behavior Audit System](#9-comprehensive-and-detailed-user-behavior-audit-system) - - [`10` Organization Management with Resource Isolation](#10-organization-management-with-resource-isolation) [![][version-ee-shield-badge]][official-website-en-link] - - [`11` Ticket Management](#11-ticket-management) [![][version-ee-shield-badge]][official-website-en-link] - [Contributing](#contributing) - [Security](#security) - [License](#license) @@ -143,47 +132,40 @@ Below is the schematic diagram of the JumpServer system architecture, providing _[To-do]: Need to design the graphics._ #### Supporting Components -| Project | Status | Description | -|--------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------| -| [Lina](https://github.com/jumpserver/lina) | Lina release | JumpServer Web UI -| [Luna](https://github.com/jumpserver/luna) | Luna release | JumpServer Web Terminal | +| Project | Status | Description | +|--------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------| +| [Lina](https://github.com/jumpserver/lina) | Lina release | JumpServer Web UI | +| [Luna](https://github.com/jumpserver/luna) | Luna release | JumpServer Web Terminal | | [KoKo](https://github.com/jumpserver/koko) | Koko release | JumpServer Character Protocol Connector | | [Lion](https://github.com/jumpserver/lion-release) | Lion release | JumpServer Graphical Protocol Connector, dependent on [Apache Guacamole](https://guacamole.apache.org/) | -| [Razor](https://github.com/jumpserver/razor) | Chen | JumpServer RDP Proxy Connector | -| [Tinker](https://github.com/jumpserver/tinker) | Tinker | JumpServer Remote Application Connector (Windows) | -| [Panda](https://github.com/jumpserver/Panda) | Panda | JumpServer Remote Application Connector (Linux) | -| [Magnus](https://github.com/jumpserver/magnus-release) | Magnus release | JumpServer Database Proxy Connector | -| [Chen](https://github.com/jumpserver/chen-release) | Chen release | JumpServer Web DB | -| [Kael](https://github.com/jumpserver/kael) | Kael release | JumpServer GPT Assets Connector | -| [Wisp](https://github.com/jumpserver/wisp) | Magnus release | JumpServer Inter-Project Communication Component with Core API | -| [Clients](https://github.com/jumpserver/clients) | Clients release | JumpServer Client | -| [Installer](https://github.com/jumpserver/installer) | Installer release | JumpServer Installation Tool | +| [Razor](https://github.com/jumpserver/razor) | Chen | JumpServer RDP Proxy Connector | +| [Tinker](https://github.com/jumpserver/tinker) | Tinker | JumpServer Remote Application Connector (Windows) | +| [Panda](https://github.com/jumpserver/Panda) | Panda | JumpServer Remote Application Connector (Linux) | +| [Magnus](https://github.com/jumpserver/magnus-release) | Magnus release | JumpServer Database Proxy Connector | +| [Chen](https://github.com/jumpserver/chen-release) | Chen release | JumpServer Web DB | +| [Kael](https://github.com/jumpserver/kael) | Kael release | JumpServer GPT Assets Connector | +| [Wisp](https://github.com/jumpserver/wisp) | Magnus release | JumpServer Inter-Project Communication Component with Core API | +| [Clients](https://github.com/jumpserver/clients) | Clients release | JumpServer Client | +| [Installer](https://github.com/jumpserver/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 +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. [![][version-ee-shield-badge]][official-website-en-link] Organization Management with Resource Isolation +11. [![][version-ee-shield-badge]][official-website-en-link] Ticket Management -### `2` User Management Based on Role-based Access Control - -### `3` Asset Management of Everything is an Asset - -### `4` Asset Account Management - -### `5` Asset Authorization Management - -### `6` Asset Permission Management Based Access Control Logic - -### `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][docs-link]. ## Contributing Welcome to submit PR to contribute. Please refer to CONTRIBUTING.md for guidelines. From 22fbbb92da63681ba09267a72d1b09364b5ec29f Mon Sep 17 00:00:00 2001 From: Bryan Date: Mon, 1 Apr 2024 18:41:34 +0800 Subject: [PATCH 8/9] Update README.md --- README.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 797bbc96e..747b73840 100644 --- a/README.md +++ b/README.md @@ -95,7 +95,7 @@ JumpServer supports multiple installation methods to cater to diverse user scena See Docs: https://docs.jumpserver.org/zh/v3/ -#### `1` Online +#### 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: @@ -107,18 +107,18 @@ Quick installation of JumpServer in just two steps: curl -sSL https://github.com/jumpserver/jumpserver/releases/latest/download/quick_start.sh | bash ``` -#### `2` Offline +#### 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) +#### 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 +#### 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 +#### 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. @@ -126,12 +126,12 @@ Each installation method caters to different use cases and deployment scenarios, Applying for the Enterprise Edition: https://jumpserver.org/enterprise.html ## Product Architecture & Components -#### Architecture Diagram +#### 1. Architecture Diagram Below is the schematic diagram of the JumpServer system architecture, providing a more comprehensive understanding of the product features of JumpServer. ![][image-system-architecture] _[To-do]: Need to design the graphics._ -#### Supporting Components +#### 2. Supporting Components | Project | Status | Description | |--------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------| | [Lina](https://github.com/jumpserver/lina) | Lina release | JumpServer Web UI | @@ -173,8 +173,8 @@ Welcome to submit PR to contribute. Please refer to CONTRIBUTING.md for guidelin ## 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: -Email: support@fit2cloud.com -Phone: 400-052-0755 +- Email: support@fit2cloud.com +- Phone: 400-052-0755 ## License Copyright (c) 2014-2024 飞致云 FIT2CLOUD, All rights reserved. From b23e99885ed08d807cafdde024387c586238d8b6 Mon Sep 17 00:00:00 2001 From: Bryan Date: Mon, 1 Apr 2024 18:47:29 +0800 Subject: [PATCH 9/9] Update README.md --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 747b73840..c74c21fda 100644 --- a/README.md +++ b/README.md @@ -168,7 +168,7 @@ Below are the features supported by JumpServer, covering various aspects of oper For details, [See Docs][docs-link]. ## Contributing -Welcome to submit PR to contribute. Please refer to CONTRIBUTING.md for guidelines. +Welcome to submit PR to contribute. Please refer to [CONTRIBUTING.md][contributing-link] 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: @@ -193,6 +193,7 @@ Unless required by applicable law or agreed to in writing, software distributed [community-link]: https://community.fit2cloud.com/#/products/jumpserver/downloads [demo-link]: https://demo.jumpserver.org/ [discord-link]: https://discord.gg/DVz6Hckx +[contributing-link]: https://github.com/jumpserver/jumpserver/blob/dev/CONTRIBUTING.md @@ -204,7 +205,6 @@ Unless required by applicable law or agreed to in writing, software distributed [github-stars-link]: https://github.com/jumpserver/jumpserver [github-issues-link]: https://github.com/jumpserver/jumpserver/issues - [docker-shield]: https://img.shields.io/docker/pulls/jumpserver/jms_all.svg [license-shield]: https://img.shields.io/github/license/jumpserver/jumpserver