Skip to content

Commit 4269b2d

Browse files
authored
Update README.md
1 parent d6a53e0 commit 4269b2d

1 file changed

Lines changed: 15 additions & 86 deletions

File tree

README.md

Lines changed: 15 additions & 86 deletions
Original file line numberDiff line numberDiff line change
@@ -1,92 +1,21 @@
1-
# TrguiNG
2-
**Remote GUI for Transmission torrent daemon**
31

4-
![GitHub release](https://img.shields.io/github/v/release/OpenScopeProject/TrguiNG)
5-
![Downloads](https://img.shields.io/github/downloads/OpenScopeProject/TrguiNG/total)
6-
![Lint status](https://img.shields.io/github/actions/workflow/status/OpenScopeProject/TrguiNG/lint.yml?label=Lint&event=push)
2+
## 基于 [openscopeproject/TrguiNG](https://github.com/openscopeproject/TrguiNG) 汉化并增加部分功能
73

8-
![logo](https://i.imgur.com/QdgMWwW.png)
4+
## 新增功能 (240416a)
5+
1. 分组体积展示(可在分组区右键关闭该功能)
6+
2. 双击全选分组,方便快捷操作(可在分组区右键关闭该功能)
7+
3. 增加错误分布分组(可在分组区右键关闭该功能)
8+
4. 增加分组后的Tracker二级过滤(位于顶部搜索框右侧)
9+
5. 多链接下载,可设置下载间隔
10+
6. 调整布局,左下角增加状态指示(主要用于多链接下载展示进度,平常展示列表选中项)
11+
7. 种子列表右键菜单增加复制名称和路径(去重)
912

10-
`TrguiNG` is a rewrite of [transgui](https://github.com/transmission-remote-gui/transgui)
11-
project using [tauri](https://tauri.studio/).
12-
Frontend is written in typescript with [react.js](https://react.dev/) and
13-
[mantine](https://mantine.dev/) library. Backend for the app is written in
14-
[rust](https://www.rust-lang.org/).
13+
## PS. 主要是自用,有想加功能的可以提 issues,不保证实现
1514

16-
You can use this program in 2 ways: as a native Windows/Linux/Mac app and as a web gui
17-
served by transmission itself by setting `$TRANSMISSION_WEB_HOME` environment variable
18-
to point to TrguiNG web assets.
19-
20-
There are screenshots of the app available on the
21-
[project wiki](https://github.com/openscopeproject/TrguiNG/wiki).
22-
23-
Some differentiating features:
24-
25-
* Multi tabbed interface for concurrent server connections (native app only)
26-
* Torrent creation with fast multi threaded hashing (native app only)
27-
* Powerful torrent filtering options
28-
* Latest transmission features support: labels, bandwidth groups, sequential download
29-
* Dark and white theme
30-
31-
Planned:
32-
33-
* Better bandwidth groups support when API is ready (https://github.com/transmission/transmission/issues/5455)
34-
35-
Transmission v2.40 or later is required.
36-
37-
## Compiling
38-
39-
Prerequisites:
40-
- [Node.js 16](https://nodejs.org/) or later
41-
- [rust 1.69](https://www.rust-lang.org/) or later
42-
- Geoip lookup database in mmdb format, put it in `src-tauri`
15+
## 安装介绍(docker 环境)
16+
1.[releases](https://github.com/jayzcoder/TrguiNG/releases) 下载 `trguing-web-xxxx-zh.zip`
17+
2. 解压到 transmission 设置的 webui 目录即可
18+
3. transmission 需要正确映射并设置环境变量(确保 index.html 位于 TRANSMISSION_WEB_HOME 所在的目录第一层):
4319
```
44-
wget -nv -O src-tauri/dbip.mmdb "https://github.com/openscopeproject/TrguiNG/releases/latest/download/dbip.mmdb"
20+
TRANSMISSION_WEB_HOME=/config/webui/trguing-zh
4521
```
46-
You can get latest db from [db-ip.com](https://db-ip.com/db/download/ip-to-country-lite).
47-
48-
To compile simply run
49-
50-
```
51-
$ npm install
52-
$ npm run build
53-
```
54-
55-
This will generate optimized bundle in `dist` and a release binary in `src-tauri/target/release` folder.
56-
Also installer package will be available in `src-tauri/target/release/bundle/...`.
57-
58-
The binary is statically linked and embeds all necessary assets except for the geoip database.
59-
It is completely self sufficient and can be used as a portable executable but for geoip lookup to work you
60-
need to install the app with provided installer.
61-
62-
For development run in parallel
63-
64-
```
65-
$ npm run webpack-serve
66-
$ npm run tauri-dev
67-
```
68-
69-
Webpack will automatically watch changes in `src/` and refresh the app view, tauri will watch changes
70-
in `src-tauri/` and rebuild/restart the app as needed.
71-
72-
## How to use TrguiNG as a web interface
73-
74-
Transmission supports custom web interfaces, all you have to do is run the daemon with
75-
`$TRANSMISSION_WEB_HOME` variable pointing to the web assets that transmissinon will serve
76-
over it's `.../transmission/web/` endpoint.
77-
78-
Example steps for debian:
79-
1. Download latest `trguing-web-xxxx.zip` zip from [releases](https://github.com/openscopeproject/TrguiNG/releases)
80-
page.
81-
2. Unpack it anywhere, make sure that the user transmission runs under (by default `debian-transmission`)
82-
has read permissions.
83-
3. Edit transmission daemon systemd unit file `/etc/systemd/system/multi-user.target.wants/transmission-daemon.service`
84-
and add following to `[Service]` section:
85-
```
86-
Environment=TRANSMISSION_WEB_HOME=/path/to/extracted/trguing/zip
87-
```
88-
4. Reload the unit file with `sudo systemctl daemon-reload`
89-
and restart the service `sudo systemctl restart transmission-daemon`
90-
91-
## License
92-
Project is distributed under GNU Affero General Public License v3, see `LICENSE.txt` for details.

0 commit comments

Comments
 (0)