Skip to content

Commit a3caa7c

Browse files
authored
Merge pull request #810 from yangjie-sister/pr@v4.0@i18n_init
feat: add English docs
2 parents 774ae10 + de81e48 commit a3caa7c

125 files changed

Lines changed: 6523 additions & 0 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

docs/about_us/contributor.en.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# Contributor List
2+
3+
!!! tip "Thank you to all friends who have contributed to JumpServer. The world is different because of you."
4+
5+
!!! tip ""
6+
- **[Lao Guang <Guang Hongwei>][ibuler]** JumpServer Founder
7+
- **[Halcyon <Wang Yong>][halcyon]** Senior DevOps Developer, JumpServer's second developer
8+
- **[Jiaxiangkong <Chen Shangwei>][jiaxiangkong]** JumpServer Test Operations
9+
- **[Liuz <Liu Zheng>][liuz]** Full-stack Engineer, wrote most of the Web Terminal code
10+
- **[Yumaojun03 <Yu Maojun>][yumaojun03]** Senior DevOps Developer, proficient in Python, Go, and PaaS platform development
11+
- **[Kelianchun <Ke Lianchun>][kelianchun]** Senior DevOps Developer, fixed many bugs
12+
- **[Xiaoyu <Li Lei>][小彧]** Senior Django Developer, contributed many codes for the user module, provided assistance during difficult times for JumpServer
13+
- **[Sofia <Zhou Xiaoxia>][sofia]** Senior Frontend Engineer, frontend code contributor
14+
- **[Q4speed <Mo Kun>][q4speed]** Architect, Guacamole integration contributor, made significant contributions for Windows support
15+
- **[Liqiang-fit2cloud <Zhang Liqiang>][liqiang-fit2cloud]** Version testing, provided many suggestions for asset tree design
16+
- **[Wojiushixiaobai <Wu Yuhuang>][wojiushixiaobai]** Improved documentation, tested bugs, enthusiastically helped many friends
17+
- **[Qiuser <Qiu Jingbo>][Qiuser]** Tested bugs, enthusiastically helped many friends
18+
- **[Xiaobai <Bai Jiangjie>][BaiJiangJie]** Core developer from v1.0 to present
19+
- **[LeeEirc <Li Zhi>][LeeEirc]** Senior Development Engineer, proficient in Go platform development, developer of KoKo component
20+
- **[Orange <Ma Zhenshuang>][Orange]** Core developer, responsible for JumpServer frontend work
21+
- **[Baqianliu <Jiang Yumin>][八千流]** Core tester (auxiliary developer), responsible for JumpServer testing
22+
23+
[ibuler]: https://github.com/ibuler
24+
[halcyon]: https://github.com/halcyon
25+
[jiaxiangkong]: https://github.com/jiaxiangkong
26+
[liuz]: https://github.com/liuz
27+
[yumaojun03]: https://github.com/yumaojun03
28+
[kelianchun]: https://github.com/kelianchun
29+
[小彧]: https://github.com/xkong
30+
[sofia]: https://github.com/sofia
31+
[q4speed]: https://github.com/q4speed
32+
[liqiang-fit2cloud]: https://github.com/liqiang-fit2cloud
33+
[wojiushixiaobai]: https://github.com/wojiushixiaobai
34+
[Qiuser]: https://github.com/qiuDar
35+
[LeeEirc]: https://github.com/LeeEirc
36+
[Orange]: https://github.com/orangemio
37+
[八千流]: https://github.com/jym503558564
38+
[BaiJiangJie]: https://github.com/BaiJiangJie

