OpenGFW/README.md

# ![OpenGFW](docs/logo.png)

[![Quality check status](https://github.com/apernet/OpenGFW/actions/workflows/check.yaml/badge.svg)](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)
- [WIP] Web UI

## 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
first 2024-01-20 08:45:01 +08:00			`# ![OpenGFW](docs/logo.png)`

docs: Fix badge URL 2024-03-14 15:06:27 +08:00			`[![Quality check status](https://github.com/apernet/OpenGFW/actions/workflows/check.yaml/badge.svg)](https://github.com/apernet/OpenGFW/actions/workflows/check.yaml)`
first 2024-01-20 08:45:01 +08:00			`[![License][1]][2]`

			`[1]: https://img.shields.io/badge/License-MPL_2.0-brightgreen.svg`
			`[2]: LICENSE`

			`[中文文档](README.zh.md)`
docs: add Japanese README 2024-01-25 12:01:43 +08:00			`[日本語ドキュメント](README.ja.md)`
first 2024-01-20 08:45:01 +08:00
docs: update README 2024-02-24 10:31:16 +08:00			`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.`
docs: add telegram group link 2024-02-18 14:34:38 +08:00
docs: move to website 2024-03-30 04:06:29 +08:00			`Documentation site: https://gfw.dev/`

chore: better README 2024-02-24 07:43:08 +08:00			`Telegram group: https://t.me/OpGFW`
first 2024-01-20 08:45:01 +08:00
			`> [!CAUTION]`
docs: move to website 2024-03-30 04:06:29 +08:00			`> 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.`
first 2024-01-20 08:45:01 +08:00
			`## Features`

			`- Full IP/TCP reassembly, various protocol analyzers`
docs: update readme feature list 2024-04-02 12:49:06 +08:00			`- HTTP, TLS, QUIC, DNS, SSH, SOCKS4/5, WireGuard, OpenVPN, and many more to come`
			`- "Fully encrypted traffic" detection for Shadowsocks, VMess,`
chore: update gfw report links 2024-02-27 07:17:07 +08:00			`etc. (https://gfw.report/publications/usenixsecurity23/en/)`
docs: no longer use trojan-killer 2024-03-21 09:10:22 +08:00			`- Trojan (proxy protocol) detection`
docs: update socks rules 2024-01-28 05:56:08 +08:00			`- [WIP] Machine learning based traffic classification`
docs: trivial updates 2024-01-22 08:11:01 +08:00			`- Full IPv4 and IPv6 support`
first 2024-01-20 08:45:01 +08:00			`- Flow-based multicore load balancing`
			`- Connection offloading`
			`- Powerful rule engine based on [expr](https://github.com/expr-lang/expr)`
feat: rules hot reload via SIGHUP (#44) 2024-02-04 02:55:20 +08:00			- Hot-reloadable rules (send `SIGHUP` to reload)
first 2024-01-20 08:45:01 +08:00			`- Flexible analyzer & modifier framework`
			`- Extensible IO implementation (only NFQueue for now)`
			`- [WIP] Web UI`

			`## Use cases`

			`- Ad blocking`
			`- Parental control`
			`- Malware protection`
			`- Abuse prevention for VPN/proxy services`
			`- Traffic analysis (log only mode)`
chore: better README 2024-02-24 07:43:08 +08:00			`- Help you fulfill your dictatorial ambitions`