📝 部署文档更新

This commit is contained in:
chaos-zhu 2024-08-18 16:07:30 +08:00
parent 6b61ad6764
commit 3266edd418

View File

@ -1,54 +1,41 @@
# EasyNode
> [!WARNING]
> 初次部署EasyNode登录系统后务必记得修改默认账户密码 `admin/admin`
> [!WARNING]
> 强烈建议使用 **iptables** 限制IP访问谨慎暴露面板服务到公网
> [!NOTE]
> webssh与监控服务都将以`该服务器作为中转`。中国大陆连接建议使用香港、新加坡、日本、韩国等地区的低延迟服务器来安装服务端面板
- [功能](#功能)
<!-- - [功能](#功能)
- [安装](#安装)
- [服务端安装](#服务端安装)
- [监控服务安装](#监控服务安装)
- [监控服务安装](#监控服务安装)
- [版本日志](#版本日志)
- [开发](#开发)
- [QA](#QA)
- [安全与建议](#安全与建议)
- [捐赠](#捐赠)
- [License](#license)
- [License](#license) -->
## 功能
- [x] 功能完善的SSH终端&SFTP
- [x] 批量导入导出实例(Xshell&FinalShell&EasyNode)
- [x] 实例分组
- [x] 凭据托管
- [x] 邮件通知
- [x] 服务器状态推送
- [x] 脚本库
- [x] 批量指令
- [x] 终端主题背景图
- [x] 功能完善的**SSH终端**&**SFTP**
- [x] 批量**导入导出**实例(Xshell&FinalShell&EasyNode)
- [x] **实例分组**
- [x] **凭据托管**
- [x] **多渠道通知**
- [x] **脚本库**
- [x] **批量指令**
- [x] **终端主题背景自定义**
![实例面板](./doc_images/merge.gif)
## 安装
### 服务端安装
- 默认账户密码 `admin/admin`
- web端口8082
- 占用端口8082 推荐使用docker镜像安装
#### Docker部署
### docker镜像
```shell
docker run -d --net=host --name=easynode-server -v $PWD/easynode/db:/easynode/app/db chaoszhu/easynode
# 容器支持使用-p 8082:8082映射端口, 但无法记录登录IP
docker run -d --net=host --name=easynode-server -v /root/easynode/db:/easynode/app/db chaoszhu/easynode
# 容器支持使用-p 8082:8082映射端口, 但无法记录登录IP
```
访问http://yourip:8082
#### 手动部署
### 手动部署
依赖Nodejs版本 > 20+
@ -65,16 +52,9 @@ yarn start
pm2 start index.js --name easynode-server
```
访问http://yourip:8082
- 查看日志:`pm2 log easynode-server`
- 启动服务:`pm2 start easynode-server`
- 停止服务:`pm2 stop easynode-server`
- 删除服务:`pm2 delete easynode-server`
---
### 监控服务安装
## 监控服务安装
- 监控服务用于实时向服务端推送**系统、公网IP、CPU、内存、硬盘、网卡**等基础信息不安装不影响使用面板但是无法实时同步cpu占用、实时网速、硬盘容量等有用信息。
@ -100,10 +80,6 @@ curl -o- https://mirror.ghproxy.com/https://raw.githubusercontent.com/chaos-zhu/
---
## 版本日志
- [CHANGELOG](./CHANGELOG.md)
## 开发
1. 拉取代码,环境 `nodejs``>=20`
@ -111,10 +87,22 @@ curl -o- https://mirror.ghproxy.com/https://raw.githubusercontent.com/chaos-zhu/
3. `yarn dev`启动项目
4. web: `http://localhost:18090/`
## 版本日志
- [CHANGELOG](./CHANGELOG.md)
## QA
- [QA](./Q%26A.md)
## 安全与建议
首先声明任何系统无法保障没有bug的存在EasyNode也一样。
建议使用 **iptables** 限制IP访问或者不将面板服务暴露到公网能使得安全性大大提升。
webssh与监控服务都将以`该服务器作为中转`。中国大陆用户建议使用香港、新加坡、日本、韩国等地区的低延迟服务器来安装服务端面板
## 捐赠
如果您认为此项目帮到了您, 您可以请我喝杯阔乐~