feat: add baseUrl in documents service

This commit is contained in:
delong.wang 2023-11-22 19:07:03 +08:00
parent 7340e60038
commit ca6594a486
13 changed files with 5106 additions and 10759 deletions

View file

@ -60,4 +60,4 @@ WAF 是 Web Application Firewall 的缩写,也被称为 Web 应用防火墙。
![](/images/docs/guide_introduction/website_with_safeline.svg) ![](/images/docs/guide_introduction/website_with_safeline.svg)
详情查看 **[雷池技术架构](/docs/about/framework)** 详情查看 **[雷池技术架构](/about/framework)**

View file

@ -19,7 +19,7 @@ title: "安装雷池"
bash -c "$(curl -fsSLk https://waf-ce.chaitin.cn/release/latest/setup.sh)" bash -c "$(curl -fsSLk https://waf-ce.chaitin.cn/release/latest/setup.sh)"
``` ```
**若安装失败,请参考 [安装问题](/docs/faq/install)** **若安装失败,请参考 [安装问题](/faq/install)**
### 在线安装演示 ### 在线安装演示
@ -67,7 +67,7 @@ echo "SUBNET_PREFIX=172.22.222" >> .env
docker compose up -d docker compose up -d
``` ```
**若安装失败,请参考 [安装问题](/docs/faq/install)** **若安装失败,请参考 [安装问题](/faq/install)**
### 离线安装演示 ### 离线安装演示
@ -129,6 +129,6 @@ style={{ width: '100%', height: '350px' }}
## 常见安装问题 ## 常见安装问题
请参考 [安装问题](/docs/faq/install) 请参考 [安装问题](/faq/install)
下一步请参考 [登录雷池](/docs/guide/login) 下一步请参考 [登录雷池](/guide/login)

View file

@ -24,5 +24,5 @@ style={{ width: '100%', height: '350px' }}
## 常见登录问题 ## 常见登录问题
请参考 [登录问题](/docs/faq/login) 请参考 [登录问题](/faq/login)

View file

@ -117,7 +117,7 @@ title: "配置站点"
## 常见配置问题 ## 常见配置问题
请参考 [配置问题](/docs/faq/config) 请参考 [配置问题](/faq/config)

View file

@ -14,7 +14,7 @@ title: "测试防护"
> 主机名可以是雷池的 IP也可以是网站的域名确保域名已经解析到雷池 > 主机名可以是雷池的 IP也可以是网站的域名确保域名已经解析到雷池
> 端口是你在雷池页面中配置的网站端口 > 端口是你在雷池页面中配置的网站端口
若网站访问不正常,请参考 [配置问题](/docs/03-faq/03-config.md)。 若网站访问不正常,请参考 [配置问题](/03-faq/03-config.md)。
## 尝试手动模拟攻击 ## 尝试手动模拟攻击
@ -26,7 +26,7 @@ title: "测试防护"
通过浏览器,你将会看到雷池已经发现并阻断了攻击请求。 通过浏览器,你将会看到雷池已经发现并阻断了攻击请求。
![Alt text](/images/docs/guide_config/protection_page.png) ![Alt text](/images/docs/guide_config/protection_page.png)
若请求没有被阻断,请参考 [防护问题](/docs/03-faq/04-test.md) 若请求没有被阻断,请参考 [防护问题](/03-faq/04-test.md)
## 自动化测试防护效果 ## 自动化测试防护效果
@ -73,4 +73,4 @@ sending 100% |██████████████████████
## 常见防护问题 ## 常见防护问题
请参考 [防护问题](/docs/faq/test) 请参考 [防护问题](/faq/test)

View file

@ -21,10 +21,10 @@ title: "配置其他"
### 人机验证 ### 人机验证
详情查看 [人机验证2.0](/docs/about/challenge) 详情查看 [人机验证2.0](/about/challenge)
### 语义分析 ### 语义分析
详情查看 [语义分析检测算法](/docs/about/syntaxanalysis) 详情查看 [语义分析检测算法](/about/syntaxanalysis)
## 通用配置 ## 通用配置
@ -72,4 +72,4 @@ title: "配置其他"
## 常见配置问题 ## 常见配置问题
请参考 [其他问题](/docs/faq/other) 请参考 [其他问题](/faq/other)