docs/architecture.en.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# System Architecture
2+
## 1 Application Architecture
3+
!!! tip ""
4+
- JumpServer adopts a layered architecture consisting of load layer, access layer, core layer, data layer, and storage layer.
5+
- The JumpServer application architecture diagram is as follows:
6+
![architecture_01](img/architecture_01.png)
7+
8+
## 2 Component description
9+
!!! tip ""
10+
- The Core component is the core component of JumpServer, and other components depend on it to start.
11+
- Koko is the component for Unix-like asset platforms, providing character connections through SSH and Telnet protocols.
12+
- Lion is the component for Windows asset platforms, used to access Windows assets from the Web.
13+
- XRDP is the component for RDP protocol, primarily used to access Windows assets such as Windows 2000, XP systems through JumpServer Client.
14+
- Razor is the component for RDP protocol; JumpServer Client uses the Razor component by default to access Windows assets.
15+
- Magnus is the component for databases, used to access database assets through client proxy.
16+
- Kael is the component for GPT asset platforms, used to manage ChatGPT assets.
17+
- Chen is the component for databases, used to access database assets through Web GUI.
18+
- Celery is the component for handling asynchronous tasks, used to execute JumpServer-related automation tasks.
19+
- Video is specifically for processing the format conversion of session recordings produced by Razor and Lion components, converting generated session recordings to MP4 format.
20+
- Panda is an application publisher based on domestic operating systems, used to schedule Virtualapp applications.
21+
22+
23+
## 3 Logical architecture
24+
!!! tip "See [Source Code Deployment](installation/source_install/requirements.md) for details"

