meiandClaude Opus 5
5a7722d1d2
Adds an optional web dashboard served by OpenGFW itself, enabled with a new `web` section in the config file. Backend (web package, decoupled from engine/io so it builds on any OS): - hub.go collects statistics off the engine logger callbacks: atomic counters, two ring-buffered time series (10s and 1min buckets), top N hosts/blocked destinations/rules/analyzers, and a 512 entry event buffer fanned out to connected clients over SSE. Slow clients drop frames instead of blocking the engine. - api.go exposes /api/v1 for info, meta, metrics, events, the SSE stream and ruleset read/validate/replace. - auth.go implements password login with in-memory session tokens and login rate limiting. Mutating endpoints require the bearer token (the session cookie is only accepted for GET), which makes them CSRF-safe. - cmd/web.go implements the rule manager: rules are compiled before anything is written, the file is replaced atomically and the engine is hot reloaded. The SIGHUP handler now shares that same path. - web/devserver serves the UI with synthetic traffic for frontend work on machines where the engine itself cannot be built. Frontend (web/frontend, Vue 3 + Vite + Tailwind CSS v4 + Reka UI): dashboard, live event feed with analyzer property inspection, visual and YAML rule editors, analyzer overview and settings. Responsive down to phone sizes with a bottom tab bar and bottom-sheet dialogs, plus light/dark themes and English/Chinese translations. The built UI in web/dist is committed and embedded with go:embed so that `go build` works without Node; CI builds the frontend and checks that the committed output is up to date. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
67 lines
2.6 KiB
Markdown
67 lines
2.6 KiB
Markdown
# 
|
|
|
|
[](https://github.com/apernet/OpenGFW/actions/workflows/check.yaml)
|
|
[![License][1]][2]
|
|
|
|
[1]: https://img.shields.io/badge/License-MPL_2.0-brightgreen.svg
|
|
[2]: LICENSE
|
|
|
|
**[中文文档](README.zh.md)**
|
|
**[日本語ドキュメント](README.ja.md)**
|
|
|
|
OpenGFW is your very own DIY Great Firewall of China (https://en.wikipedia.org/wiki/Great_Firewall), available as a flexible, easy-to-use open source program on Linux. Why let the powers that be have all the fun? It's time to give power to the people and democratize censorship. Bring the thrill of cyber-sovereignty right into your home router and start filtering like a pro - you too can play Big Brother.
|
|
|
|
**Documentation site: https://gfw.dev/**
|
|
|
|
Telegram group: https://t.me/OpGFW
|
|
|
|
> [!CAUTION]
|
|
> This project is still in very early stages of development. Use at your own risk. We are looking for contributors to help us improve and expand the project.
|
|
|
|
## Features
|
|
|
|
- Full IP/TCP reassembly, various protocol analyzers
|
|
- HTTP, TLS, QUIC, DNS, SSH, SOCKS4/5, WireGuard, OpenVPN, and many more to come
|
|
- "Fully encrypted traffic" detection for Shadowsocks, VMess,
|
|
etc. (https://gfw.report/publications/usenixsecurity23/en/)
|
|
- Trojan (proxy protocol) detection
|
|
- [WIP] Machine learning based traffic classification
|
|
- Full IPv4 and IPv6 support
|
|
- Flow-based multicore load balancing
|
|
- Connection offloading
|
|
- Powerful rule engine based on [expr](https://github.com/expr-lang/expr)
|
|
- Hot-reloadable rules (send `SIGHUP` to reload)
|
|
- Flexible analyzer & modifier framework
|
|
- Extensible IO implementation (only NFQueue for now)
|
|
- Web UI with live traffic dashboard and rule editor
|
|
|
|
## Web UI
|
|
|
|
OpenGFW ships with an optional web dashboard: live traffic statistics, a real-time event
|
|
feed with per-stream analyzer properties, and a rule editor that validates and hot reloads
|
|
the ruleset. It works on phones as well as on desktops.
|
|
|
|
Enable it in your config file:
|
|
|
|
```yaml
|
|
web:
|
|
enabled: true
|
|
listen: :8080
|
|
secret: your-password-here # generated and logged on startup if left empty
|
|
# cert: /path/to/fullchain.pem
|
|
# key: /path/to/privkey.pem
|
|
```
|
|
|
|
The UI is embedded in the binary, so no extra files need to be deployed. Only expose it to
|
|
trusted networks — anyone with the password can change your rules. See
|
|
[web/README.md](web/README.md) for development instructions.
|
|
|
|
## Use cases
|
|
|
|
- Ad blocking
|
|
- Parental control
|
|
- Malware protection
|
|
- Abuse prevention for VPN/proxy services
|
|
- Traffic analysis (log only mode)
|
|
- Help you fulfill your dictatorial ambitions
|