easynode/README.md
zhulj 9c05da023f
2022-06-08 16:47:41 +08:00

123 lines
2.8 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# EasyNode
> 一个简易的个人Linux服务器管理面板(基于Node.js)
## 功能
> 通过`websocker实时更新`服务器基本信息: **系统、公网IP、CPU、内存、硬盘、网卡**等
![服务器列表](./images/list.png)
> 解决`SSH跨端同步`问题——**Web SSH**
![webssh功能](./images/webssh.png)
## 安装指南
### 服务端安装
- 依赖Node.js环境
- 建议使用**境外服务器(最好延迟低)**安装服务端客户端信息监控与webssh功能都将以`该服务器作为跳板机`
- 占用端口8082(http端口)、8083(https端口)、22022(客户端端口)
#### Docker镜像
> 注意网速统计功能可能受限预计v2.0版本修复
> https服务需自行配置证书然后构建镜像或者使用`nginx反代`解决(推荐)
- docker run -d -p 8082:8082 -p 22022:22022 easynode
#### 一键脚本
> 编写中...
<!-- ```shell
# 国外环境
wget -N --no-check-certificate xxx && bash easynode-server-install.sh
# 国内环境
wget -N --no-check-certificate xxx && bash easynode-server-install.sh
``` -->
#### 手动部署
1. 安装Node.js
2. 拉取代码:
3. 安装依赖:
4. 配置域名:
5. 启动服务:
6. 访问http://domain:8082
- 默认登录密码admin(首次部署完成后请及时修改).
6. 部署https服务
- 部署https服务需要自己上传域名证书至`\server\app\config\pem`,并且证书和私钥分别命名:`key.pem`和`cert.pem`
- 不出意外你就可以访问https服务https://domain:8083
---
### 客户端安装
> 占用端口22022
> 支持后续一键升级、支持重复安装
```shell
# 国外环境
wget -N --no-check-certificate xxx && bash easynode-client-install.sh
# 国内环境
wget -N --no-check-certificate xxx && bash easynode-client-install.sh
```
> 卸载:无任何文件或服务残留
```shell
# 国外环境
wget -N --no-check-certificate xxx && bash easynode-client-uninstall.sh
# 国内环境
wget -N --no-check-certificate xxx && bash easynode-client-uninstall.sh
```
> 查看客户端日志
```shell
journalctl --follow -u easynode-client
```
---
## 安全与说明
> 本人非专业后端,此服务全凭兴趣开发. 由于知识受限,并不能保证没有漏洞的存在,生产服务器请慎重使用此服务.
> 所有服务器信息相关接口已做`jwt鉴权`
> webssh功能需要的密钥信息全部保存在服务端服务器的`app\config\storage\ssh-record.json`中. 在保存ssh密钥信息到服务器时v1.0版本未做加密,`如果使用此功能最好带上https`, 并且保管好你的服务端服务器密码.
## 技术架构
> 待更新...
## v2.0功能方向
- 终端快捷键
- 终端常用指令
- 终端多tab支持
- 终端主题
- FTP文件系统
- 支持完整功能的docker镜像
## License
[MIT](LICENSE). Copyright (c).