Skip to content

Commit 2f657e6

Browse files
wojiushixiaobaiwojiushixiaobai
committed
feat: 更新 v4 版本文档
1 parent 71a41fd commit 2f657e6

File tree

10 files changed

+329
-345
lines changed

10 files changed

+329
-345
lines changed

‎docs/dev/rest_api.md

+3-16
Original file line numberDiff line numberDiff line change
@@ -6,22 +6,9 @@
66
## 1 API 访问
77
!!! tip ""
88

9-
| Version | Access method | example |
10-
| --------- | ------------------------ | ---------------------------------- |
11-
| < 2.0.0 | `http://<url>/docs` | `http://192.168.244.144/docs` |
12-
| >=2.0.0 | `http://<url>/api/docs/` | `http://192.168.244.144/api/docs/` |
13-
| >=2.6.0 | `http://<url>/api/docs/` | `http://192.168.244.144/api/docs/` |
14-
15-
!!! tip "版本小于 v2.6 需要打开 DEBUG 模式"
16-
```sh
17-
vi config.yml
18-
```
19-
```yaml
20-
...
21-
# 如果版本更低的话，配置文件是 config.py
22-
# Debug = true
23-
DEBUG: true
24-
```
9+
| Version | Access method | example |
10+
| ------------------------ | ------------------------ | ---------------------------------- |
11+
| `{{ jumpserver.tag }}` | `http://<url>/api/docs/` | `http://192.168.244.144/api/docs/` |
2512

2613
### 1.2 页面效果
2714
![api_swagger](../img/api_swagger.png)

‎docs/dev/shell.md

-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
# 交互命令
22

33
!!! warning "操作不当将导致数据丢失，操作前请仔细确认"
4-
!!! tip "参考 [Django 文档](https://docs.djangoproject.com/zh-hans/3.2/intro/tutorial02/)"
54

65
## 1 操作方法
76

‎docs/installation/setup_linux_standalone/offline_install.md

+90-68
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,25 @@
11
# 离线安装
22

3-
!!! info "离线包解压需要 tar 命令, 参考 [环境要求](./requirements.md) 手动安装"
3+
!!! info "安装所需命令, 参考 [环境要求](./requirements.md) 手动安装"
44

5-
| OS/Arch | Architecture | Linux Kernel | Offline Name |
6-
| :------------ | :----------- | :----------- | :------------------------------------------------------------------------------------------- |
7-
| linux/amd64 | x86_64 | >= 4.0 | jumpserver-offline-installer-{{ jumpserver.tag }}-amd64.tar.gz |
5+
| OS/Arch | Architecture | Linux Kernel | Offline Name |
6+
| :------------ | :----------- | :----------- | :----------------------------------------------- |
7+
| linux/amd64 | x86_64 | >= 4.0 | jumpserver-ce-{{ jumpserver.tag }}-x86_64.tar.gz |
88

99
## 1. 安装部署
1010

