Skip to content

Commit 394cf2d

Browse files
author
Delta-Kronecker
committed
rename to TorBoost: configs/torrc.boost, artifact torboost-win64, titles/notes/console strings
1 parent a1ee9ee commit 394cf2d

4 files changed

Lines changed: 22 additions & 21 deletions

File tree

.github/workflows/build.yml

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ jobs:
5353
path: out/
5454

5555
tor-win64:
56-
name: tor-win64-portable (single release artifact)
56+
name: torboost-win64 (single release artifact)
5757
runs-on: windows-latest
5858
needs: [transports]
5959
steps:
@@ -130,7 +130,7 @@ jobs:
130130
- name: Copy config template, bridges, README
131131
shell: pwsh
132132
run: |
133-
Copy-Item "configs\torrc.speed" "dist\data\torrc.template" -Force
133+
Copy-Item "configs\torrc.boost" "dist\data\torrc.template" -Force
134134
Copy-Item "bridges\*.txt" "dist\data\bridges\" -Force
135135
Copy-Item "README.md" "dist\data\README.md" -Force
136136
@@ -142,7 +142,7 @@ jobs:
142142
- name: Upload single release artifact
143143
uses: actions/upload-artifact@v4
144144
with:
145-
name: tor-win64-portable
145+
name: torboost-win64
146146
path: dist/
147147

148148
- name: Upload build log
@@ -174,14 +174,14 @@ jobs:
174174
175175
- uses: actions/download-artifact@v4
176176
with:
177-
name: tor-win64-portable
177+
name: torboost-win64
178178
path: release
179179

180180
- name: Package portable folder into zip
181181
shell: bash
182182
run: |
183183
cd release
184-
zip -r "../tor-win64-portable-${{ steps.tag.outputs.TAG }}.zip" start-tor.exe data
184+
zip -r "../torboost-win64-${{ steps.tag.outputs.TAG }}.zip" start-tor.exe data
185185
ls -la ../
186186
187187
- name: Publish release
@@ -190,14 +190,14 @@ jobs:
190190
GH_TOKEN: ${{ github.token }}
191191
run: |
192192
TAG="${{ steps.tag.outputs.TAG }}"
193-
ZIP="tor-win64-portable-$TAG.zip"
193+
ZIP="torboost-win64-$TAG.zip"
194194
if gh release view "$TAG" --repo "${{ github.repository }}" >/dev/null 2>&1; then
195195
gh release upload "$TAG" "$ZIP" --repo "${{ github.repository }}" --clobber
196196
else
197197
gh release create "$TAG" "$ZIP" \
198198
--repo "${{ github.repository }}" \
199-
--title "Tor Speed Portable $TAG" \
200-
--notes "Tor Speed Portable (official tor 0.4.9.11), tuned for maximum
199+
--title "TorBoost $TAG" \
200+
--notes "TorBoost (official tor 0.4.9.11), tuned for maximum
201201
download/upload throughput.
202202
Unzip and run start-tor.exe - pick a mode (direct / webtunnel / obfs4 / vanilla).
203203
- SocksPort 127.0.0.1:9050, HTTP proxy 127.0.0.1:8118, DNS 127.0.0.1:53530"

README.md

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
1-
# Tor Speed Portable
1+
# TorBoost
22

3-
Single-folder, portable Tor client tuned for maximum download/upload
4-
throughput (padding disabled, faster bootstrap, longer circuit reuse). Built in
5-
CI from the official tor 0.4.9.11 sources plus pluggable transports (obfs4,
6-
snowflake, webtunnel). No installation and no `%APPDATA%` — every file and all
7-
runtime state stays inside one folder, so you can copy or move it anywhere.
3+
TorBoost is a single-folder, portable Tor client tuned for maximum
4+
download/upload throughput (padding disabled, faster bootstrap, longer circuit
5+
reuse). Built in CI from the official tor 0.4.9.11 sources plus pluggable
6+
transports (obfs4, snowflake, webtunnel). No installation and no `%APPDATA%`
7+
every file and all runtime state stays inside one folder, so you can copy or
8+
move it anywhere.
89

910
## Layout
1011

@@ -20,7 +21,7 @@ data\
2021

2122
## Usage
2223

23-
1. Download the `tor-win64-portable` artifact from GitHub Actions and unzip.
24+
1. Download the `torboost-win64` artifact from GitHub Actions and unzip.
2425
2. Double-click `start-tor.exe`, pick a mode:
2526
- **1 Direct** — no bridges (works when Tor is not blocked)
2627
- **2 WebTunnel**, **3 Obfs4**, **4 Vanilla** — bridges from `data\bridges\`
@@ -46,9 +47,9 @@ start-tor.exe --stop stop Tor and restore the proxy
4647
## Building
4748

4849
`.github/workflows/build.yml` builds tor + transports and publishes the
49-
`tor-win64-portable` artifact on every push.
50+
`torboost-win64` artifact on every push.
5051

5152
- `tor-src\` — unmodified official tor 0.4.9.11 source
52-
- `configs\torrc.speed` — speed-optimized portable config template (becomes `data\torrc.template`)
53+
- `configs\torrc.boost` — speed-optimized portable config template (becomes `data\torrc.template`)
5354
- `bridges\` — tested bridge lists shipped with the release
5455
- `scripts\start-tor.cs` — source of `start-tor.exe` (compiled with `scripts\build-start-tor.ps1`)
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Tor speed-optimized portable client config - Tor 0.4.9.11
1+
# TorBoost - speed-optimized portable Tor client config (tor 0.4.9.11)
22
# Copied by start-tor.exe to data\torrc.template, then data\torrc is generated
33
# from it per the chosen mode. All paths are relative, so the whole folder is
44
# fully portable: copy/move it anywhere and it still works.

scripts/start-tor.cs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
// start-tor.cs - builds to start-tor.exe (compile with build-start-tor.ps1)
2-
// Portable Tor launcher, speed-optimized. Expected layout next to this exe:
2+
// TorBoost launcher - portable Tor client tuned for speed. Expected layout:
33
// start-tor.exe
44
// data\
55
// tor.exe torrc.template geoip geoip6 transports
@@ -382,7 +382,7 @@ private static int StopTor()
382382

383383
private static int Main(string[] args)
384384
{
385-
Console.Title = "Tor Speed Portable";
385+
Console.Title = "TorBoost";
386386

387387
if (args.Length > 0 && args[0] == "--newcircuit")
388388
{
@@ -414,7 +414,7 @@ private static int Main(string[] args)
414414
if (mode < 0) { Console.WriteLine("[x] no mode selected."); return 1; }
415415

416416
Console.WriteLine();
417-
Console.WriteLine("Tor Speed Portable (official tor 0.4.9.11)");
417+
Console.WriteLine("TorBoost (official tor 0.4.9.11)");
418418
Console.WriteLine(" mode : " + ModeNames[mode]);
419419
Console.WriteLine(" data dir: " + DataDir);
420420
Console.WriteLine();

0 commit comments

Comments
 (0)