Skip to content

Commit efa8701

Browse files
feat: 更新文档
1 parent 3c5c3cf commit efa8701

File tree

5 files changed

+43
-31
lines changed

5 files changed

+43
-31
lines changed

docs/index.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,9 @@
3131
## 案例研究
3232

3333
!!! tip ""
34+
- [腾讯海外游戏:基于JumpServer构建游戏安全运营能力](https://blog.fit2cloud.com/?p=3704){:target="_blank"}
35+
- [万华化学:通过JumpServer管理全球化分布式IT资产,并且实现与云管平台的联动](https://blog.fit2cloud.com/?p=3504){:target="_blank"}
36+
- [雪花啤酒:JumpServer堡垒机使用体会](https://blog.fit2cloud.com/?p=3412){:target="_blank"}
3437
- [JumpServer 堡垒机护航顺丰科技超大规模资产安全运维](https://blog.fit2cloud.com/?p=1147){:target="_blank"}
3538
- [JumpServer 堡垒机让“大智慧”的混合 IT 运维更智慧](https://blog.fit2cloud.com/?p=882){:target="_blank"}
3639
- [携程 JumpServer 堡垒机部署与运营实战](https://blog.fit2cloud.com/?p=851){:target="_blank"}

docs/install/setup_by_fast.md

Lines changed: 22 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -4,21 +4,27 @@
44

55
!!! info "环境要求"
66

7-
| OS Version | Linux Kernel | Soft Requirement |
8-
| :------------ | :------------ | :------------------------------------ |
9-
| Linux Release | >= 4.0 | wget curl tar gettext iptables python |
10-
11-
## 安装方式
12-
13-
- [安装演示视频](https://www.bilibili.com/video/av635028005)
7+
| OS/Arch | Architecture | Linux Kernel | Soft Requirement |
8+
| :------------ | :----------- | :------------ | :------------------------------------ |
9+
| linux/amd64 | x86_64 | >= 4.0 | wget curl tar gettext iptables python |
10+
| linux/arm64 | aarch64 | >= 4.0 | wget curl tar gettext iptables python |
11+
| linux/loong64 | loongarch64 | == 4.19 | wget curl tar gettext iptables python |
1412

1513
!!! info "外置环境要求"
1614
- 推荐使用外置 数据库 和 Redis,方便日后扩展升级
1715

18-
| DB | Version | | Cache | Version |
19-
| :------ | :------ | :- | :---- | :------ |
20-
| MySQL | >= 5.7 | | Redis | >= 5.0 |
21-
| MariaDB | >= 10.2 | | | |
16+
| Name | Version | Default Charset | Default collation | TLS/SSL |
17+
| :------ | :------ | :--------------- | :----------------- | :--------------- |
18+
| MySQL | >= 5.7 | utf8 | utf8_general_ci | :material-check: |
19+
| MariaDB | >= 10.2 | utf8mb3 | utf8mb3_general_ci | :material-check: |
20+
21+
| Name | Version | Sentinel | Cluster | TLS/SSL |
22+
| :------ | :------ | :--------------- | :----------------- | :--------------- |
23+
| Redis | >= 5.0 | :material-check: | :material-close: | :material-check: |
24+
25+
## 安装方式
26+
27+
根据实机环境选择安装方式,支持 [在线安装](#_3)[离线安装](#_4),安装过程可以参考 [安装演示视频](https://www.bilibili.com/video/av635028005){:target="_blank"}
2228

2329
### 在线安装
2430

@@ -860,11 +866,11 @@
860866

861867
### 离线安装
862868

863-
| OS | Arch | Architecture | Offline Name |
864-
| :------ | :------ | :----------- | :------------------------------------------------------------------------------------------- |
865-
| Linux | amd64 | x86_64 | jumpserver-offline-installer-{{ jumpserver.version }}-amd64-{{ installer.version }}.tar.gz |
866-
| Linux | arm64 | aarch64 | jumpserver-offline-installer-{{ jumpserver.version }}-arm64-{{ installer.version }}.tar.gz |
867-
| Linux | loong64 | loongarch64 | jumpserver-offline-installer-{{ jumpserver.version }}-loong64-{{ installer.version }}.tar.gz |
869+
| OS/Arch | Architecture | Linux Kernel | Offline Name |
870+
| :------------ | :----------- | :----------- | :------------------------------------------------------------------------------------------- |
871+
| linux/amd64 | x86_64 | >= 4.0 | jumpserver-offline-installer-{{ jumpserver.version }}-amd64-{{ installer.version }}.tar.gz |
872+
| linux/arm64 | aarch64 | >= 4.0 | jumpserver-offline-installer-{{ jumpserver.version }}-arm64-{{ installer.version }}.tar.gz |
873+
| linux/loong64 | loongarch64 | == 4.19 | jumpserver-offline-installer-{{ jumpserver.version }}-loong64-{{ installer.version }}.tar.gz |
868874

869875
=== "linux/amd64"
870876
!!! tip ""

docs/install/setup_by_lb.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,15 @@
66
- 如果已经有 HLB 或者 SLB 可以跳过 HAProxy 部署,第三方 LB 要注意 session 和 websocket 问题
77
- 如果已经有 云存储 (* S3/Ceph/Swift/OSS/Azure) 可以跳过 MinIO 部署,MySQL Redis 也一样
88
- 生产环境中,应该使用 Ceph 等替代 NFS,或者部署高可用的 NFS 防止单点故障
9-
- [Redis 高可用快速部署可以参考此项目](https://github.com/wojiushixiaobai/redis-sentinel){:target="_blank"}
109

11-
| DB | Version | | Cache | Version |
12-
| :------ | :------ | :- | :---- | :------ |
13-
| MySQL | >= 5.7 | | Redis | >= 5.0 |
14-
| MariaDB | >= 10.2 | | | |
10+
| Name | Version | Default Charset | Default collation | TLS/SSL |
11+
| :------ | :------ | :--------------- | :----------------- | :--------------- |
12+
| MySQL | >= 5.7 | utf8 | utf8_general_ci | :material-check: |
13+
| MariaDB | >= 10.2 | utf8mb3 | utf8mb3_general_ci | :material-check: |
14+
15+
| Name | Version | Sentinel | Cluster | TLS/SSL |
16+
| :------ | :------ | :--------------- | :----------------- | :--------------- |
17+
| Redis | >= 5.0 | :material-check: | :material-close: | :material-check: |
1518

1619
| Server Name | IP | Port | Use | Minimize Hardware | Standard Hardware |
1720
| ------------- | ---------------- | ----------------------- | ---------------- | ---------------------- | ----------------------- |
@@ -32,7 +35,6 @@
3235
| KoKo | http://koko:5000/koko/health/ | https://demo.jumpserver.org/koko/health/ |
3336
| Lion | http://lion:8081/lion/health/ | https://demo.jumpserver.org/lion/health/ |
3437

35-
3638
## 部署 NFS 服务
3739

3840
服务器: 192.168.100.11

mkdocs.yml

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -132,7 +132,11 @@ markdown_extensions:
132132
- theme/.icons
133133
- pymdownx.inlinehilite
134134
- pymdownx.keys
135-
- pymdownx.superfences
135+
- pymdownx.superfences:
136+
custom_fences:
137+
- name: mermaid
138+
class: mermaid
139+
format: !!python/name:pymdownx.superfences.fence_code_format
136140
- pymdownx.saneheaders
137141
- pymdownx.magiclink:
138142
repo_url_shortener: true
@@ -141,7 +145,8 @@ markdown_extensions:
141145
- pymdownx.smartsymbols
142146
- pymdownx.snippets:
143147
check_paths: true
144-
- pymdownx.tabbed
148+
- pymdownx.tabbed:
149+
alternate_style: true
145150
- pymdownx.tasklist:
146151
custom_checkbox: true
147152
- pymdownx.tilde

requirements/requirements.txt

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,3 @@
1-
mkdocs>=1.2.2
2-
Pygments>=2.4
3-
markdown>=3.2
4-
pymdown-extensions>=7.0
5-
mkdocs-material-extensions>=1.0
6-
mkdocs-macros-plugin>=0.5
7-
mike>=1.0.1
1+
mkdocs-material>=8.4.0
2+
mkdocs-macros-plugin>=0.7.0
3+
mike>=1.1.2

0 commit comments

Comments
 (0)