View file

@ -6,7 +6,7 @@ title: "升级雷池"
**注意**: 升级雷池时服务会重启,流量会中断一小段时间,根据业务情况选择合适的时间来执行升级操作。 **注意**: 升级雷池时服务会重启,流量会中断一小段时间,根据业务情况选择合适的时间来执行升级操作。
[版本更新记录](/docs/about/changelog) [版本更新记录](/about/changelog)
## 在线升级 ## 在线升级
@ -62,4 +62,4 @@ docker compose up -d
## 常见升级问题 ## 常见升级问题
请参考 [升级问题](/docs/faq/upgrade) 请参考 [升级问题](/faq/upgrade)

View file

@ -13,13 +13,13 @@ title: "安装问题"
2. 检测配置是否符合最低的配置要求 2. 检测配置是否符合最低的配置要求
> 参考 [环境检测](/docs/guide/install#环境检测) 方式 > 参考 [环境检测](/guide/install#环境检测) 方式
3. 如果连接 Docker Hub 网络不稳,导致镜像下载失败(超时): 3. 如果连接 Docker Hub 网络不稳,导致镜像下载失败(超时):
>docker hub 默认使用国外节点拉取镜像,可以自行搜索配置国内镜像加速源 >docker hub 默认使用国外节点拉取镜像,可以自行搜索配置国内镜像加速源
>采用 [离线安装](/docs/guide/install#离线安装) 方式 >采用 [离线安装](/guide/install#离线安装) 方式
## 安装时遇到报错处理方法 ## 安装时遇到报错处理方法

View file

@ -4,7 +4,7 @@ title: "版本更新记录"
# 版本更新记录 # 版本更新记录
[版本升级方法](/docs/guide/upgrade) [版本升级方法](/guide/upgrade)
### [3.12.2] - 2023-11-17 ### [3.12.2] - 2023-11-17
@ -91,7 +91,7 @@ title: "版本更新记录"
#### 新增 #### 新增
- “通用漏洞规则” 的攻击日志中,新增 “命中规则”,方便管理员了解具体的拦截原因: - “通用漏洞规则” 的攻击日志中,新增 “命中规则”,方便管理员了解具体的拦截原因:
![](/images/docs/about_changelog/log_detail.png) ![](/images/docs/about_changelog/log_detail.png)
#### 优化 #### 优化
@ -138,26 +138,26 @@ title: "版本更新记录"
### [3.6.4] - 2023-10-09 ### [3.6.4] - 2023-10-09
#### 修复 #### 修复
- 修复了多个域名申请免费证书失败的问题 - 修复了多个域名申请免费证书失败的问题
- 修复了有时候不能创建 HTTP 站点的问题 - 修复了有时候不能创建 HTTP 站点的问题
- 修复证书管理中,“使用站点” 不全的问题 - 修复证书管理中,“使用站点” 不全的问题
- 修复证书管理中,泛域名证书的使用站点始终提示 “域名不匹配” 的问题 - 修复证书管理中,泛域名证书的使用站点始终提示 “域名不匹配” 的问题
### [3.6.3] - 2023-10-09 ### [3.6.3] - 2023-10-09
#### 新增 #### 新增
- 新增申请免费证书。只要域名已经指向雷池,就可以在界面上直接申请证书了 - 新增申请免费证书。只要域名已经指向雷池,就可以在界面上直接申请证书了
![](/images/docs/about_changelog/cert_create.png) ![](/images/docs/about_changelog/cert_create.png)
- 证书管理新增 “使用站点”,并且会自动检查站点和证书的域名是否一致: - 证书管理新增 “使用站点”,并且会自动检查站点和证书的域名是否一致:
![](/images/docs/about_changelog/website_2.png) ![](/images/docs/about_changelog/website_2.png)
#### 优化 #### 优化
- 优化站点配置证书的流程,现在所有证书都在证书管理配置,方便统一查看 - 优化站点配置证书的流程,现在所有证书都在证书管理配置,方便统一查看
- 雷池控制台证书的配置移动到了 “通用配置” -> “其他” 中,更符合直觉: - 雷池控制台证书的配置移动到了 “通用配置” -> “其他” 中,更符合直觉:
![](/images/docs/about_changelog/mgt_cert_config.png) ![](/images/docs/about_changelog/mgt_cert_config.png)
- 修复某些情况下采集不到站点 favicon 的问题 - 修复某些情况下采集不到站点 favicon 的问题
- 修复采集站点标题的时候,会把英文大写转成小写的问题 - 修复采集站点标题的时候,会把英文大写转成小写的问题
- 修复站点详情中,删除文件夹的操作不会生效的问题 - 修复站点详情中,删除文件夹的操作不会生效的问题
@ -176,7 +176,7 @@ title: "版本更新记录"
#### 新增 #### 新增
- 人机验证新增每个规则的 “今日验证情况”,方便判断规则配置的效果: - 人机验证新增每个规则的 “今日验证情况”,方便判断规则配置的效果:
![](/images/docs/about_changelog/cs_statistics.png) ![](/images/docs/about_changelog/cs_statistics.png)
#### 优化 #### 优化
@ -199,10 +199,10 @@ title: "版本更新记录"
#### 新增 #### 新增
- “防护站点” 新增站点的标题和 Favicon每天更新一次管理起来更加清晰 - “防护站点” 新增站点的标题和 Favicon每天更新一次管理起来更加清晰
![](/images/docs/about_changelog/website_1.png) ![](/images/docs/about_changelog/website_1.png)
- 站点详情新增“采集设置”,支持设置不记录的路径前缀和类型 - 站点详情新增“采集设置”,支持设置不记录的路径前缀和类型
![](/images/docs/about_changelog/api_assets_collect1.png) ![](/images/docs/about_changelog/api_assets_collect1.png)
![](/images/docs/about_changelog/api_assets_collect2.png) ![](/images/docs/about_changelog/api_assets_collect2.png)
#### 优化 #### 优化
@ -217,9 +217,9 @@ title: "版本更新记录"
#### 新增 #### 新增
- 支持设置拦截页面附加说明([#192](https://github.com/chaitin/SafeLine/issues/192) - 支持设置拦截页面附加说明([#192](https://github.com/chaitin/SafeLine/issues/192)
![](/images/docs/about_changelog/forbidden_page_ext.png) ![](/images/docs/about_changelog/forbidden_page_ext.png)
- 频率限制新增 “人机验证” 的限制方式([#226](https://github.com/chaitin/SafeLine/issues/226) - 频率限制新增 “人机验证” 的限制方式([#226](https://github.com/chaitin/SafeLine/issues/226)
![](/images/docs/about_changelog/acl_page.png) ![](/images/docs/about_changelog/acl_page.png)
#### 优化 #### 优化
@ -259,7 +259,7 @@ title: "版本更新记录"
#### 新增 #### 新增
- 新增证书管理。自动判断域名与过期状态,配置站点时可以直接选择([#111](https://github.com/chaitin/SafeLine/issues/111)),还可以修改管理后台的证书([#201](https://github.com/chaitin/SafeLine/issues/201) - 新增证书管理。自动判断域名与过期状态,配置站点时可以直接选择([#111](https://github.com/chaitin/SafeLine/issues/111)),还可以修改管理后台的证书([#201](https://github.com/chaitin/SafeLine/issues/201)
![](/images/docs/about_changelog/mgt_cert.png) ![](/images/docs/about_changelog/mgt_cert.png)
- 新增系统信息 - 新增系统信息
#### 优化 #### 优化
@ -300,7 +300,7 @@ title: "版本更新记录"
- 优化限频配置的默认值 - 优化限频配置的默认值
- 增加 HTTP 497 错误重定向。当以 HTTP 协议访问 HTTPS 端口时,将重定向到 HTTPS[#186](https://github.com/chaitin/safeline/issues/186) - 增加 HTTP 497 错误重定向。当以 HTTP 协议访问 HTTPS 端口时,将重定向到 HTTPS[#186](https://github.com/chaitin/safeline/issues/186)
- 默认拒绝 IP 和其他非指定域名的访问。如果需要通过 IP 访问站点,可以给站点添加一个 "*" 域名([#58](https://github.com/chaitin/safeline/issues/58) - 默认拒绝 IP 和其他非指定域名的访问。如果需要通过 IP 访问站点,可以给站点添加一个 "\*" 域名([#58](https://github.com/chaitin/safeline/issues/58)
- 优化若干 UI 交互细节和文字提示 - 优化若干 UI 交互细节和文字提示
### [2.6.0] - 2023-08-10 ### [2.6.0] - 2023-08-10
@ -385,7 +385,7 @@ title: "版本更新记录"
#### 新增 #### 新增
- 支持自定义站点的 nginx conf详情可见[官网文档](/docs/faq/other#%E8%87%AA%E5%AE%9A%E4%B9%89%E7%AB%99%E7%82%B9-nginx-conf) - 支持自定义站点的 nginx conf详情可见[官网文档](/faq/other#%E8%87%AA%E5%AE%9A%E4%B9%89%E7%AB%99%E7%82%B9-nginx-conf)
- 添加/编辑站点时,自动检查端口占用情况,避免保存后配置不生效 - 添加/编辑站点时,自动检查端口占用情况,避免保存后配置不生效
- [站点列表支持按域名、端口或访问量进行排序](https://github.com/chaitin/safeline/issues/14) - [站点列表支持按域名、端口或访问量进行排序](https://github.com/chaitin/safeline/issues/14)
- [绑定 TOTP 密钥时,支持直接复制密钥;登录时的 6 位动态密码输入框,支持粘贴](https://github.com/chaitin/safeline/issues/30) - [绑定 TOTP 密钥时,支持直接复制密钥;登录时的 6 位动态密码输入框,支持粘贴](https://github.com/chaitin/safeline/issues/30)

View file

@ -1,8 +1,8 @@
// @ts-check // @ts-check
// Note: type annotations allow type checking and IDEs autocompletion // Note: type annotations allow type checking and IDEs autocompletion
const lightCodeTheme = require("prism-react-renderer/themes/github"); // const lightCodeTheme = require("prism-react-renderer/themes/github");
const darkCodeTheme = require("prism-react-renderer/themes/dracula"); // const darkCodeTheme = require("prism-react-renderer/themes/dracula");
/** @type {import('@docusaurus/types').Config} */ /** @type {import('@docusaurus/types').Config} */
const config = { const config = {
@ -14,12 +14,12 @@ const config = {
url: "https://waf-ce.chaitin.cn/", url: "https://waf-ce.chaitin.cn/",
// Set the /<baseUrl>/ pathname under which your site is served // Set the /<baseUrl>/ pathname under which your site is served
// For GitHub pages deployment, it is often '/<projectName>/' // For GitHub pages deployment, it is often '/<projectName>/'
baseUrl: "/", baseUrl: "/docs",
// GitHub pages deployment config. // GitHub pages deployment config.
// If you aren't using GitHub pages, you don't need these. // If you aren't using GitHub pages, you don't need these.
organizationName: "chaitin", // Usually your GitHub org/user name. organizationName: "chaitin", // Usually your GitHub org/user name.
projectName: "safeline-docs", // Usually your repo name. projectName: "document", // Usually your repo name.
onBrokenLinks: "throw", onBrokenLinks: "throw",
onBrokenMarkdownLinks: "warn", onBrokenMarkdownLinks: "warn",
@ -56,15 +56,12 @@ const config = {
/** @type {import('@docusaurus/preset-classic').Options} */ /** @type {import('@docusaurus/preset-classic').Options} */
({ ({
docs: { docs: {
routeBasePath: "/",
sidebarPath: require.resolve("./sidebars.js"), sidebarPath: require.resolve("./sidebars.js"),
// Remove this to remove the "edit this page" links. // Remove this to remove the "edit this page" links.
// editUrl: "https://github.com/chaitin/safeline/tree/main/website", // editUrl: "https://github.com/chaitin/safeline/tree/main/website",
}, },
blog: { blog: false,
showReadingTime: true,
// Remove this to remove the "edit this page" links.
// editUrl: "https://github.com/chaitin/safeline/tree/main/website",
},
theme: { theme: {
customCss: require.resolve("./src/css/custom.css"), customCss: require.resolve("./src/css/custom.css"),
}, },
@ -105,22 +102,22 @@ const config = {
{ {
title: "资源", title: "资源",
items: [ items: [
{ // {
label: "技术文档", // label: "技术文档",
to: "/docs", // to: "/",
}, // },
{ {
label: "教学视频", label: "教学视频",
to: "https://www.bilibili.com/medialist/detail/ml2342694989", to: "https://www.bilibili.com/medialist/detail/ml2342694989",
}, },
{ // {
label: "学习资料", // label: "学习资料",
to: "/docs", // to: "/",
}, // },
{ // {
label: "更新日志", // label: "更新日志",
to: "/docs/about/changelog", // to: "/about/changelog",
}, // },
], ],
}, },
{ {
@ -140,8 +137,8 @@ const config = {
copyright: `Copyright © ${new Date().getFullYear()} 北京长亭科技有限公司.All rights reserved.`, copyright: `Copyright © ${new Date().getFullYear()} 北京长亭科技有限公司.All rights reserved.`,
}, },
prism: { prism: {
theme: lightCodeTheme, // theme: lightCodeTheme,
darkTheme: darkCodeTheme, // darkTheme: darkCodeTheme,
}, },
colorMode: { colorMode: {
defaultMode: 'light', defaultMode: 'light',

File diff suppressed because it is too large Load diff

View file

@ -16,26 +16,26 @@
"typecheck": "tsc" "typecheck": "tsc"
}, },
"dependencies": { "dependencies": {
"@docusaurus/core": "2.4.1", "@docusaurus/core": "3.0.0",
"@docusaurus/preset-classic": "2.4.1", "@docusaurus/preset-classic": "3.0.0",
"@easyops-cn/docusaurus-search-local": "^0.35.0", "@easyops-cn/docusaurus-search-local": "0.37.4",
"@emotion/react": "11.11.1", "@emotion/react": "11.11.1",
"@emotion/styled": "11.11.0", "@emotion/styled": "11.11.0",
"@mdx-js/react": "^1.6.22", "@mdx-js/react": "3.0.0",
"@mui/icons-material": "5.14.3", "@mui/icons-material": "5.14.3",
"@mui/lab": "5.0.0-alpha.138", "@mui/lab": "5.0.0-alpha.138",
"@mui/material": "5.14.3", "@mui/material": "5.14.3",
"clsx": "^1.2.1", "clsx": "^1.2.1",
"countup.js": "2.7.0", "countup.js": "2.7.0",
"prism-react-renderer": "^1.3.5", "prism-react-renderer": "2.1.0",
"react": "^17.0.2", "react": "18.2.0",
"react-dom": "^17.0.2", "react-dom": "18.2.0",
"react-responsive-carousel": "3.2.23" "react-responsive-carousel": "3.2.23"
}, },
"devDependencies": { "devDependencies": {
"@docusaurus/module-type-aliases": "2.4.1", "@docusaurus/module-type-aliases": "3.0.0",
"@tsconfig/docusaurus": "^1.0.5", "@tsconfig/docusaurus": "^1.0.5",
"typescript": "^4.7.4" "typescript": "5.2.2"
}, },
"browserslist": { "browserslist": {
"production": [ "production": [
@ -50,6 +50,6 @@
] ]
}, },
"engines": { "engines": {
"node": ">=16.14" "node": ">=18"
} }
} }

File diff suppressed because it is too large Load diff