MasterHttpRelayVPN/docs/GETTING_STARTED.md

Getting Started

This guide keeps only the setup path most users need. Follow it once, then come back to the root README only when you need another topic.

What You Need

• Python 3.10 or newer
• A free Google account
• Git, or the ZIP download from GitHub
• A browser where you can set an HTTP proxy

1. Get The Project

Choose whichever option works on your network.

Option A: ZIP

Click to Download

Option B: Git

git clone https://github.com/masterking32/MasterHttpRelayVPN.git
cd MasterHttpRelayVPN

2. Deploy The Google Relay

The relay is the small Apps Script program that fetches websites for you.

1. Open Google Apps Script and sign in.

2. Click New project.

3. Delete the default editor content.

4. Open apps_script/Code.gs, copy everything, and paste it into Apps Script.

5. Change this line to a long secret:

   const AUTH_KEY = "your-secret-password-here";
   

6. Click Deploy -> New deployment.

7. Select Web app.

8. Set Execute as to Me.

9. Set Who has access to Anyone.

10. Click Deploy, authorize the app, and copy the Deployment ID.

Keep the AUTH_KEY and Deployment ID nearby. You need both locally.

3. Run The One-Click Launcher

Windows

start.bat

Linux / macOS

chmod +x start.sh
./start.sh

The launcher creates .venv, installs dependencies, runs setup.py if config.json is missing, and starts the proxy.

If dependency installation fails through PyPI, the launcher retries through the runflare mirror automatically.

4. Answer The Setup Wizard

When the wizard opens:

1. Enter the same auth_key you placed inside apps_script/Code.gs.
2. Paste the Apps Script Deployment ID.
3. Keep the default HTTP proxy port 8085 unless you already use that port.
4. Keep LAN sharing off unless other devices must use this proxy.

The wizard writes config.json for you.

5. Configure Your Browser

Use the HTTP proxy for normal browsing:

Field	Value
Proxy type	HTTP
Address	127.0.0.1
Port	8085

Firefox path: Settings -> General -> Network Settings -> Manual proxy. Enter 127.0.0.1 and 8085, then enable the option to also use it for HTTPS.

Chrome and Edge use the system proxy on Windows. You can also use extensions such as FoxyProxy or SwitchyOmega for easier switching.

6. Install The CA Certificate

HTTPS browsing needs the local CA certificate generated by the proxy. The file is created at ca/ca.crt after first run.

The app tries to install it automatically. If it cannot, install it manually:

Windows

1. Double-click ca/ca.crt.
2. Choose Install Certificate.
3. Choose Current User.
4. Choose Place all certificates in the following store.
5. Select Trusted Root Certification Authorities.
6. Finish, then fully restart your browser.

macOS

1. Open ca/ca.crt in Keychain Access.
2. Find the certificate and open it.
3. Expand Trust.
4. Set When using this certificate to Always Trust.
5. Close the dialog, enter your password, and restart your browser.

Linux Ubuntu / Debian

sudo cp ca/ca.crt /usr/local/share/ca-certificates/masterhttp-relay.crt
sudo update-ca-certificates

Restart your browser after installing.

Firefox

Firefox may use a separate certificate store:

1. Open Settings -> Privacy & Security -> Certificates -> View Certificates.
2. Go to Authorities.
3. Click Import and select ca/ca.crt.
4. Enable Trust this CA to identify websites.

Manual Run Commands

Use these only if you are not using the launcher:

python -m venv .venv
.venv\Scripts\python -m pip install -r requirements.txt
.venv\Scripts\python setup.py
.venv\Scripts\python main.py

On Linux / macOS, replace .venv\Scripts\python with .venv/bin/python.

Done

When everything is working, the terminal shows the HTTP proxy on 127.0.0.1:8085 and SOCKS5 on 127.0.0.1:1080.

Next useful pages:

• Troubleshooting
• Configuration Reference
• Exit Node Guide