Update README.md

This commit is contained in:
Quite A Fancy Emerald 2021-04-28 14:43:03 -07:00 committed by GitHub
parent 608881debc
commit 97bd9ba33c
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

275
README.md
View file

@ -1,14 +1,15 @@
# Holy Unblocker <img align="left" src="https://raw.githubusercontent.com/QuiteAFancyEmerald/HolyUnblockerPublic/master/views/assets/img/Icon.png"></img>
<img align="left" width="70px" src="https://raw.githubusercontent.com/QuiteAFancyEmerald/HolyUnblockerPublic/master/views/assets/img/icon.png"></img>
# Holy Unblocker
A website that can be used to bypass web filters; both extension and firewall. This is the public source code for Holy Unblocker, a rather fancy website with some cool dynamic backgrounds while also focusing with detail put into the design, mechanics and features overall like custom Tab Cloaks with more to come in the future.
#### Titanium Network is sponsored by:
Works with a large number of sites including YouTube, Discord and more! Be sure to read below for information if the official site is blocked or for obtaining more links.
<img src="https://raw.githubusercontent.com/QuiteAFancyEmerald/HolyUnblockerPublic/fa858c0e429d73324bffc045bd2a3217064fb1e5/views/assets/img/nodeclusters.png?raw" width="500px"><a href="https://nodeclusters.com"></a></img>
YouTube has specialized support with the ablity to view steams, comments, bypass restricted mode, and have full quality on videos.
Holy Unblocker, an official flagship Titanium Network site, can bypass web filters regardless of whether it is an extension or network-based. Being a secure web proxy service, it supports numerous sites while being updated frequently and concentrating on detail with design, mechanics, and features.
Be sure to check the various branches as I update Holy Unblocker often with open access to yet to be released versions.
Works with a large number of sites, including YouTube, Discord, and more!
Also has a good amount of locally hosted games featured on the site.
Read below for information if the official site is blocked or for obtaining more links.
#### Supports
- Youtube.com
@ -16,20 +17,24 @@ Also has a good amount of locally hosted games featured on the site.
- Google.com
- Reddit.com
- Bing.com
- And more sites!
- And more!
#### Features:
- Tab customization using the Options menu for improved stealth
- Considerable variety with the open selection of proxy types
- Game library with moderately decent titles like A Dark Room
- Has frequent support articles for issues relating to the various proxy instances
Be sure to join Titanium Network's Discord for more official site links: https://discord.gg/hcUUceSCtj
Do %proxy hu for more Holy Unblocker links on the Titanium Network Discord server.
**Official Site:** https://www.holyubofficial.net
**Site Documentation:** Documentation
<img src="https://raw.githubusercontent.com/QuiteAFancyEmerald/HolyUnblockerPublic/master/views/assets/img/hbpreview.png?raw"></img>
Official Site: https://www.holyubofficial.net
Site Documentation: <a href="https://www.holyubofficial.net/?in">Documentation</a>
Instance Status: <a href="https://www.holyubofficial.net/?status">Status</a>
Be sure to join Titanium Network's Discord for more official site links: https://discord.gg/unblock
Simply do `%proxy hu` for more Holy Unblocker links on the TN Discord server.
<a href="https://heroku.com/deploy?template=https://github.com/QuiteAFancyEmerald/HolyUnblockerPublic" title="Deploy to Heroku"><img alt="Deploy to Heroku" src="https://raw.githubusercontent.com/QuiteAFancyEmerald/HolyUnblockerPublic/master/views/assets/img/heroku.svg?raw" width="140" height="30"><img></a>
&nbsp;
<a href="https://azuredeploy.net/" title="Deploy to Azure"><img alt="Deploy to Azure" src="https://raw.githubusercontent.com/QuiteAFancyEmerald/HolyUnblockerPublic/master/views/assets/img/azure.svg?raw" width="140" height="30"><img></a>
@ -43,9 +48,8 @@ Simply do `%proxy hu` for more Holy Unblocker links on the TN Discord server.
- [Setup](#how-to-install)
- [Structure](#structure)
- [Structure Information](#structure)
- [Static Files](#details-of-public)
- [Static Files](#details-of-views)
- [Proxy Scripts](#scripts-located-in-expr)
- [Cookie Auth](#details-of-authjs)
- [Future Additions](#future-additions)
- [Beginner's Explanation](#vauge-explanation-for-beginners-with-external-proxies-and-hosting)
- [Hosting Providers](#list-of-some-good-hosting-options)
@ -57,23 +61,21 @@ Simply do `%proxy hu` for more Holy Unblocker links on the TN Discord server.
- [More Information](#more-information)
## How to Setup
Either use the button above to deploy to Heroku or do the below:
```
git clone https://github.com/QuiteAFancyEmerald/HolyUnblockerPublic.git
cd HolyUnblockerPublic
npm install
npm start
$ git clone https://github.com/QuiteAFancyEmerald/HolyUnblockerPublic.git
$ cd HolyUnblockerPublic
$ npm install
```
Afterward, run:
```
$ npm start
```
For more detailed documentation on workspace setup, please view <a href="https://holyubofficial.net/?faq">this</a>.
The default place for the proxy when its started is `http://localhost:8080` but you can change it if needed in config.json
This website has been hosted locally on Alloy Proxy. More more information go to the Alloy Proxy repository below.
The default place for the proxy when it started is `http://localhost:8080`, but it can be changed if needed in config.json
This website has been hosted locally on Alloy Proxy. For more information, head over to the Alloy Proxy repository below.
## Structure
- `index.html` : The official homepage of the site.
@ -116,147 +118,180 @@ This website has been hosted locally on Alloy Proxy. More more information go to
- `h5-nav.js`, `emu-nav.js`, `flash-nav.js` are used for navigation on the games pages.
## Future Additions
- Prevent large layout shifts and improve CLS.
- Expansive game library
- Various parity changes.
## Vauge Explanation for Beginners With External Proxies and Hosting
You will first want to host your proxies locally or externally.
## An explanation for Beginners With External Proxies and Hosting
You will first want to host your proxies locally or externally. Note that an older version of Alloy proxy is the only proxy hosted locally with this distribution of Holy Unblocker.
#### List of some good hosting options:
- <a href="https://heroku.com">Heroku</a> (Free)
- <a href="https://nodeclusters.com">NodeClusters</a> (Paid)
- <a href="https://glitch.com">Glitch</a> (Free)
- <a href="https://repl.it">Repl.it</a> (Free)
- <a href="https://azure.microsoft.com/en-us/">Azure</a> (Free and Paid)
**Proxies that you will need for a complete setup for Holy Unblocker:**
Out of the list of hosting providers Heroku and NodeClusters rank first as a preference. You may also self-host. Currently at this time Azure is used to host the official Holy Unblocker sites.
Womginx - https://github.com/binary-person/womginx
After you have selected a decent VPS, use Cloudflare for the DNS records for both the site and the subdomains for the proxies.
SysYA Proxy - https://github.com/sysce/proxy
This is an example of DNS records involving Heroku. Self-hosting will require `A records` preferably.
<img src="https://cdn.discordapp.com/attachments/725506757291671663/756659513179766844/unknown.png" width="500" height="154"></img>
Via Unblocker/PyDodge -https://github.com/BinBashBanana/PyDodge
- `a.deepsoil.ml` is being used for Node Unblocker.
- `p.deepsoil.ml` is being used for SysYa Proxy.
- `pd.deepsoil.ml` is being used for PyDodge B.
- `cdn.deepsoil.ml` is being used for a private Alloy host on the official sites.
Alloy Proxy - https://github.com/titaniumnetwork-dev/alloy
Update, the new configuration is:
The source used for Via Unblocker on the official sites is not public.
- `a.example.com` is being used for Node Unblocker.
- `d.example.com` is being used for Ocean proxy.
- `c.example.com` is being used for SysYa and the Chatbox.
- `cdn.example.com` is being used for a private Alloy and Via which is hosted on the official sites.
**List of some good hosting options:**
As stated previously, Holy Unblocker is hosted locally with Alloy.
- Dedipath (Paid and Dedicated)
- Heroku (Free)
- NodeClusters (Paid)
- Glitch (Free)
- Repl.it (Free)
- Azure (Free and Paid)
#### Heroku Steps
So use Heroku to host. I personally favor it as a free choice.
Out of the list of hosting providers Heroku and Dedipath rank first as a preference.
- First obtain a card; (Prepaid, Debit, and Credit Cards work). You need this to add custom domains to your Heroku instance.
You may also self-host. Currently, at this time, Dedipath is used to host the official Holy Unblocker sites.
Make sure you connect your Heroku app to your GitHub and enable automatic deploys. Will make things easier. :)
After you have selected a decent VPS, use Cloudflare for DNS records for both the site and the subdomains for the proxies.
The image below is an example of DNS records involving Heroku. Self-hosting will require A records, preferably.
#### Freenom/Domain Steps
For beginners, Freenom is a good provider for obtaining domains for free. However the catch is that you can only use properly "Freenom" domains for free being .cf, .ml, .gq, ga and .tk. However these can be blocked rather easily.
<img src="https://cdn.discordapp.com/attachments/681203088862085168/820048397662158858/unknown.png" width="500"></img>
- Get some Freenom domains then add them to your Heroku instance (Personal > [App Name] > Settings > Domains)
Add a domain for both `www.youdomainhere.cf` and `yourdomainhere.cf` with .cf being interchangeable with other Freedom domain names.
- If you prefer to obtain premium domains (TLDs) then use <a href="https://porkbun.com">Porkbun</a>, which offers domains for amazing prices. Literally a `.net` domain normally costs around $10. On Porkbun for the first year it costs $3 so its definitely a deal.
**The configuration being used on the official sites currently are the below:**
#### Cloudflare Steps
- Use Cloudflare (make an account), add your site (Freenom Domain or Domain) and then add your various DNS targets to Cloudflare. Make sure you add Cloudflare's Nameservers which will be specified more when you are adding your site.
- `a.example.com` is used for Womginx.
- `c.example.com` is used for SysYA Proxy, Via Unblocker, and the Chatbox.
- `cdn.example.com` is used for a private, updated Alloy instance.
### Heroku Steps
So use Heroku to host. I favor it as a free choice.
Make sure they are CNAME although A records also work and try to follow this structure:
- First, obtain a card; (Prepaid, Debit, and Credit Cards work). It would be best if you had this to add custom domains to your Heroku instance.
- Make sure you connect your Heroku app to your GitHub and enable automatic deploys. It will make things easier. :)
**Type | Name | Target**
### Freenom/Domain Steps
For beginners, Freenom is a good provider for obtaining domains for free. However, the catch is that you can only use properly "Freenom" domains for free, being .cf, .ml, .gq, ga, and .tk. However, these can be blocked relatively easily.
`CNAME | www | yourherokutargethere.herokudns.com `
`CNAME | @ | yourherokudnstargethere.herokudns.com`
- Get some Freenom domains, then add them to your Heroku instance (Personal > [App Name] > Settings > Domains).
- Add a domain for both www.youdomainhere.cf and yourdomainhere.cf with .cf being interchangeable with other Freedom domain names.
**Below are if you want external proxies also with your site:**
If you prefer to obtain premium domains (TLDs), then use Porkbun, which offers domains for excellent prices. A .net domain typically costs around $10. On Porkbun for the first year, it costs $3, so it is a deal.
`CNAME | a | yournodeinstance.herokudns.com`
`CNAME | pd | yourpydodgebinstancehere.herokudns.com`
`CNAME | p | yoursysyainstancehere.herokudns.com`
### Cloudflare Steps
Use Cloudflare (make an account), add your site (Freenom Domain or Domain), and then add your various DNS targets to Cloudflare. Make sure you add Cloudflare's Nameservers which will be specified more when you are adding your site.
Make sure HTTPS is forced and have SSL set to Flexible for Heroku. Otherwise you can have SSL set to Full.
Lastly, for targets, make sure they are either a CNAME, AAAA, or A records and try to follow this structure:
#### Workspace Configurations
Preferably if you have your own device use Visual Studio Code. Pretty much the best option you can get but obviously this is an opinion. Also make sure you have <a href="https://nodejs.org/">Node.JS</a> installed on your machine.
Type | Name | Target
Not going to go too in depth with this part but first fork this repository. The clone it locally through a Terminal of some sort depending on what OS you are on. Make sure you navigate to the folder you want to set this up in.
`CNAME | @ | yourherokudnstargethere.herokudns.com` or `CNAME | @ | example.com`
`CNAME | www | yourherokutargethere.herokudns.com` or `CNAME | www | example.com`
Below are if you want external proxies also with your site:
`CNAME | a | yourwomginxinstance.herokudns.com` or `CNAME | a | example.com`
`CNAME | c | yoursysyaproxyinstancehere.herokudns.com` or `CNAME | c | example.com`
(You get the idea.)
Make sure HTTPS is forced and have SSL set to Flexible for Heroku. Otherwise, you may have SSL set to Full. Use LetsEncrypt for SSL certificates or Cloudflare.
## Workspace Configurations
Preferably use Visual Studio Code for an IDE. Pretty much the best option you can get, but obviously, this is an opinion. Also, make sure you have Node.JS installed on your machine.
Not going to go too in-depth with this part but first, fork or clone this repository. Clone it locally through a terminal of some sort, depending on what OS you are on.
Make sure you navigate to the folder you want to set this up in.
```
git clone https://github.com/QuiteAFancyEmerald/HolyUnblockerPublic.git
cd HolyUnblockerPublic
npm install
$ git clone https://github.com/QuiteAFancyEmerald/HolyUnblockerPublic.git
$ cd HolyUnblockerPublic
$ npm install
```
Setup pm2 (Optional - Node.js Process Manager)
```
$ npm install pm2@latest -g
$ pm2 start app.js
```
Useful pm2 Flags
```
# Specify an app name
--name <app_name>
Now simply add the folder you cloned this repo in in VSC. Then run `npm install`. I recommend that if you are releasing this publically on GitHub that you add a `.gitignore` in your root directory with the following exclusions:
# Watch and Restart app when files change
--watch
# Set memory threshold for app reload
--max-memory-restart <200MB>
```
For more information, view the official pm2 documentation here.
#### Workspace Setup (continued)
Now add the folder you cloned in VSC. Then run npm install. It is recommended that if you are releasing this publically on GitHub that you add a .gitignore in your root directory with the following exclusions:
`node_modules`
Now you have your following workspace environment setup. To deploy the following workspace you just created you will need to look up depending on your hosting provider.
Now you have your following workspace environment setup. To deploy the following workspace you just created, you will need to lookup depending on your hosting provider.
For an online IDE that you can use on your school computer and/or chromebook use GitPod. Basically the equivalent of Visual Studio Code but with in-browser support.
- Make an account: `https://gitpod.io/`
- For an online IDE that you can use on your school computer or Chromebook, use GitPod. The equivalent of Visual Studio Code but with in-browser support.
- Make an account: https://gitpod.io/.
- Fork this repo and enter in this URL to set up your workspace: `https://gitpod.io#https://github.com/YourNameHere/HolyUnblockerPublic/`
Use the same steps above by running `npm install` in your repository and adding a `.gitignore` in your root directory specifying to exclude `node_modules`.
Use the same steps above by running npm install in your repository and adding a .gitignore in your root directory specifying to exclude `node_modules`.
## Detailed FAQ
A detailed FAQ with common issues and solutions can be found <a href="https://holyubofficial.net/?faq">here</a> or on any official HU site on the FAQ page.
A detailed FAQ with common issues and solutions can be found here or on any official HU site on the FAQ page.
**Why are YouTube videos not working?**
If you have persistent issues even after doing the steps above, the instance is down temporarily, especially if large groups of people are also having the issue. The latest release of Alloy currently does not have support for YouTube. However, manually putting in full links like `https://www.youtube.com/watch?v=mauV2NdCs60` will work. You may also try doing a Hard Reload (Ctrl+Shift+R)
A later release of Alloy may fix this issue. Sorry.
**Why is the site I am on not working correctly or having CAPTCHA errors?**
Captcha support is currently not available on all of the current proxies sadly. Therefore some sites may not work with any of the sites. Read below for issues with links on sites.
Captcha has limited support on Womginx. However, support is not available on some of the older proxies, sadly. Therefore some sites may not work with any of the sites. Read below for issues with links on sites.
**Why are some page links not working or leading to 404 pages?**
**Why are page links not working or leading to 404 pages?**
This is an issue with the latest release of Alloy proxy but it may also occur with other proxies.
This is an issue with Alloy proxy's latest release, but it may also occur with other proxies. In this case, manually entering the URL of the page you would like to view can solve this, or try navigating using the home button. (Reddit, Twitter) The next release of Alloy may fix this also.
In this case manually entering the URL of the page you would like to view can solve this or try navigating using the home button. (Reddit, Twitter) The next release of Alloy may fix this also.
**When using YouTube on any of the proxy sites, why does the page not load fully or the video is just white?**
**When using YouTube on any of the proxy sites, why does the page not load entirely, or the video just white?**
There are two methods for fixing this:
- Reloading the page usually when the error above happens should load the video.
- Alternatively, right-clicking the page and doing Reload Frame if you are using some form of Stealth Mode may work.
- Reloading the page normally when the error above happens should load the video.
- Or right-clicking the page and doing Reload Frame if you are using some form of Stealth Mode.
**When using Discord under Alloy or SysYa, why does the page stay gray/white, or the QR code not loading? **
**When using Discord under Alloy or SysYa, why does the page stay gray/white or the QR code not load?**
Womginx now supports logging in, usually for Discord. However, here are the steps related to Alloy troubleshooting.
Note that this is for the older discord proxy steps with Alloy and SysYA Proxy.
Once again do the same steps above:
- Reloading the page normally when the error above happens should load the video
- Or right-clicking the page and doing Reload Frame if you are using some form of Stealth Mode.
Make sure you are also doing the steps correctly. Simply view link above for extended Discord proxy information/steps.
**I am getting 502 errors. What do I do?**
When this happens you may either switch sites to fix the error or wait a bit. Sometimes clearing your cache can help.
If you still have any questions feel free to ask them in the discord linked here.
**On the official sites, I am getting 502 errors. What do I do?**
The proxy may be down, being worked on, or is under high load.
When this happens, you may either switch sites to fix the error or wait a bit. Sometimes clearing your cache can help by doing Ctrl+Shift+R or reloading the page usually. (Hard Reload, which purges cache.)
## More Information
This project uses Alloy Proxy, Node Unblocker, SysYa and PyDodge which are linked below.
This project is maintained by Quite A Fancy Emerald with massive help from BinBashBanana (OlyB) and is an official flagship Titanium Network proxy site.
View the official website for more detail and credits.
- https://github.com/titaniumnetwork-dev/
- https://github.com/titaniumnetwork-dev/alloy
- https://github.com/binary-person/womginx
- https://github.com/sysce/proxy
- https://github.com/BinBashBanana/PyDodge
- https://github.com/nfriedly/node-unblocker
- https://nodeclusters.com
- https://titaniumnetwork.org/
- https://github.com/vibedivide/vibeOS
- https://github.com/titaniumnetwork-dev/
This project is maintained by QuiteAFancyEmerald and collaborative with Titanium Network.
View the official website for more details or credits.
Thanks.
### Proxy Sources:
This project uses Alloy Proxy, Womginx, SysYA Proxy, and Via Unblocker, linked below.
- https://github.com/titaniumnetwork-dev/alloy (Alloy)*
- https://github.com/binary-person/womginx (Womginx)
- https://github.com/sysce/proxy (SysYA Proxy)
- https://github.com/hypothesis/via (Via)**
- https://github.com/BinBashBanana/PyDodge (PyDodge)**
- https://github.com/nfriedly/node-unblocker (Node Unblocker)***
### Notable Mentions:
- https://dedipath.com (Hosting Provider)
### Footnotes:
- This distribution of Holy Unblocker uses an older version of Alloy Proxy.
- The official Holy Unblocker sites use a private, modified version of Via and goes under the name PyDodge for any modified version.
- Node Unblocker is no longer used on any of the official Titanium Network flagship sites.
Thanks. :D