Skip to content

Commit 4c2d565

Browse files
committed
update README
1 parent 4940976 commit 4c2d565

File tree

5 files changed

+2
-346
lines changed

5 files changed

+2
-346
lines changed

README.md

Lines changed: 1 addition & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -33,30 +33,7 @@ It is a part of [ServerBox](https://github.com/lollipopkit/flutter_server_box) p
3333
</table>
3434

3535
## 📖 Usage
36-
1. There are serveral ways to install it.
37-
- `Docker`:
38-
- (Recommonded) [Docker compose](docker-compose.yaml)
39-
- Or `docker run -d --name srvbox -v ./config:/root/.config/server_box lollipopkit/srvbox_monitor:latest`
40-
- (Optional) If you need to update it, `docker rm srvbox -f && docker rmi lollipopkit/srvbox_monitor:latest` to delete old image. And then run the command above.
41-
- Use binary.
42-
- If you have `go` installed, you can run `go install github.com/lollipopkit/server_box_monitor@latest`
43-
- If you don't have `go` installed, you can download the binary from [release page](https://github.com/lollipopkit/server_box_monitor/releases)
44-
- (Recommended) Config `systemd` to run the app.
45-
- Example service file [here](doc/srvbox.service)
46-
- Rootless
47-
- Copy file to `~/.config/systemd/user/srvbox.service`
48-
- Run `systemctl --user enable --now srvbox`
49-
- You can run `sudo loginctl enable-linger $USER` to make the servicerun after logout
50-
- Rootful
51-
- Copy file to `/etc/systemd/system/srvbox.service`
52-
- Uncomment `User` in the file
53-
- Run `systemctl enable --now srvbox`
54-
2. Edit the config file.
55-
- The config file is located at
56-
- binary: `~/.config/server_box/config.json`
57-
- docker: `./config/config.json`
58-
- Fully example is [here](doc/CONFIG.jsonc)
59-
36+
Please goto [Wiki](https://github.com/lollipopkit/server_box_monitor/wiki) for more information.
6037

6138
## 🔖 License
6239
`GPL v3. lollipopkit 2023`

README_zh.md

Lines changed: 1 addition & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -32,29 +32,7 @@
3232
</table>
3333

3434
## 📖 使用方法
35-
1. 这里有多种方式安装.
36-
- `Docker`:
37-
- (推荐) [Docker compose](docker-compose.yaml)
38-
- 或者 `docker run -d --name srvbox -v ./config:/root/.config/server_box lollipopkit/srvbox_monitor:latest`
39-
- 如果要更新, 先执行 `docker rm srvbox -f && docker rmi lollipopkit/srvbox_monitor:latest` 来删除旧的镜像.
40-
- 可执行文件.
41-
- 如果你有安装 `go`, `go install github.com/lollipopkit/server_box_monitor@latest`
42-
- 或者从 [发布](https://github.com/lollipopkit/server_box_monitor/releases) 下载
43-
- (推荐) 使用 `systemd` 来运行.
44-
- 示例文件在 [这里](doc/srvbox.service),请阅读文件中的注释!
45-
- 非 root
46-
- 复制示例文件到 `~/.config/systemd/user/srvbox.service`
47-
- `systemctl --user enable --now srvbox`
48-
- `sudo loginctl enable-linger $USER` 让服务在注销后继续运行.
49-
- root
50-
- 复制示例文件到 `/etc/systemd/system/srvbox.service`
51-
- 取消 `User` 行注释
52-
- `systemctl enable --now srvbox`
53-
2. 修改配置.
54-
- 配置文件在
55-
- 二进制: `~/.config/server_box/config.json`
56-
- docker: `./config/config.json`
57-
- 完整配置模版在 [这里](doc/CONFIG.jsonc)
35+
请前往 [Wiki](https://github.com/lollipopkit/server_box_monitor/wiki/%E4%B8%BB%E9%A1%B5) 获取更多信息.
5836

5937
## 🔖 许可证
6038
`GPL v3. lollipopkit 2023`

doc/CONFIG.jsonc

Lines changed: 0 additions & 143 deletions
This file was deleted.

doc/CONFIG_zh.jsonc

Lines changed: 0 additions & 141 deletions
This file was deleted.

doc/srvbox.service

Lines changed: 0 additions & 15 deletions
This file was deleted.

0 commit comments

Comments
 (0)