forked from jumpserver/docs
/
mkdocs.yml
287 lines (279 loc) · 11.6 KB
/
mkdocs.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
site_name: 'JumpServer 文档'
site_url: 'https://docs.jumpserver.org'
site_author: 'jumpserver'
site_description: "JumpServer 开源堡垒机的在线文档"
repo_name: 'jumpserver/jumpserver'
repo_url: 'https://github.com/jumpserver/jumpserver'
edit_uri: ''
theme:
name: 'material'
logo: 'img/logo.png'
favicon: 'img/facio.ico'
language: 'zh'
palette:
- scheme: default
accent: 'red'
toggle:
icon: material/weather-sunny
name: Switch to dark mode
- scheme: slate
accent: 'red'
toggle:
icon: material/weather-night
name: Switch to light mode
features:
- navigation.tracking
- navigation.indexes
- navigation.top
- search.suggest
- search.highlight
- search.share
- header.autohide
font: false
custom_dir: 'theme'
icon:
repo: fontawesome/brands/github
nav:
- 产品介绍: index.md
- 快速入门: quick_start.md
- 系统架构: architecture.md
- 安装部署:
- 网络端口说明: installation/network_port.md
- Linux 单机部署:
- 环境要求: installation/setup_linux_standalone/requirements.md
- 离线安装: installation/setup_linux_standalone/offline_install.md
- 离线升级: installation/setup_linux_standalone/offline_upgrade.md
- 1Panel 安装: installation/setup_linux_standalone/1panel_install.md
- 在线安装: installation/setup_linux_standalone/online_install.md
- 在线升级: installation/setup_linux_standalone/online_upgrade.md
- Linux 集群模式部署:
- 准备工作: installation/setup_linux_lb/requirements.md
- 部署 NFS 服务: installation/setup_linux_lb/nfs_install.md
- 部署 MySQL 服务: installation/setup_linux_lb/mysql_install.md
- 部署 Redis 服务: installation/setup_linux_lb/redis_install.md
- 部署 JumpServer 01 节点: installation/setup_linux_lb/installation_node01.md
- 部署 JumpServer 02 节点: installation/setup_linux_lb/installation_node02.md
- 部署 JumpServer 03 节点: installation/setup_linux_lb/installation_node03.md
- 部署 JumpServer 04 节点: installation/setup_linux_lb/installation_node04.md
- 部署 HAProxy 服务: installation/setup_linux_lb/haproxy_install.md
- 部署 MinIO 服务: installation/setup_linux_lb/minio_install.md
- 部署 Elasticsearch 服务: installation/setup_linux_lb/elasticsearch_install.md
- 注意事项: installation/setup_linux_lb/linux_lb_upgrade.md
- Kubernetes Helm 模式部署:
- 在线安装: installation/setup_kubernetes/helm_online_install.md
- 在线升级: installation/setup_kubernetes/helm_online_upgrade.md
- 源码部署:
- 环境说明: installation/source_install/requirements.md
- Core 环境部署: installation/source_install/core_install.md
- Lina 环境部署: installation/source_install/lina_install.md
- Luna 环境部署: installation/source_install/luna_install.md
- KoKo 环境部署: installation/source_install/koko_install.md
- Lion 环境部署: installation/source_install/lion_install.md
- Magnus 环境部署: installation/source_install/magnus_install.md
- Nginx 环境部署: installation/source_install/nginx_install.md
- JumpServer 环境整合: installation/source_install/merge_jumpserver.md
- 迁移文档: installation/migration.md
- 升级须知: installation/upgrade_notice.md
- 反向代理: installation/proxy.md
- 资源下载: installation/download.md
- 命令行工具: installation/jmsctl_sh.md
- 数据库加密连接:
- 数据库 SSL 连接: installation/security_setup/mysql_ssl.md
- Redis SSL 连接: installation/security_setup/redis_ssl.md
- 功能手册:
- 页面说明: guide/index_description.md
- 通用功能: guide/currency.md
- 资产要求:
- Telnet: guide/asset_requirements/telnet.md
- Linux SSH: guide/asset_requirements/linux_ssh.md
- Linux VNC: guide/asset_requirements/linux_vnc.md
- macOS VNC: guide/asset_requirements/macos_vnc.md
- Windows SSH: guide/asset_requirements/windows_ssh.md
- Windows VNC: guide/asset_requirements/windows_vnc.md
- Windows RDP: guide/asset_requirements/windows_rdp.md
- MySQL: guide/asset_requirements/mysql.md
- Kubernetes: guide/asset_requirements/kubernetes.md
- 管理手册:
- 仪表盘: guide/admin/dashboard.md
- 用户管理:
- 用户列表: guide/admin/user/user_list.md
- 用户组: guide/admin/user/user_group.md
- 角色列表 (X-Pack): guide/admin/user/role_list.md
- 资产管理:
- 资产列表: guide/admin/asset/asset_list.md
- 网域列表: guide/admin/asset/domain_list.md
- 平台列表: guide/admin/asset/platform_list.md
- 账号管理:
- 账号列表: guide/admin/account/account_list.md
- 账号模版: guide/admin/account/account_template.md
- 账号推送: guide/admin/account/account_push.md
- 账号收集 (X-Pack): guide/admin/account/account_gather.md
- 账号改密 (X-Pack): guide/admin/account/account_change_secret.md
- 账号备份 (X-Pack): guide/admin/account/account_backup.md
- 权限管理:
- 资产授权: guide/admin/permission/asset_permissions.md
- 用户登录: guide/admin/permission/user_acls.md
- 命令过滤: guide/admin/permission/cmd_acls.md
- 资产登录 (X-Pack): guide/admin/permission/host_acls.md
- 连接方式（X-Pack）: guide/admin/permission/connect_method_acls.md
- 更多选项:
- 标签列表: guide/admin/more_options/label_list.md
- 工单 (X-Pack): guide/admin/admin_tickets.md
- 审计手册:
- 仪表盘: guide/audit/dashboard.md
- 会话审计:
- 会话记录: guide/audit/session_audit/session_record.md
- 命令记录: guide/audit/session_audit/command_record.md
- 文件传输: guide/audit/session_audit/ftp.md
- 日志审计:
- 登录日志: guide/audit/log_audit/login_log.md
- 操作日志: guide/audit/log_audit/operation_log.md
- 改密日志: guide/audit/log_audit/secret_change_log.md
- 作业日志: guide/audit/log_audit/job_log.md
- 用户手册:
- 概览页: guide/user/index_overview.md
- 个人信息:
- 用户信息: guide/user/personal_information/user_information.md
- 认证设置: guide/user/personal_information/authentication_settings.md
- 偏好设置: guide/user/personal_information/preference_settings.md
- API Key: guide/user/personal_information/api_key.md
- 临时密码: guide/user/personal_information/temporary_passwd.md
- 连接令牌: guide/user/personal_information/connect_token.md
- Passkey: guide/user/personal_information/passkey.md
- 我的资产: guide/user/my_asset.md
- Web 终端: guide/user/web_terminal.md
- 文件管理: guide/user/file_management.md
- 作业中心:
- 快捷命令: guide/user/ops/quick_command.md
- 作业管理: guide/user/ops/job_management.md
- 模版管理: guide/user/ops/template_management.md
- 执行历史: guide/user/ops/execution_history.md
- 工单 (X-Pack): guide/user/user_tickets.md
- 系统设置:
- 概览页: guide/system/index_overview.md
- 基本设置: guide/system/basic.md
- 组织管理 (X-Pack): guide/system/organization.md
- 消息通知: guide/system/message.md
- 功能设置: guide/system/function.md
- 认证设置:
- MFA: guide/system/authentication/mfa.md
- LDAP: guide/system/authentication/ldap.md
- CAS: guide/system/authentication/cas.md
- Passkey: guide/system/authentication/passkey.md
- SSO (X-Pack): guide/system/authentication/sso.md
- OpenID (X-Pack): guide/system/authentication/openid.md
- SAML2 (X-Pack): guide/system/authentication/saml2.md
- Slack (X-Pack): guide/system/authentication/slack.md
- Radius (X-Pack): guide/system/authentication/radius.md
- 钉钉 (X-Pack): guide/system/authentication/dingtalk.md
- 微信 (X-Pack): guide/system/authentication/wechat.md
- 飞书 (X-Pack): guide/system/authentication/feishu.md
- 存储设置: guide/system/storages.md
- 组件设置: guide/system/component.md
- 远程应用: guide/system/remoteapp.md
- 安全设置: guide/system/security.md
- 界面设置 (X-Pack): guide/system/index_logo.md
- 系统工具: guide/system/tools.md
- 系统任务: guide/system/tasks.md
- 参数说明: guide/env.md
- 存储说明: guide/storages.md
- 最佳实践: best_practices.md
- 常见问题:
- 产品 FAQ: faq/faq.md
- 安全建议: faq/security.md
- 企业版: faq/enterprise.md
- 开发文档:
- API 文档: dev/rest_api.md
- 交互命令: dev/shell.md
- 用户案例: user_stories.md
- 更新日志: change_log.md
- 技术咨询: https://jinshuju.net/f/sQ91MK
- 联系我们: contact.md
markdown_extensions:
- admonition
- abbr
- attr_list
- def_list
- footnotes
- meta
- toc:
permalink: ⚓︎
- pymdownx.arithmatex:
generic: true
- pymdownx.betterem:
smart_enable: all
- pymdownx.caret
- pymdownx.critic
- pymdownx.details
- pymdownx.emoji:
emoji_index: !!python/name:materialx.emoji.twemoji
emoji_generator: !!python/name:materialx.emoji.to_svg
options:
custom_icons:
- theme/.icons
- pymdownx.inlinehilite
- pymdownx.keys
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
- pymdownx.saneheaders
- pymdownx.magiclink:
repo_url_shortener: true
repo_url_shorthand: true
- pymdownx.mark
- pymdownx.smartsymbols
- pymdownx.snippets:
check_paths: true
- pymdownx.tabbed:
alternate_style: true
- pymdownx.tasklist:
custom_checkbox: true
- pymdownx.tilde
extra:
jumpserver:
tag: v3.10.5
jmservisor: v1.2.5
wisp: v0.1.16
search:
separator: '[\s\-\.]+'
language: 'zh'
Content-Encoding: gzip
boost: 100
generator: false
version:
default: master
provider: mike
analytics:
provider: google
property: UA-147297392-3
social:
- icon: Bilibili_Logo_Blue
link: https://space.bilibili.com/510493147?spm_id_from=333.337.0.0
- icon: fontawesome/brands/github
link: https://github.com/jumpserver
- icon: fontawesome/brands/docker
link: https://hub.docker.com/r/jumpserver/
- icon: fontawesome/solid/envelope
link: mailto:support@fit2cloud.com
- icon: fontawesome/brands/skype
link: tel://400-052-0755
- icon: fontawesome/brands/qq
link: https://qm.qq.com/cgi-bin/qm/qr?k=om7dOmqflNsfzegPBODIxooO_dMDGiD1&jump_from=webapi
extra_css:
- css/extra.css
- css/termynal.css
- css/custom.css
- stylesheets/extra.css
extra_javascript:
- js/termynal.js
- js/custom.js
copyright: Copyright © 2014-2024 <a href="https://www.fit2cloud.com">杭州飞致云信息科技有限公司</a>, All Rights Reserved. <a href="http://www.beian.miit.gov.cn" target="_blank">京ICP备15023818号</a>
plugins:
- search:
lang:
- en
- ja
separator: '[\s\-\.]+'
- macros