summaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
-rw-r--r--.github/workflows/release.yml5
-rw-r--r--RELEASE_NOTE.md26
2 files changed, 28 insertions, 3 deletions
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
index b1f8e61..885f998 100644
--- a/.github/workflows/release.yml
+++ b/.github/workflows/release.yml
@@ -123,10 +123,9 @@ jobs:
- name: Merge checksums
run: cat upload/*.sha256 > sha256sum.txt
- - name: Format release note from CHANGELOG.md
+ - name: Format release note
run: |
- version="$GITHUB_REF_NAME"
- sed -n "/^## \[DPIBreak ${version}\]/,/^## /{/^## /d;p}" CHANGELOG.md > auto_notes.md
+ cp RELEASE_NOTE.md auto_notes.md
- name: Format download link
run: |
diff --git a/RELEASE_NOTE.md b/RELEASE_NOTE.md
new file mode 100644
index 0000000..fdcd442
--- /dev/null
+++ b/RELEASE_NOTE.md
@@ -0,0 +1,26 @@
+On Linux, SYN/ACK sniffing for `--fake-autottl` now uses AF_PACKET RxRing instead of nftables-based filtering. This removes the extra nftables rules that were needed for SYN/ACK capture and should be more efficient. On Windows, WinDivert is now opened as separate recv/send/sniff handles, and the sniff thread is only spawned when `--fake-autottl` is actually enabled.
+
+Other changes: Windows exits immediately on Ctrl-C instead of waiting for cleanup, logging defers `local_time()` until the log level check passes, and `infer_hops` now correctly uses 128 (was 126). Various internal refactoring for consistency.
+
+## Installation
+### Windows
+1. Download the `.zip` from the below and extract it.
+2. Double-click `dpibreak.exe` to run, or `start_fake.bat` for [fake](https://github.com/Dilluti0n/DPIBreak#fake) mode.
+3. To run automatically on boot, run `service_install.bat` as administrator.
+
+See `WINDOWS_GUIDE.txt` in the zip for more details.
+
+### Linux
+One-liner install:
+```
+curl -fsSL https://raw.githubusercontent.com/dilluti0n/dpibreak/master/install.sh | sh
+```
+
+Or download the tarball from the assets below:
+```
+tar -xf DPIBreak-*.tar.gz
+cd DPIBreak-*/
+sudo make install
+```
+
+Also available via [Gentoo GURU](https://gitweb.gentoo.org/repo/proj/guru.git/tree/net-misc/dpibreak) and [crates.io](https://crates.io/crates/dpibreak).