|
1 | | -# 程序部署 |
2 | | - |
3 | | - |
4 | | - |
5 | | -::: tip |
6 | | - |
7 | | -v1版本请参考本文 |
8 | | - |
9 | | - ::: |
10 | | - |
11 | | - |
12 | | - |
13 | | -## 获取路由器key |
14 | | - |
15 | | -通常情况下，key是恒定的，但我依然推荐你检查一番 |
16 | | - |
17 | | -> 可以使用[自动程序](/download/mikvivator)获取 |
18 | | -
|
19 | | -在路由器登录页面按下右键，选择查看源代码，搜索`Encrypt`，提取下面`key`字段的内容 |
20 | | - |
21 | | - |
22 | | - |
23 | | -## 安装/运行 |
24 | | - |
25 | | -### Docker 部署 |
26 | | - |
27 | | -> 对于一些支持docker的小米路由器，也可以尝试使用docker运行 |
28 | | -
|
29 | | -推荐使用 Docker 部署，执行命令创建容器： |
30 | | - |
31 | | -``` |
32 | | -docker run -d \ |
33 | | - --name mirouter-ui \ |
34 | | - -p 6789:6789 \ |
35 | | - -v $(pwd):/app/data \ |
36 | | - --restart=always \ |
37 | | - thun888/mirouter-ui |
38 | | -``` |
39 | | - |
40 | | -::: tip |
41 | | - |
42 | | -Docker的端口映射命令参数为`-p 外部端口:内部端口`。若需修改端口，仅需要修改外部端口即可，且在配置文件中无需修改端口配置。 |
43 | | - |
44 | | -如果无法拉取镜像，请尝试更改镜像源 |
45 | | - |
46 | | - ::: |
47 | | - |
48 | | -该命令会在当前目录下创建容器，配置文件及数据库一并储存在该目录下。 |
49 | | - |
50 | | -修改配置文件即可 |
51 | | - |
52 | | -### 普通方式部署 |
53 | | - |
54 | | -MRUI采用`Golang`编写，仅需下载二进制文件即可执行。你可以访问[Release](https://github.com/Mirouterui/mirouter-ui/releases/)来获取最新版本，但鉴于GitHub在国内的访问情况，你还可以从[镜像站](https://mrui-api.hzchu.top/down/)下载。 |
55 | | - |
56 | | -1. 下载对应架构的程序（在早期测试中观察到部分路由器与upx存在兼容性问题，如无法运行可尝试`_noupx`版本） |
57 | | -2. 运行，在程序导出配置后会自动关闭 |
58 | | -3. 修改配置 |
59 | | -4. 再次运行，若未开启`tiny`模式会在下载完静态资源再后开启web服务 |
60 | | -5. 尝试访问`http://ip:port`吧 |
61 | | - |
62 | | -::: note |
63 | | - |
64 | | -若需要部署到路由器上可参考[这里](/guide/deploytorouter.md) |
65 | | - |
66 | | - ::: |
67 | | - |
68 | | -## 配置文件 |
69 | | - |
70 | | -在看到配置文件后，来看一下配置项的含义吧 |
71 | | - |
72 | | -```json |
73 | | -{ |
74 | | - "dev": [{ |
75 | | - "password": "", |
76 | | - "key": "a2ffa5c9be07488bbb04a3a47d3c5f6a", |
77 | | - "ip": "192.168.31.1", |
78 | | - "routerunit": false |
79 | | - }], |
80 | | - "history": { |
81 | | - "enable": false, |
82 | | - "sampletime": 300, |
83 | | - "maxsaved": 8640 |
84 | | - }, |
85 | | - "netdata_routerid": 0, |
86 | | - "flushTokenTime": 1800, |
87 | | - "tiny": false, |
88 | | - "port": 6789, |
89 | | - "debug": true |
90 | | -} |
91 | | -``` |
92 | | - |
93 | | -**配置项：** |
94 | | - |
95 | | -| 配置名 | 默认值 | 解释 | |
96 | | -| ---------------- | ------ | ------------------------------------------------------------ | |
97 | | -| dev | [] | 路由器信息，参阅`dev项` | |
98 | | -| history | [] | 历史记录相关功能，参阅`history项` | |
99 | | -| tiny | false | 启用后，不再下载静态文件，需搭配[在线前端](http://mrui-web.hzchu.top/)使用 | |
100 | | -| netdata_routerid | 0 | 调用netdata api时返回的路由器（对应dev项中第n个） | |
101 | | -| flushTokenTime | 1800 | 刷新token时间间隔(s) | |
102 | | -| port | 6789 | 网页页面端口号 | |
103 | | -| debug | true | debug模式，建议在测试正常后关闭 | |
104 | | - |
105 | | -**dev**字段是一个数组，内含的每个元素包含单个设备的配置信息。数组中的每个对象描述如下： |
106 | | - |
107 | | -| 配置名 | 默认值 | 解释 | |
108 | | -| ---------- | -------------------------------- | ------------------------------------------------------------ | |
109 | | -| password | | 路由器密码 | |
110 | | -| key | a2ffa5c9be07488bbb04a3a47d3c5f6a | 路由器key（如果和前文获取的不同，请更改为自己获取的） | |
111 | | -| ip | 192.168.31.1 | 路由器IP | |
112 | | -| routerunit | false | 启用后，程序通过`gopsutil`库获取CPU占用，在支持的路由器上获取温度 | |
113 | | - |
114 | | -> 配置多个对象以使用多路由模式，但要注意，如果使用有线/无线组网，数据统计由主路由负责，子路由无法获取信息属于正常情况 |
115 | | -
|
116 | | -**history**项： |
117 | | - |
118 | | -| 配置名 | 默认值 | 解释 | |
119 | | -| ---------- | ------ | -------------------- | |
120 | | -| enable | false | 是否启用历史数据统计 | |
121 | | -| sampletime | 300 | 采样时间间隔(s) | |
122 | | -| maxsaved | 8640 | 最多记录条数 | |
123 | | - |
124 | | -::: tip |
125 | | - |
126 | | -保存数据条数过多可能会造成前端页面卡顿。同时，为了减小历史数据拟合时产生的误差，sampletime应不超过600 |
127 | | - |
128 | | - ::: |
| 1 | +# 程序部署 |
| 2 | + |
| 3 | + |
| 4 | + |
| 5 | +::: tip |
| 6 | + |
| 7 | +v1版本请参考本文 |
| 8 | + |
| 9 | + ::: |
| 10 | + |
| 11 | + |
| 12 | + |
| 13 | +## 获取路由器key |
| 14 | + |
| 15 | +通常情况下，key是恒定的，但我依然推荐你检查一番 |
| 16 | + |
| 17 | +> 可以使用[自动程序](/download/mikvivator)获取 |
| 18 | +
|
| 19 | +在路由器登录页面按下右键，选择查看源代码，搜索`Encrypt`，提取下面`key`字段的内容 |
| 20 | + |
| 21 | + |
| 22 | + |
| 23 | +## 安装/运行 |
| 24 | + |
| 25 | +### Docker 部署 |
| 26 | + |
| 27 | +> 对于一些支持docker的小米路由器，也可以尝试使用docker运行 |
| 28 | +
|
| 29 | +推荐使用 Docker 部署，执行命令创建容器： |
| 30 | + |
| 31 | +``` |
| 32 | +docker run -d \ |
| 33 | + --name mirouter-ui \ |
| 34 | + -p 6789:6789 \ |
| 35 | + -v $(pwd):/app/data \ |
| 36 | + --restart=always \ |
| 37 | + thun888/mirouter-ui |
| 38 | +``` |
| 39 | + |
| 40 | +::: tip |
| 41 | + |
| 42 | +Docker的端口映射命令参数为`-p 外部端口:内部端口`。若需修改端口，仅需要修改外部端口即可，且在配置文件中无需修改端口配置。 |
| 43 | + |
| 44 | +如果无法拉取镜像，请尝试更改镜像源 |
| 45 | + |
| 46 | + ::: |
| 47 | + |
| 48 | +该命令会在当前目录下创建容器，配置文件及数据库一并储存在该目录下。 |
| 49 | + |
| 50 | +修改配置文件即可 |
| 51 | + |
| 52 | +### 普通方式部署 |
| 53 | + |
| 54 | +MRUI采用`Golang`编写，仅需下载二进制文件即可执行。你可以访问[Release](https://github.com/Mirouterui/mirouter-ui/releases/)来获取最新版本，但鉴于GitHub在国内的访问情况，你还可以从[镜像站](https://mrui-api.hzchu.top/down/)下载。 |
| 55 | + |
| 56 | +1. 下载对应架构的程序（在早期测试中观察到部分路由器与upx存在兼容性问题，如无法运行可尝试`_noupx`版本） |
| 57 | +2. 运行，在程序导出配置后会自动关闭 |
| 58 | +3. 修改配置 |
| 59 | +4. 再次运行，若未开启`tiny`模式会在下载完静态资源再后开启web服务 |
| 60 | +5. 尝试访问`http://ip:port`吧 |
| 61 | + |
| 62 | +::: note |
| 63 | + |
| 64 | +若需要部署到路由器上可参考[这里](/guide/deploytorouter.md) |
| 65 | + |
| 66 | + ::: |
| 67 | + |
| 68 | +## 配置文件 |
| 69 | + |
| 70 | +在看到配置文件后，来看一下配置项的含义吧 |
| 71 | + |
| 72 | +```json |
| 73 | +{ |
| 74 | + "dev": [{ |
| 75 | + "password": "", |
| 76 | + "key": "a2ffa5c9be07488bbb04a3a47d3c5f6a", |
| 77 | + "ip": "192.168.31.1", |
| 78 | + "routerunit": false |
| 79 | + }], |
| 80 | + "history": { |
| 81 | + "enable": false, |
| 82 | + "sampletime": 300, |
| 83 | + "maxsaved": 8640 |
| 84 | + }, |
| 85 | + "netdata_routerid": 0, |
| 86 | + "flushTokenTime": 1800, |
| 87 | + "tiny": false, |
| 88 | + "port": 6789, |
| 89 | + "debug": true |
| 90 | +} |
| 91 | +``` |
| 92 | + |
| 93 | +**配置项：** |
| 94 | + |
| 95 | +| 配置名 | 默认值 | 解释 | |
| 96 | +| ---------------- | ------ | ------------------------------------------------------------ | |
| 97 | +| dev | [] | 路由器信息，参阅`dev项` | |
| 98 | +| history | [] | 历史记录相关功能，参阅`history项` | |
| 99 | +| tiny | false | 启用后，不再下载静态文件，需搭配[在线前端](http://mrui-web.hzchu.top/)使用 | |
| 100 | +| netdata_routerid | 0 | 调用netdata api时返回的路由器（对应dev项中第n个） | |
| 101 | +| flushTokenTime | 1800 | 刷新token时间间隔(s) | |
| 102 | +| port | 6789 | 网页页面端口号 | |
| 103 | +| debug | true | debug模式，建议在测试正常后关闭 | |
| 104 | + |
| 105 | +**dev**字段是一个数组，内含的每个元素包含单个设备的配置信息。数组中的每个对象描述如下： |
| 106 | + |
| 107 | +| 配置名 | 默认值 | 解释 | |
| 108 | +| ---------- | -------------------------------- | ------------------------------------------------------------ | |
| 109 | +| password | | 路由器密码 | |
| 110 | +| key | a2ffa5c9be07488bbb04a3a47d3c5f6a | 路由器key（如果和前文获取的不同，请更改为自己获取的） | |
| 111 | +| ip | 192.168.31.1 | 路由器IP | |
| 112 | +| routerunit | false | 启用后，程序通过`gopsutil`库获取CPU占用，在支持的路由器上获取温度 | |
| 113 | + |
| 114 | +> 配置多个对象以使用多路由模式，但要注意，如果使用有线/无线组网，数据统计由主路由负责，子路由无法获取信息属于正常情况 |
| 115 | +
|
| 116 | +**history**项： |
| 117 | + |
| 118 | +| 配置名 | 默认值 | 解释 | |
| 119 | +| ---------- | ------ | -------------------- | |
| 120 | +| enable | false | 是否启用历史数据统计 | |
| 121 | +| sampletime | 300 | 采样时间间隔(s) | |
| 122 | +| maxsaved | 8640 | 最多记录条数 | |
| 123 | + |
| 124 | +::: tip |
| 125 | + |
| 126 | +保存数据条数过多可能会造成前端页面卡顿。同时，为了减小历史数据拟合时产生的误差，sampletime应不超过600 |
| 127 | + |
| 128 | + ::: |
0 commit comments