Holy Unblocker LTS (v6.x.x)
Read below for information if the official site is blocked or for
obtaining more links. Can't deploy using any of the free options below? Check
out Railway or look into cheap, paid VPS hosting solutions.
Be sure to join Titanium Network's Discord for more official site
links:
https://discord.gg/unblock
GitHub Codespaces
Setup Instructions
- Fork (and star!) this repository to your GitHub account
- Head to the official
Codespaces website (ensure you
have a GitHub account already made)
- Select New Codespaces and look for
[USERNAME]/Holy-Unblocker on your account
- Ensure the branch is set to master and the dev container
configuration is set to Holy Unblocker LTS
- Select Create Codespace and allow the container to setup
- Type npm run fresh-install and npm start in the terminal
- Click "Make public" on the application popup, then access the deployed
website via the ports tab.
How to Setup
It is highly recommended you switch branches via your IDE to a production
released branch. Often the master branch contains unstable or WIP changes.
Example: v6.x_production instead of master
Terminal
Either use the button above to deploy to the deployment options above or type
the commands below on a dedicated server:
git clone --recurse-submodules https://github.com/titaniumnetwork-dev/Holy-Unblocker.git
cd Holy-Unblocker
git submodule init
# Using the configuration file you can automatically use pm2 if you are hosting on a VPS!
npm run fresh-install
npm start
# Or on subsequent uses...
npm restart
# If you encounter any build errors...
npm run build
# If you encounter any service errors...
npm run proxy-validator
This website is hosted locally with Scramjet, Ultraviolet (Wisp, Bare-Mux,
EpoxyTransport, CurlTransport) and Rammerhead built-in.
Configuration
Server Configuration Setup
The default place for the proxy when its started is
http://localhost:8080, but you can change it if needed in
./ecosystem.config.js. You can also modify the other
configuration values at ./config.json. To clarify you change the
PORT and other production metrics via ./ecosystem.config.js.
Localized changes for source randomization, auto-minify, etc. are located in
./config.json.
Tor/Onion Routing Setup
Simply host Tor using this guide:
https://tb-manual.torproject.org/installation/
If you are hosting Holy Unblocker LTS on a VPS utilizing Ubuntu consider
attaching Tor to systemctl for easier production management. Once Tor is up
and running on either Linux or Windows it will work automatically with Holy
Unblocker LTS when enabled by the user via the Settings menu.
Proxy Configuration
The primary location for tweaking any web proxy related settings assigned via
the Settings menu is ./views/assets/js/register-sw.js. Here you
can modify the provided transport options set locally via a cookie, swap out
SOCKS5 proxies, change Onion routing ports, specify a blacklist, and more.
-
stockSW: The default service worker configuration file for
Ultraviolet. For Holy Unblocker however adblocking is automatically enabled
so this is not used by default.
-
blacklistSW: A modified version of Ultraviolet that allows for
blacklisting domains and adblocking.
-
proxyUrl: Specifies a SOCKS5 protocol URL defaulting to the
default Tor proxy port. This can be swapped out with any valid port or
SOCK5s proxy.
-
transports: Specifies any provided ports to be swapped via
Bare-Mux and utilize Wisp.
wispUrl: Modify the pathname or url handling for Wisp
-
defaultMode: Specify the default transport used globally (can
be swapped by the users still via the Settings menu)
-
ScramjetController: This constructor allows you to swap out the
prefix used for Scramjet dynamically and specify file locations. Note you
may need to edit ./views/scram/scramjet.sw when changing file
names.