Skip to content

Commit

Permalink
docs: 更新文档
Browse files Browse the repository at this point in the history
  • Loading branch information
devhaozi committed Oct 10, 2024
1 parent 342bf62 commit bee61fa
Show file tree
Hide file tree
Showing 3 changed files with 22 additions and 20 deletions.
17 changes: 9 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,12 +22,12 @@

## 优势

1. **极低占用:** 在 Debian 12 下部署面板 + LNMP 环境,内存占用不到 500 MB,遥遥领先于使用容器化的其他面板。
1. **极低占用:** 在 Debian 下部署面板 + LNMP 环境,内存占用不到 500 MB,遥遥领先于使用容器化的其他面板。
2. **低破坏性:** 面板的设计理念是尽可能减少对系统的额外修改,在同类面板中,我们对系统的修改最少。
3. **追随时代:** 面板所有组件均走在时代前沿,更新快,功能强大,安全性有保障。
4. **高效运维:** 面板 UI 界面简洁,操作简单,无需繁琐的配置,即可快速部署各类环境、调整应用设置。
4. **高效运维:** 面板界面简洁,操作简单,无需繁琐的配置,即可快速部署各类环境、调整应用设置。
5. **离线运行:** 面板运行可不依赖任何外部服务,你甚至可以在部署完成后停止面板进程,不会对已部署服务造成任何影响。
6. **久经考验:** 我们生产环境自 2022 年即开始使用,已稳定运行 1 年以上无事故
6. **久经考验:** 我们生产环境自 2022 年即开始使用,已稳定运行 2 年无事故
7. **开源开放:** 面板开源,你可以自由修改、审计面板源码,安全性有保障。

## UI 截图
Expand Down Expand Up @@ -57,7 +57,7 @@
## 安装面板

> **Warning**
> 安装面板前,你需要了解 LNMP 环境的基本知识,以及如何处理常见的 LNMP 环境问题,不建议 0 基础的用户安装和使用耗子面板。
> 安装面板前,你需要了解 LNMP 环境的基本知识,以及如何处理常见的 LNMP 环境问题,我们不建议 0 基础的用户安装和使用耗子面板。
如果你决定继续,请以`root`用户登录服务器,执行以下命令安装面板:

Expand All @@ -79,13 +79,13 @@ curl -fsLm 10 -o uninstall_panel.sh https://dl.cdn.haozi.net/panel/uninstall_pan

## 日常维护

使用`panel`命令进行日常维护:
使用`panel-cli`命令进行日常维护:

```shell
panel
panel-cli
```

