Skip to content

Commit 52ca674

Browse files
update: swap to wisp-js fully and other minor changes
1 parent b00ef13 commit 52ca674

File tree

13 files changed

+314
-246
lines changed

13 files changed

+314
-246
lines changed

README.md

Lines changed: 42 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -120,15 +120,17 @@ Replit is no longer free and Heroku has a set policy against web proxies. Try Gi
120120

121121
## How to Setup
122122

123-
#### It is highly recommended you switch branches via your IDE to a production released branch. Often the master branch contains unstable or WIP changes.
123+
#### It is highly recommended you switch branches via your IDE to a production released branch. Often the master branch contains unstable or WIP changes.|
124124

125125
#### Example: v6.x_production instead of master
126126

127127
### Terminal
128128

129129
Either use the button above to deploy to the deployment options above or type the commands below on a dedicated server
130130

131-
Please ensure you are using Node 20.x please:
131+
**THIS PROJECT REQUIRES NGINX NOT CADDY.**
132+
133+
Please ensure you are using Node 20.x as well:
132134

133135
```bash
134136
git clone https://github.com/QuiteAFancyEmerald/Holy-Unblocker.git
@@ -157,10 +159,24 @@ npm run test
157159

158160
This website is hosted locally with Scramjet, Ultraviolet (Wisp, Bare-Mux, EpoxyTransport, CurlTransport) and Rammerhead built-in.
159161

160-
You will need Node.js 20.x and Git installed; below is an example for Debian/Ubuntu setup.
162+
#### You will need Node.js 20.x and Git installed; below is an example for Debian/Ubuntu setup.
163+
164+
### For security reasons when hosting with a reverse proxy PLEASE use NGINX not Caddy. This is due to wisp-js using loopbacks.
161165

162166
<details>
163167

168+
For simplicity sake you can join the TN discord at discord.gg/unblock and request for mirror site links (that are restocked and unblocked).
169+
170+
### Hosting
171+
172+
If you wish to self-host however you will first need a VPS or hosting provider:
173+
https://docs.titaniumnetwork.org/guides/vps-hosting/
174+
https://github.com/QuiteAFancyEmerald/Holy-Unblocker#deploy-holy-unblocker
175+
https://docs.titaniumnetwork.org/guides/dns-setup/
176+
177+
### Dependencies
178+
179+
You will then need to setup git, nginx (or caddy) and Node.js. Here is an example for Ubuntu LTS:
164180
```
165181
sudo apt update
166182
sudo apt upgrade
@@ -173,25 +189,38 @@ export NVM_DIR="$HOME/.nvm"
173189
174190
nvm install 20
175191
nvm use 20
192+
```
193+
https://github.com/nvm-sh/nvm
194+
https://docs.titaniumnetwork.org/guides/nginx/
176195

177-
git clone https://github.com/QuiteAFancyEmerald/Holy-Unblocker.git
178-
cd Holy-Unblocker
196+
### Tor Support (Optional)
197+
https://github.com/QuiteAFancyEmerald/Holy-Unblocker#toronionsocks5-routing-setup
179198

180-
npm run fresh-install
199+
### Configurating Holy Unblocker
200+
Most important options are production along with the obfuscation and DOM masquerading techniques.
181201

182-
# Then edit config.json to change production to true to automatically use pm2
202+
From there just configure as needed: https://github.com/QuiteAFancyEmerald/Holy-Unblocker#configuration
183203

184-
npm start
204+
### Cloning and Running Holy Unblocker
185205

186-
# Then setup a reverse proxy using NGINX; use the link below for the NGINX guide. You can edit the file in /etc/nginx
206+
Then run the respective process; if you have production set to true in the configuration pm2 will be automatically enabled with our own workers/cache system.
187207

188-
sudo systemctl restart nginx
208+
```
209+
git clone https://github.com/QuiteAFancyEmerald/Holy-Unblocker.git
210+
cd Holy-Unblocker
189211
190-
# For Tor look it up if you need it setup
212+
npm run fresh-start
213+
```
214+
215+
Then of course if you used NGINX or caddy please restart/reload it
216+
```
217+
sudo systemctl restart nginx
218+
sudo systemctl restart tor
191219
```
192220

193221
</details>
194222

223+
195224
Resources for self-hosting:
196225

197226
- https://github.com/nvm-sh/nvm
@@ -218,7 +247,7 @@ Every other localized changes for source randomization, auto-minify, etc. are lo
218247

219248
#### Tor/Onion/SOCKS5 Routing Setup
220249

221-
You need to setup Tor (no GUI need/GUI is alright) in order for the Onion Routing setting to work!
250+
You need to setup Tor (no GUI need/GUI is alright. With GUI replace port 9050 with 9150) in order for the Onion Routing setting to work!
222251

223252
Simply host Tor using this guide: https://tb-manual.torproject.org/installation/
224253

@@ -232,9 +261,7 @@ If you wish to use a custom HTTP/HTTPS/SOCKS5 proxy to route all traffic through
232261
proxyUrl = {
233262
tor: 'socks5h://localhost:9050',
234263
eu: 'socks5h://localhost:7000',
235-
usWest: 'socks5h://localhost:7001',
236-
usEast: 'socks5h://localhost:7002',
237-
jp: 'socks5h://localhost:7003',
264+
jp: 'socks5h://localhost:7001',
238265
}
239266
```
240267

TODO.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,8 @@ This will be our nonexhaustive todo list for Holy Unblocker LTS v6.x.x and above
1212
- [ ] Add a "website self-destruct" button to the settings menu
1313
- [ ] Transport Options Swapping on Frame (Settings Menu doesn't swap)
1414
- [ ] Implement advanced data URI system
15+
- [ ] Allow custom Wisp urls from the settings menu (not config side)
16+
- [x] Swap to wisp-js over wisp-server-node for security and performance - done
1517
- [x] Fix keyword/descriptor randomisation - done
1618
- [x] Adapt Wisp protocol replacing bare which is very unsecure - done
1719
- [x] Improved error handling for proxy errors - done

docker-compose.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ version: "3.9"
22

33
services:
44
holy-unblocker:
5-
image: quiteafancyemerald/holy-unblocker:6.9.3
5+
image: quiteafancyemerald/holy-unblocker:6.9.4
66
build: .
77
container_name: holy-unblocker
88
ports:

0 commit comments

Comments
 (0)