Skip to content

Commit 9886d85

Browse files
tsosunchiatsosunchia
authored
Merge branch 'master' into dependabot/pip/flask-3.1.3
2 parents 925b895 + 2f2b13b commit 9886d85

File tree

3 files changed

+86
-17
lines changed

3 files changed

+86
-17
lines changed

‎README.md‎

Lines changed: 37 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -2,42 +2,63 @@
22

33
<img src="https://github.com/nxtrace/NTrace-core/raw/main/assets/logo.png" height="200px" alt="NextTrace Logo"/>
44

5+
# NEXTTRACE WEB
6+
7+
A lightweight web API server for NextTrace — run visual traceroutes from your browser.
8+
9+
<div align="center">
10+
11+
[![Docker Pulls](https://img.shields.io/docker/pulls/tsosc/nexttraceweb)](https://hub.docker.com/r/tsosc/nexttraceweb)
12+
[![License](https://img.shields.io/github/license/nxtrace/nexttraceweb)](LICENSE)
13+
14+
[中文](README.zh-CN.md) | **English**
15+
516
</div>
617

7-
# NEXTTRACE WEB
18+
</div>
819

9-
NEXTTRACE项目派生的仓库，用于实现简易的NEXTTRACE WEB API服务端
20+
---
21+
22+
<img width="1440" alt="NextTrace Web Interface" src="https://github.com/tsosunchia/nexttracewebapi/assets/59512455/798554e2-190e-4425-9527-3a11708dafd8">
1023

11-
<img width="1440" alt="截屏2023-06-12 00 24 06" src="https://github.com/tsosunchia/nexttracewebapi/assets/59512455/798554e2-190e-4425-9527-3a11708dafd8">
1224
<p align="center">
13-
<img width="443" alt="截屏2023-06-12 00 12 57" src="https://github.com/tsosunchia/nexttracewebapi/assets/59512455/1eb4b6ce-3ed9-4728-be85-fbdabc5803bd">
14-
<img width="721" alt="截屏2023-06-12 00 26 22" src="https://github.com/tsosunchia/nexttracewebapi/assets/59512455/a0563bfc-37a8-417a-89bf-3ab87ef44d6d">
25+
<img width="443" alt="IP Selection Dialog" src="https://github.com/tsosunchia/nexttracewebapi/assets/59512455/1eb4b6ce-3ed9-4728-be85-fbdabc5803bd">
26+
<img width="721" alt="Traceroute Results" src="https://github.com/tsosunchia/nexttracewebapi/assets/59512455/a0563bfc-37a8-417a-89bf-3ab87ef44d6d">
1527
</p>
1628

29+
---
1730

31+
## Overview
1832

33+
NextTrace Web is a spin-off of the [NextTrace](https://github.com/nxtrace/NTrace-core) project. It provides a simple web frontend and API server so you can run traceroutes and visualize results — including hop, IP, ASN, geolocation, domain, packet loss, and latency stats — entirely from your browser.
1934

20-
请注意，本项目使用了websocket作为通信协议，因此请在配置反代时参考仓库内的代码(本仓库提供的Docker Image 已内置 Nginx 反代)。
35+
> **Reverse proxy note:** This project uses WebSocket as its communication protocol. If you configure a reverse proxy, please refer to the Nginx config included in this repository. The provided Docker image already has Nginx reverse proxy built in.
2136
22-
Inspired by PING.PE
37+
*Inspired by [PING.PE](https://ping.pe) — thanks for years of keeping that service alive and giving the community such a great reference.*
2338

24-
感谢PING.PE这么多年来的坚持，让我们能够在这个时候有一个这么好的项目可以参考
39+
---
2540

2641
## How To Use
2742

28-
推荐使用Docker安装
43+
### Docker (Recommended)
44+
2945
```bash
3046
docker pull tsosc/nexttraceweb
3147
docker run --network host -d --privileged --name ntwa tsosc/nexttraceweb
32-
# 使用 http://your_ip:30080 访问
48+
# Visit http://your_ip:30080
3349
```
34-
若要使用其他地址和端口，请在docker run时加入参数
50+
51+
### Custom Address & Port
52+
53+
Pass an address/port argument to `docker run` to override the default:
54+
3555
```bash
56+
# Bind to localhost only
3657
docker run --network host -d --privileged --name ntwa tsosc/nexttraceweb 127.0.0.1:30080
37-
# 监听127.0.0.1:30080
58+
59+
# Listen on all IPs, port 80
3860
docker run --network host -d --privileged --name ntwa tsosc/nexttraceweb 80
39-
# 监听所有IP的80端口
40-
docker run --network host -d --privileged --name ntwa tsosc/nexttraceweb [::1]:30080
41-
# 监听[::1]:30080
42-
```
4361

62+
# Listen on IPv6 loopback
63+
docker run --network host -d --privileged --name ntwa tsosc/nexttraceweb [::1]:30080
64+
```

‎README.zh-CN.md‎

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
<div align="center">
2+
3+
<img src="https://github.com/nxtrace/NTrace-core/raw/main/assets/logo.png" height="200px" alt="NextTrace Logo"/>
4+
5+
</div>
6+
7+
# NEXTTRACE WEB
8+
9+
<div align="center">
10+
11+
**中文** | [English](README.md)
12+
13+
</div>
14+
15+
NEXTTRACE项目派生的仓库，用于实现简易的NEXTTRACE WEB API服务端
16+
17+
<img width="1440" alt="截屏2023-06-12 00 24 06" src="https://github.com/tsosunchia/nexttracewebapi/assets/59512455/798554e2-190e-4425-9527-3a11708dafd8">
18+
<p align="center">
19+
<img width="443" alt="截屏2023-06-12 00 12 57" src="https://github.com/tsosunchia/nexttracewebapi/assets/59512455/1eb4b6ce-3ed9-4728-be85-fbdabc5803bd">
20+
<img width="721" alt="截屏2023-06-12 00 26 22" src="https://github.com/tsosunchia/nexttracewebapi/assets/59512455/a0563bfc-37a8-417a-89bf-3ab87ef44d6d">
21+
</p>
22+
23+
24+
25+
26+
请注意，本项目使用了websocket作为通信协议，因此请在配置反代时参考仓库内的代码(本仓库提供的Docker Image 已内置 Nginx 反代)。
27+
28+
Inspired by PING.PE
29+
30+
感谢PING.PE这么多年来的坚持，让我们能够在这个时候有一个这么好的项目可以参考
31+
32+
## How To Use
33+
34+
推荐使用Docker安装
35+
```bash
36+
docker pull tsosc/nexttraceweb
37+
docker run --network host -d --privileged --name ntwa tsosc/nexttraceweb
38+
# 使用 http://your_ip:30080 访问
39+
```
40+
若要使用其他地址和端口，请在docker run时加入参数
41+
```bash
42+
docker run --network host -d --privileged --name ntwa tsosc/nexttraceweb 127.0.0.1:30080
43+
# 监听127.0.0.1:30080
44+
docker run --network host -d --privileged --name ntwa tsosc/nexttraceweb 80
45+
# 监听所有IP的80端口
46+
docker run --network host -d --privileged --name ntwa tsosc/nexttraceweb [::1]:30080
47+
# 监听[::1]:30080
48+
```

‎requirements.txt‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
1-
Flask-SocketIO==5.5.1
1+
Flask-SocketIO==5.6.1
22
Flask==3.1.3
33
eventlet~=0.33.3

0 commit comments

Comments
 (0)