Skip to content

Commit 083f178

Browse files
committed
Refactor installer for malefic bundle and optional systemd
1 parent 08a7cca commit 083f178

5 files changed

Lines changed: 648 additions & 349 deletions

File tree

docs/getting-started.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ Release 中的主要二进制如下:
2121
首次启动可使用交互式向导:
2222

2323
```bash
24-
./malice_network_linux_amd64 --quickstart
24+
./malice-network_linux_amd64 --quickstart
2525
```
2626

2727
向导会生成初始化所需的核心配置:
@@ -38,7 +38,7 @@ Release 中的主要二进制如下:
3838
已从 `server/config.example.yaml` 复制出本地 `config.yaml` 后,可直接启动:
3939

4040
```bash
41-
./malice_network_linux_amd64 -i <public-ip>
41+
./malice-network_linux_amd64 -i <public-ip>
4242
```
4343

4444
常用参数:
@@ -58,6 +58,13 @@ Release 中的主要二进制如下:
5858
- `admin_<server-ip>.auth`: client 登录凭证
5959
- `listener.auth`: 默认 listener 的 mTLS 凭证
6060

61+
如果你使用安装脚本并跳过了 `systemd`,推荐在安装目录中手动启动:
62+
63+
```bash
64+
cd /opt/iom/malice-network
65+
./malice-network_linux_amd64 -i <public-ip>
66+
```
67+
6168
## 3. 登录 Client
6269

6370
`admin_<server-ip>.auth` 放到 client 可访问的位置后执行:

docs/operations/deployment.md

Lines changed: 29 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -37,9 +37,9 @@ sudo -E bash install.sh
3737

3838
脚本会提示输入:
3939

40-
1. 安装路径(默认 `/iom`):
40+
1. 安装路径(默认 `/opt/iom`):
4141
```
42-
Please input the base directory for the installation [default: /iom]:
42+
Please input the base directory for the installation [default: /opt/iom]:
4343
```
4444

4545
2. IP 地址(自动检测):
@@ -48,11 +48,22 @@ sudo -E bash install.sh
4848
```
4949

5050
**安装脚本自动完成:**
51-
1. 检查并安装 Docker
52-
2. 下载并安装 Malice-Network 服务端及客户端
53-
3. 下载并安装 Malefic 源码及工具
54-
4. 拉取 Docker 镜像(约 8.21GB):`ghcr.io/chainreactors/malefic-builder:latest`
55-
5. 配置并启动服务(基于 systemd)
51+
1. 检查基础依赖(`curl``unzip`
52+
2. 下载并安装 Malice Network 服务端及客户端
53+
3. 下载 `malefic.zip`,并解压到 `./malefic/source_code`
54+
4. 拉取 Docker 镜像:`ghcr.io/chainreactors/malefic-builder:latest`
55+
5. 可选配置并启动 systemd 服务;如跳过,则输出手动启动命令
56+
57+
**安装完成后的工作目录结构:**
58+
59+
```text
60+
<base-dir>/malice-network/
61+
├── malice-network_linux_amd64
62+
├── malice_network_linux_amd64 -> malice-network_linux_amd64
63+
├── iom_linux_amd64
64+
└── malefic/
65+
└── source_code/
66+
```
5667

5768
### 下载 Release 部署
5869

@@ -61,16 +72,18 @@ Windows 或 macOS 系统部署 Server,从 [Releases](https://github.com/chainr
6172
- `iom_*` - Client 端
6273
- `malice_network_*` - Server 端
6374

75+
如果你使用安装脚本,脚本会把 Linux 服务端二进制归一命名为 `malice-network_linux_amd64`;如果你是手动下载 release,请按实际文件名执行。
76+
6477
启动 Server:
6578

6679
```bash
67-
./malice_network_linux_amd64
80+
./malice-network_linux_amd64
6881
```
6982

7083
指定 IP 启动(Client 可访问的 IP,如公网 IP):
7184

7285
```bash
73-
./malice_network_linux_amd64 -i 123.123.123.123
86+
./malice-network_linux_amd64 -i 123.123.123.123
7487
```
7588

7689
### Server 启动参数
@@ -136,6 +149,13 @@ Listener 和编译配置详见 [listeners.md](server/listeners.md) 和 [build.md
136149
137150
## 启动 Client
138151
152+
如果安装时跳过了 systemd,可手动启动:
153+
154+
```bash
155+
cd /opt/iom/malice-network
156+
./malice-network_linux_amd64 -i <server-ip>
157+
```
158+
139159
Server 启动后生成两个配置文件:
140160
- `listener.auth` - Listener 凭证
141161
- `admin_[server_ip].auth` - Client 登录凭证

docs/server/quickstart.md

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,8 @@
1212
- `malice_network_darwin_arm64` — macOS Apple Silicon
1313
- `malice_network_windows_amd64.exe` — Windows x86_64
1414

15+
如果你使用安装脚本,脚本会把 Linux 服务端二进制归一命名为 `malice-network_linux_amd64`。如果你是手动下载 release,请按实际下载下来的文件名执行。
16+
1517
!!! tip "网络问题"
1618
国内服务器下载 GitHub release 可能超时,建议配置代理:
1719
```bash
@@ -22,7 +24,7 @@
2224
## 首次启动
2325