docs/best_practices.en.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# Best Practices
2+
3+
!!! tip ""
4+
- [JumpServer user permission system usage practices](https://kb.fit2cloud.com/?p=170){:target="_blank"}
5+
- [JumpServer master-backup deployment recording synchronization](https://kb.fit2cloud.com/?p=132){:target="_blank"}
6+
- [Temporary solution for JumpServer extra-long recording playback anomalies](https://kb.fit2cloud.com/?p=131){:target="_blank"}
7+
- [JumpServer integration with Syslog log system](https://kb.fit2cloud.com/?p=123){:target="_blank"}
8+
- [How to enhance JumpServer user login security](https://kb.fit2cloud.com/?p=71){:target="_blank"}
9+
- [JumpServer custom user role permissions](https://kb.fit2cloud.com/?p=42){:target="_blank"}
10+
- [Common JumpServer MFA tools](https://kb.fit2cloud.com/?p=6){:target="_blank"}
11+
- [Implement bastion machine remote Linux (Ubuntu) desktop through open source XRDP](https://kb.fit2cloud.com/?p=140){:target="_blank"}
12+
- [How to resolve slow asset connection queries in different regions?](https://kb.fit2cloud.com/?p=138){:target="_blank"}
13+
- [Razor component untrusted certificate causes asset connection failure](https://kb.fit2cloud.com/?p=116){:target="_blank"}
14+
- [VSCode connecting to JumpServer assets](https://kb.fit2cloud.com/?p=48){:target="_blank"}
15+
- [Session sharing && multi-user collaborative operations](https://kb.fit2cloud.com/?p=41){:target="_blank"}
16+
- [Different passwords for the same system user on different assets](https://kb.fit2cloud.com/?p=19){:target="_blank"}

docs/change_log.en.md

Lines changed: 183 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,183 @@
1+
# Changelog
2+
3+
v4.10.15
4+
------------------------
5+
January 22, 2026
6+
7+
!!! info "New Features 🌱"
8+
- feat: Added API Rate Limiting mechanism to enhance interface call stability and security
9+
- feat: Quick filter capability added to ticket list for improved ticket query and processing efficiency (JumpServer EE)
10+
11+
!!! summary "Feature Optimization 🚀"
12+
- perf: Upgraded Lion component base image to 1.5.5-trixie
13+
- perf: Windows asset account password change now supports password verification through pyfreerdp (JumpServer EE)
14+
15+
!!! success "Bug Fixes 🐛"
16+
- fix: Fixed authentication service not properly validating certificates
17+
- fix: Fixed issue where corresponding sub-account switching was not created when creating accounts through account templates
18+
19+
20+
v4.10.14
21+
------------------------
22+
December 18, 2025
23+
24+
!!! info "New Features 🌱"
25+
- feat: JumpServer Client now supports OAuth 2.0 authentication method for improved client login compatibility
26+
- feat: Virtual applications support VNC protocol connections through local clients (JumpServer EE)
27+
28+
!!! summary "Feature Optimization 🚀"
29+
- perf: Smart Q&A feature supports custom model configuration to meet different intelligent interaction scenarios
30+
- perf: Kubernetes platform protocol adds namespace configuration support; users can only access authorized namespaces when connecting for enhanced access control precision
31+
32+
!!! success "Bug Fixes 🐛"
33+
- fix: Fixed memory leak issue in Razor component (JumpServer EE)
34+
- fix: Fixed issue where session sharing links could not be copied when connecting through different endpoints
35+
36+
37+
v4.10.13
38+
------------------------
39+
November 20, 2025
40+
41+
!!! info "New Features 🌱"
42+
- feat: Brand new JumpServer client with smaller size and better user experience (V4)
43+
- feat: PostgreSQL backend database now supports SSL encrypted connections
44+
45+
!!! summary "Feature Optimization 🚀"
46+
- perf: All component base images upgraded to Debian 13 (trixie)
47+
- perf: Supports batch import of weak password lists
48+
49+
50+
v4.10.12
51+
------------------------
52+
October 27, 2025
53+
54+
!!! summary "Feature Optimization 🚀"
55+
- perf: Optimized password usage mechanism and user permission validation in LDAP service connection testing
56+
- perf: Optimized user query logic in KoKo session sharing; returns maximum 10 results by default
57+
58+
59+
v4.10.11
60+
------------------------
61+
October 21, 2025
62+
63+
!!! success "Bug Fixes 🐛"
64+
- fix: Optimized permission verification logic when obtaining SuperConnectionToken
65+
66+
67+
v4.10.10
68+
------------------------
69+
October 16, 2025
70+
71+
!!! info "New Features 🌱"
72+
- feat: Added data masking feature【Enterprise Edition】Chen and KoKo support all relational databases
73+
- feat: Magnus only supports MySQL databases
74+
75+
!!! summary "Feature Optimization 🚀"
76+
- perf: Optimized Razor asset connection stuttering and high memory usage issues (upgraded to FreeRDP3) 【Enterprise Edition】
77+
- perf: Account push interface adds user group gid parameter
78+
79+
!!! success "Bug Fixes 🐛"
80+
- fix: Fixed inaccurate display of ACLs rules when selecting all assets in global organizations【Enterprise Edition】
81+
82+
83+
v4.10.9
84+
------------------------
85+
September 24, 2025
86+
87+
!!! summary "Feature Optimization 🚀"
88+
- perf: Lion file management supports uploading multiple files simultaneously
89+
90+
!!! success "Bug Fixes 🐛"
91+
- fix: Fixed high memory usage issue in KoKo
92+
93+
94+
v4.10.8
95+
------------------------
96+
September 18, 2025
97+
98+
!!! info "New Features 🌱"
99+
- feat: Added global resource search feature
100+
- feat: Supports displaying announcements in popups
101+
102+
!!! summary "Feature Optimization 🚀"
103+
- perf: Improved cloud sync to avoid releasing assets【Enterprise Edition】
104+
- perf: Improved RDP true color (24-bit) display
105+
106+
!!! success "Bug Fixes 🐛"
107+
- fix: Fixed issue where access keys remain valid after user expiration
108+
- fix: Fixed Chen complex SQL query export failure
109+
110+
v4.10.7
111+
------------------------
112+
September 4, 2025
113+
114+
!!! summary "Feature Optimization 🚀"
115+
- perf: Encrypted storage of key fields in AccessKey table (migration completed)
116+
117+
!!! success "Bug Fixes 🐛"
118+
- fix: Fixed user MFA reset failure
119+
120+
v4.10.6
121+
------------------------
122+
August 29, 2025
123+
124+
!!! success "Bug Fixes 🐛"
125+
- fix: Resolved all components going offline after upgrade
126+
- fix: Fixed Nec component freezing when using password-only authentication to connect to RealVNC server
127+
128+
v4.10.5
129+
------------------------
130+
August 22, 2025
131+
132+
!!! info "New Features 🌱"
133+
- feat: Added reporting feature to support visual data analysis and export【Enterprise Edition】
134+
- feat: Added character search in KoKo to accelerate information finding
135+
136+
!!! summary "Feature Optimization 🚀"
137+
- perf: User AccessKey stored in encrypted form to improve security
138+
- perf: Disable Passkey as MFA when SAFE_MODE is enabled for enhanced security
139+
140+
v4.10.4
141+
------------------------
142+
July 16, 2025
143+
144+
!!! summary "Feature Optimization 🚀"
145+
- perf: Cloud sync tasks now support switching automatic host information updates【Enterprise Edition】
146+
147+
v4.10.3
148+
------------------------
149+
July 1, 2025
150+
151+
!!! success "Bug Fixes 🐛"
152+
- fix: Fixed command record count showing 0 after configuring Elasticsearch for command storage
153+
- fix: Fixed KoKo session showing WebSocket disconnect warning
154+
155+
v4.10.2
156+
------------------------
157+
June 20, 2025
158+
159+
!!! info "New Features 🌱"
160+
- feat: Support users to set personal language preference
161+
- feat: Quick commands in Adhoc will hide account name hints when SAFE_MODE=true is enabled
162+
163+
!!! success "Bug Fixes 🐛"
164+
- fix: Fixed remote application publishing failure
165+
- fix: Fixed asset type tree nested display anomaly
166+
167+
v4.10.1
168+
------------------------
169+
May 19, 2025
170+
171+
!!! success "Bug Fixes 🐛"
172+
- fix: Fixed client download failure
173+
- fix: Fixed watermark enable exception in community edition
174+
175+
v4.10.0
176+
------------------------
177+
May 15, 2025
178+
179+
!!! success "Major Update ⚡️"
180+
181+
- feat: Multi-language support: including English, Chinese (Simplified), Chinese (Traditional), Japanese, Portuguese (Brazil), Spanish, Russian, and Korean
182+
183+
!!! info "New Features 🌱"

docs/contact.en.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# Contact Us
2+
3+
## 1 GitHub Project Address
4+
!!! tip ""
5+
- [JumpServer][jumpserver] ![jumpserver stars][jumpserver stars]
6+
7+
## 2 Contact information
8+
!!! tip ""
9+
- Official website: https://www.jumpserver.org/
10+
- Email: support@fit2cloud.com
11+
- Phone: 400-052-0755
12+
- Community forum: [Open source community forum][Open source community forum]
13+
- Enterprise edition trial application: https://jumpserver.org/enterprise.html
14+
- Technical consultation: https://jinshuju.net/f/sQ91MK
15+
16+
## 3 WeChat Official Account
17+
![wechat-official](img/wechat-official.png){ width="156px" }
18+
19+
## 4 WeChat Group
20+
![wechat-group](img/weixin_group.png){ width="156px" }
21+
22+
## 5 Smart Customer Service
23+
![evo-bot](img/AI_helper.png){ width="156px" }
24+
25+
## 6 Learning Certification
26+
![contact01](img/contact01.png){ width="156px" }
27+
28+
## 7 Online Documentation Feedback
29+
!!! tip ""
30+
- If you find any issues while reading this documentation, we welcome your feedback through the following form, and we will optimize it as soon as possible.
31+
- [Online documentation feedback form][Online documentation feedback form]
32+
33+
[jumpserver]: https://github.com/jumpserver/jumpserver
34+
[jumpserver stars]: https://img.shields.io/github/stars/jumpserver/jumpserver.svg
35+
[Online documentation feedback form]: https://doc.weixin.qq.com/forms/AFYAQAeUAAwAHIANQZoAP0vuxVj1HRR3f
36+
[Open source community forum]: https://bbs.fit2cloud.com/c/js/5

0 commit comments

Comments
 (0)