11+
!!! tip ""
12+
- 离线安装目前只支持 linux/amd64 架构, 其他架构请参考 [在线安装](./online_install.md)
13+
1114
=== "linux/amd64"
1215
!!! tip ""
1316
从飞致云社区 [下载最新的 linux/amd64 离线包](https://community.fit2cloud.com/#/products/jumpserver/downloads){:target="_blank"}, 并上传到部署服务器的 /opt 目录
1417

1518
!!! tip ""
1619
```sh
1720
cd /opt
18-
tar -xf jumpserver-offline-installer-{{ jumpserver.tag }}-amd64.tar.gz
19-
cd jumpserver-offline-installer-{{ jumpserver.tag }}-amd64
21+
tar -xf jumpserver-ce-{{ jumpserver.tag }}-x86_64.tar.gz
22+
cd jumpserver-ce-{{ jumpserver.tag }}-x86_64
2023
```
2124
```sh
2225
# 根据需要修改配置文件模板, 如果不清楚用途可以跳过修改
@@ -25,146 +28,165 @@
2528
```vim
2629
# JumpServer configuration file example.
2730
#
28-
# 如果不了解用途可以跳过修改此配置文件, 系统会自动填入
29-
# 完整参数文档 https://docs.jumpserver.org/zh/master/admin-guide/env/
31+
# If you don't understand the purpose, you can skip modifying this configuration file, the system will automatically fill in
32+
# Complete parameter documentation https://docs.jumpserver.org/zh/v3/guide/env/
3033

31-
################################## 镜像配置 ###################################
34+
################################# Image Configuration #################################
3235
#
33-
# 国内连接 docker.io 会超时或下载速度较慢, 开启此选项使用华为云镜像加速
34-
# 取代旧版本 DOCKER_IMAGE_PREFIX
36+
# The connection to docker.io in China will timeout or the download speed will be slow, enable this option to use Huawei Cloud image acceleration
37+
# Replace the old version DOCKER_IMAGE_PREFIX
3538
#
3639
# DOCKER_IMAGE_MIRROR=1
3740

38-
################################## 安装配置 ###################################
41+
# Image pull policy Always, IfNotPresent
42+
# Always means that the latest image will be pulled every time, IfNotPresent means that the image will be pulled only if it does not exist locally
43+
#
44+
# IMAGE_PULL_POLICY=Always
45+
46+
############################## Installation Configuration #############################
3947
#
40-
# JumpServer 数据库持久化目录, 默认情况下录像、任务日志都在此目录
41-
# 请根据实际情况修改, 升级时备份的数据库文件(.sql)和配置文件也会保存到该目录
48+
# JumpServer database persistence directory, by default, recordings, task logs are in this directory
49+
# Please modify according to the actual situation, the database file (.sql) and configuration file backed up during the upgrade will also be saved to this directory
4250
#
4351
VOLUME_DIR=/data/jumpserver
4452

45-
# 加密密钥, 迁移请保证 SECRET_KEY 与旧环境一致, 请勿使用特殊字符串
53+
# Encryption key, please ensure that SECRET_KEY is consistent with the old environment when migrating, do not use special strings
4654
# (*) Warning: Keep this value secret.
47-
# (*) 勿向任何人泄露 SECRET_KEY
55+
# (*) Do not disclose SECRET_KEY to anyone
4856
#
4957
SECRET_KEY=
5058

51-
# 组件向 core 注册使用的 token, 迁移请保持 BOOTSTRAP_TOKEN 与旧环境一致,
52-
# 请勿使用特殊字符串
59+
# The token used by the component to register with core, please keep BOOTSTRAP_TOKEN consistent with the old environment when migrating,
60+
# Do not use special strings
5361
# (*) Warning: Keep this value secret.
54-
# (*) 勿向任何人泄露 BOOTSTRAP_TOKEN
62+
# (*) Do not disclose BOOTSTRAP_TOKEN to anyone
5563
#
5664
BOOTSTRAP_TOKEN=
5765

58-
# 日志等级 INFO, WARN, ERROR
66+
# Log level INFO, WARN, ERROR
5967
#
6068
LOG_LEVEL=ERROR
6169

62-
# JumpServer 容器使用的网段, 请勿与现有的网络冲突, 根据实际情况自行修改
70+
# The network segment used by the JumpServer container, please do not conflict with the existing network, modify according to the actual situation
6371
#
6472
DOCKER_SUBNET=192.168.250.0/24
6573

66-
# ipv6 nat, 正常情况下无需开启
67-
# 如果宿主不支持 ipv6 开启此选项将会导致无法获取真实的客户端 ip 地址
74+
# ipv6 nat, no need to enable under normal circumstances
75+
# If the host does not support ipv6, enabling this option will prevent the real client ip address from being obtained
6876
#
6977
USE_IPV6=0
7078
DOCKER_SUBNET_IPV6=fc00:1010:1111:200::/64
7179

72-
################################# MySQL 配置 ##################################
73-
# 外置 MySQL 需要输入正确的 MySQL 信息, 内置 MySQL 系统会自动处理
80+
################################# DB Configuration ####################################
81+
# For external databases, you need to enter the correct database information, the system will automatically handle the built-in database
82+
# (*) The password part must not contain single quotes and double quotes
7483
#
75-
DB_HOST=mysql
76-
DB_PORT=3306
77-
DB_USER=root
84+
DB_ENGINE=postgresql
85+
DB_HOST=postgresql
86+
DB_PORT=5432
87+
DB_USER=postgres
7888
DB_PASSWORD=
7989
DB_NAME=jumpserver
8090

81-
# 如果外置 MySQL 需要开启 TLS/SSL 连接, 参考 https://docs.jumpserver.org/zh/master/install/install_security/#ssl
91+
# If external MySQL needs to enable TLS/SSL connection, refer to https://docs.jumpserver.org/zh/v3/installation/security_setup/mysql_ssl/
8292
#
83-
# DB_USE_SSL=True
93+
# DB_USE_SSL=true
8494

85-
################################# Redis 配置 ##################################
86-
# 外置 Redis 需要请输入正确的 Redis 信息, 内置 Redis 系统会自动处理
95+
################################# Redis Configuration #################################
96+
# For external Redis, please enter the correct Redis information, the system will automatically handle the built-in Redis
97+
# (*) The password part must not contain single quotes and double quotes
8798
#
8899
REDIS_HOST=redis
89100
REDIS_PORT=6379
90101
REDIS_PASSWORD=
91102

92-
# 如果使用外置 Redis Sentinel, 请手动填写下面内容
103+
# If you are using external Redis Sentinel, please manually fill in the following content
93104
#
94105
# REDIS_SENTINEL_HOSTS=mymaster/192.168.100.1:26379,192.168.100.1:26380,192.168.100.1:26381
95106
# REDIS_SENTINEL_PASSWORD=your_sentinel_password
96107
# REDIS_PASSWORD=your_redis_password
97108
# REDIS_SENTINEL_SOCKET_TIMEOUT=5
98109

99-
# 如果外置 Redis 需要开启 TLS/SSL 连接, 参考 https://docs.jumpserver.org/zh/master/install/install_security/#redis-ssl
110+
# If external Redis needs to enable TLS/SSL connection, refer to https://docs.jumpserver.org/zh/v3/installation/security_setup/redis_ssl/
100111
#
101-
# REDIS_USE_SSL=True
112+
# REDIS_USE_SSL=true
102113

103-
################################## 访问配置 ###################################
104-
# 对外提供服务端口, 如果与现有服务冲突请自行修改
114+
################################# Access Configuration ################################
115+
# The service port provided to the outside, if it conflicts with the existing service, please modify it yourself
105116
#
106117
HTTP_PORT=80
107-
SSH_PORT=2222
108-
MAGNUS_MYSQL_PORT=33061
109-
MAGNUS_MARIADB_PORT=33062
110-
MAGNUS_REDIS_PORT=63790
111118

112-
################################# HTTPS 配置 #################################
113-
# 参考 https://docs.jumpserver.org/zh/master/admin-guide/proxy/ 配置
119+
################################# HTTPS Configuration #################################
120+
# Refer to https://docs.jumpserver.org/zh/v3/installation/proxy/ for configuration
114121
#
115122
# HTTPS_PORT=443
116123
# SERVER_NAME=your_domain_name
117124
# SSL_CERTIFICATE=your_cert
118125
# SSL_CERTIFICATE_KEY=your_cert_key
119126
#
120127

121-
# Nginx 文件上传下载大小限制
128+
# Nginx file upload and download size limit
122129
#
123130
CLIENT_MAX_BODY_SIZE=4096m
124131

125-
################################## 组件配置 ###################################
126-
# 组件注册使用, 默认情况下向 core 容器注册, 集群环境需要修改为集群 vip 地址
132+
################################# Component Configuration #############################
133+
# Component registration use, by default, register to the core container, the cluster environment needs to be modified to the cluster vip address
127134
#
128135
CORE_HOST=http://core:8080
129-
PERIOD_TASK_ENABLED=True
136+
PERIOD_TASK_ENABLED=true
130137

131-
# Core Session 定义,
132-
# SESSION_COOKIE_AGE 表示闲置多少秒后 session 过期,
133-
# SESSION_EXPIRE_AT_BROWSER_CLOSE=true 表示关闭浏览器即 session 过期
138+
# Core Session definition,
139+
# SESSION_COOKIE_AGE indicates how many seconds the session expires after idling,
140+
# SESSION_EXPIRE_AT_BROWSER_CLOSE=true means that the session expires as soon as the browser is closed
134141
#
135142
# SESSION_COOKIE_AGE=86400
136-
SESSION_EXPIRE_AT_BROWSER_CLOSE=True
143+
SESSION_EXPIRE_AT_BROWSER_CLOSE=false
137144

138-
# 可信任 DOMAINS 定义,
139-
# 定义可信任的访问 IP, 请根据实际情况修改, 如果是公网 IP 请改成对应的公网 IP,
140-
# DOMAINS="demo.jumpserver.org"
141-
# DOMAINS="172.17.200.191"
142-
# DOMAINS="demo.jumpserver.org,172.17.200.191"
145+
# Trusted DOMAINS definition,
146+
# Define the trusted access IP, please modify according to the actual situation, if it is a public IP, please change to the corresponding public IP,
147+
# DOMAINS="demo.jumpserver.org:443"
148+
# DOMAINS="172.17.200.191:80"
149+
# DOMAINS="demo.jumpserver.org:443,172.17.200.191:80"
143150
DOMAINS=
144151

145-
# Lion 开启字体平滑, 优化体验
152+
# Configure the components that do not need to be started, by default all components will be started, if you do not need a certain component, you can set {component name}_ENABLED to 0 to turn it off
153+
# CORE_ENABLED=0
154+
# CELERY_ENABLED=0
155+
# KOKO_ENABLED=0
156+
# LION_ENABLED=0
157+
# CHEN_ENABLED=0
158+
# WEB_ENABLED=0
159+
160+
# Lion enables font smoothing to optimize the experience
146161
#
147-
JUMPSERVER_ENABLE_FONT_SMOOTHING=True
162+
JUMPSERVER_ENABLE_FONT_SMOOTHING=true
148163

149-
################################# XPack 配置 #################################
150-
# XPack 包, 开源版本设置无效
164+
################################# XPack Configuration #################################
165+
# XPack package, invalid setting in open source version
151166
#
167+
SSH_PORT=2222
152168
RDP_PORT=3389
169+
XRDP_PORT=3390
170+
MAGNUS_MYSQL_PORT=33061
171+
MAGNUS_MARIADB_PORT=33062
172+
MAGNUS_REDIS_PORT=63790
153173
MAGNUS_POSTGRESQL_PORT=54320
174+
MAGNUS_SQLSERVER_PORT=14330
154175
MAGNUS_ORACLE_PORTS=30000-30030
155176

156-
################################## 其他配置 ##################################
157-
# 终端使用宿主 HOSTNAME 标识, 首次安装自动生成
177+
################################## Other Configuration ################################
178+
# The terminal uses the host HOSTNAME as the identifier, automatically generated during the first installation
158179
#
159180
SERVER_HOSTNAME=${HOSTNAME}
160181

161-
# 使用内置 SLB，如果 Web 页面获取到的客户端 IP 地址不正确，请将 USE_LB 设置为 0
162-
# USE_LB 设置为 1 时，使用配置 proxy_set_header X-Forwarded-For $remote_addr
163-
# USE_LB 设置为 0 时，使用配置 proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for
182+
# Use built-in SLB, if the client IP address obtained by the Web page is not correct, please set USE_LB to 0
183+
# When USE_LB is set to 1, use the configuration proxy_set_header X-Forwarded-For $remote_addr
184+
# When USE_LB is set to 0, use the configuration proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for
164185
USE_LB=1
165186

166-
# 当前运行的 JumpServer 版本号, 安装和升级完成后自动生成
187+
# The current running version number of JumpServer, automatically generated after installation and upgrade
167188
#
189+
TZ=Asia/Shanghai
168190
CURRENT_VERSION=
169191
```
170192
```sh
@@ -179,7 +201,7 @@
179201

180202
!!! tip ""
181203
```sh
182-
cd jumpserver-offline-release-{{ jumpserver.tag }}-amd64
204+
cd jumpserver-ce-{{ jumpserver.tag }}-x86_64
183205

184206
# 启动
185207
./jmsctl.sh start
@@ -199,7 +221,7 @@
199221
```sh
200222
地址: http://<JumpServer服务器IP地址>:<服务运行端口>
201223
用户名: admin
202-
密码: admin
224+
密码: ChangeMe
203225
```
204226

205227
![登录页面](../../img/online_install_01.png)

‎docs/installation/setup_linux_standalone/offline_upgrade.md

+4-6
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,16 @@
11
# 离线升级
22

3-
!!! warning "v3 版本与 v2 版本存在一定的差异，如需 v2 版本升级至 v3 版本 [请先阅读此文档](https://kb.fit2cloud.com/?p=06638d69-f109-4333-b5bf-65b17b297ed9){:target="_blank"}"
3+
!!! warning "升级到 v4 前需要先升级到 v3 最新版本，否则升级将会直接失败"
44

5-
!!! info "升级前请先参考 [升级或迁移须知](../upgrade_notice.md)"
6-
7-
=== "离线升级(linux/amd64)"
5+
=== "linux/amd64"
86
!!! tip ""
97
从飞致云社区 [下载最新的 linux/amd64 离线包](https://community.fit2cloud.com/#/products/jumpserver/downloads){:target="_blank"}, 并上传到部署服务器的 /opt 目录。
108

119
!!! tip ""
1210
```sh
1311
cd /opt
14-
tar -xf jumpserver-offline-installer-{{ jumpserver.tag }}-amd64.tar.gz
15-
cd jumpserver-offline-installer-{{ jumpserver.tag }}-amd64
12+
tar -xf jumpserver-ce-{{ jumpserver.tag }}-x86_64.tar.gz
13+
cd jumpserver-ce-{{ jumpserver.tag }}-x86_64
1614
```
1715
```sh
1816
./jmsctl.sh upgrade

0 commit comments

Comments
 (0)