2426
```bash
25-
./malice-network -i <公网IP>
27+
./malice-network_linux_amd64 -i <公网IP>
2628
```
2729

2830
!!! important "IP 设置"
@@ -46,25 +48,25 @@
4648
首次使用或需要重新配置时,可以使用交互式向导:
4749

4850
```bash
49-
./malice-network --quickstart
51+
./malice-network_linux_amd64 --quickstart
5052
```
5153

5254
向导会引导完成 IP、端口、构建源等基础配置。
5355

5456
## 使用安装脚本(Linux)
5557

56-
!!! info "安装脚本会自动完成 Docker 安装、Server/Client 下载、构建镜像拉取和 systemd 配置"
58+
!!! info "安装脚本会自动完成 Docker 安装、Server/Client 下载、malefic.zip 解压,并可选配置 systemd"
5759

5860
```bash
5961
curl -L "https://raw.githubusercontent.com/chainreactors/malice-network/master/install.sh" | sudo bash
6062
```
6163

6264
安装脚本会交互式询问:
6365

64-
- **安装路径**:默认 `/iom`
66+
- **安装路径**:默认 `/opt/iom`
6567
- **IP 地址**:自动检测,可手动修改
6668

67-
安装完成后 Server 会以 systemd 服务运行
69+
安装完成后,脚本会询问是否安装并启动 systemd 服务;如果跳过,会直接输出手动启动命令
6870

6971
## 防火墙配置
7072

@@ -99,11 +101,11 @@ pipeline # 查看 Pipeline 列表
99101

100102
| 模式 | 命令 | 场景 |
101103
|------|------|------|
102-
| 标准启动 | `./malice-network -i <ip>` | Server + Listener 一起运行 |
103-
| 仅 Server | `./malice-network --server-only` | Listener 独立部署时 |
104-
| 仅 Listener | `./malice-network --listener-only` | 独立 Listener 节点 |
105-
| 守护进程 | `./malice-network --daemon` | 后台运行 |
106-
| 交互向导 | `./malice-network --quickstart` | 首次配置 |
104+
| 标准启动 | `./malice-network_linux_amd64 -i <ip>` | Server + Listener 一起运行 |
105+
| 仅 Server | `./malice-network_linux_amd64 --server-only` | Listener 独立部署时 |
106+
| 仅 Listener | `./malice-network_linux_amd64 --listener-only` | 独立 Listener 节点 |
107+
| 守护进程 | `./malice-network_linux_amd64 --daemon` | 后台运行 |
108+
| 交互向导 | `./malice-network_linux_amd64 --quickstart` | 首次配置 |
107109

108110
## 下一步
109111

0 commit comments

Comments
 (0)