[Wiki](https://github.com/TheTNB/panel/wiki) 中查看更多使用方法和技巧。
[文档](https://tom.moe/docs?category=57) 中查看更多使用方法和技巧。

## 问题反馈

Expand All @@ -99,13 +99,14 @@ panel

**同时接受云资源赞助,可通过QQ群咨询联系**

### 服务器
### 资金

- [微晓朵](https://www.weixiaoduo.com/)

### CDN

- [无畏云加速](https://su.sctes.com/register?code=8st689ujpmm2p)
- [WAF PRO](https://waf.pro/)
- [盾云CDN](http://cdn.ddunyun.com/)

<p align="center">
Expand Down
17 changes: 9 additions & 8 deletions README_EN.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,12 +22,12 @@ Communication QQ group: [12370907](https://jq.qq.com/?_wv=1027&k=I1oJKSTH) | For

## Advantages

1. **Extremely low usage:** Deploying the panel + LNMP environment under Debian 12, the memory usage is less than 500 MB, far ahead of other panels using containerization.
1. **Extremely low usage:** Deploying the panel + LNMP environment under Debian, the memory usage is less than 500 MB, far ahead of other panels using containerization.
2. **Low destructiveness:** The design concept of the panel is to minimize the additional modifications to the system. Among similar panels, we have made the least modifications to the system.
3. **Follow the times:** All components of the panel are at the forefront of the times, updated quickly, powerful functions, and guaranteed security.
4. **Efficient operation and maintenance:** The panel UI interface is simple and easy to operate, and you can quickly deploy various environments and adjust application settings without complicated configuration.
4. **Efficient operation and maintenance:** The panel is simple and easy to operate, and you can quickly deploy various environments and adjust application settings without complicated configuration.
5. **Offline operation:** The panel can run without relying on any external services. You can even stop the panel process after deployment is complete, and it will not affect the deployed services.
6. **Tested by time:** We have been using it in production environment since 2022, and it has been running stably for more than 1 year without any accidents.
6. **Tested by time:** We have been using it in production environment since 2022, and it has been running stably for 2 year without any accidents.
7. **Open source and open:** The panel is open source, you can freely modify and audit the panel source code, and the security is guaranteed.

## UI Screenshots
Expand Down Expand Up @@ -57,7 +57,7 @@ As system versions are constantly updated, we may also terminate support for som
## Install Panel

> **Warning**
> Before installing the panel, you need to understand the basic knowledge of the LNMP environment and how to deal with common LNMP environment problems. It is not recommended for users with zero basic knowledge to install and use Rat Panel.
> Before installing the panel, you need to understand the basic knowledge of the LNMP environment and how to deal with common LNMP environment problems. We are not recommended for users with zero basic knowledge to install and use Rat Panel.
If you decide to continue, please log in to the server as `root` user and execute the following command to install the panel:

Expand All @@ -79,13 +79,13 @@ Before uninstalling the panel, please be sure to back up all data and uninstall

## Daily Maintenance

Use `panel` command for daily maintenance:
Use `panel-cli` command for daily maintenance:

```shell
panel
panel-cli
```

See more usage methods and tips in [Wiki](https://github.com/TheTNB/panel/wiki).
See more usage methods and tips in [Document](https://tom.moe/docs?category=57).

## Feedback

Expand All @@ -99,13 +99,14 @@ If the Rat Panel is helpful to you, welcome to [sponsor us](https://opencollecti

**Accept cloud resources and financial sponsorship, you can contact us through QQ group**

### Server
### Financial

- [微晓朵](https://www.weixiaoduo.com/)

### CDN

- [无畏云加速](https://su.sctes.com/register?code=8st689ujpmm2p)
- [WAF PRO](https://waf.pro/)
- [盾云CDN](http://cdn.ddunyun.com/)

<p align="center">
Expand Down
8 changes: 4 additions & 4 deletions SECURITY.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,10 @@

如果您在使用面板的过程中发现任何安全问题,请勿提交 Issue,可通过以下方式直接联系我们:

- 邮箱:i@haozi.net
- 邮箱:admin@haozi.net
- QQ:826896000

致某些 CVE 爱好者:通过面板 `access_token` 执行的任何操作(包括且不限于:获取 root 权限、读取/写入系统敏感文件、执行任意 shell 命令等)均不被认为是安全问题,请不要刷此类报告浪费彼此的时间,这类低水平的报告对你的简历也没有任何帮助。
致某些 CVE 爱好者:通过面板 `session` / `access_token` 执行的任何操作(包括且不限于:获取 root 权限、读取/写入系统敏感文件、执行任意 shell 命令等)均不被认为是安全问题,请不要刷此类报告浪费彼此的时间,这类低水平的报告对你的简历也没有任何帮助。

## Security Policy

Expand All @@ -19,7 +19,7 @@ Rat Panel adopts various solutions in the industry to ensure the security of the

If you find any security issues while using the panel, please do not submit an Issue. You can contact us directly through the following methods:

- Email: i@haozi.net
- Email: admin@haozi.net
- Telegram: @devhaozi

To some CVE enthusiasts: Any operation performed through the panel `access_token` (including but not limited to: obtaining root permissions, reading/writing system sensitive files, executing arbitrary shell commands, etc.) is not considered a security issue, please Don’t waste each other’s time with these types of reports. These low-level reports won’t do anything to help your resume.
To some CVE enthusiasts: Any operation performed through the panel `session` / `access_token` (including but not limited to: obtaining root permissions, reading/writing system sensitive files, executing arbitrary shell commands, etc.) is not considered a security issue, please Don’t waste each other’s time with these types of reports. These low-level reports won’t do anything to help your resume.

0 comments on commit bee61fa

Please sign in to comment.