Proxy
Deploying the proxy#
Method 1 - Netlify (Easy)#
Netlify has a very generous free plan, so you'll be able to host your proxy for free unless you get hundreds of users.
Create a GitHub account at https://github.com/signup if you don't have one already.
Click on the Deploy to Netlify
button above.
- Authorize Netlify to connect with GitHub by clicking the
Connect to GitHub
button.
There should now be a Save & Deploy
button, click it.
Once the deployment is complete, click on the Get Started
button that pops up, this will redirect you to the dashboard of your site.
Click on the only site in the Sites
section of your dashboard.
Find the link of your site near the top of the page, it should look something like https://<random-words>.netlify.app
. Right click the link, click Copy link address
. Now you'll just have to set up the client!
Method 2 - Cloudflare (Easy)#
Cloudflare has a generous free plan, so you don't need to pay anything unless you get hundreds of users.
Create a GitHub account at https://github.com if you don't have one.
Click the Deploy with workers
button above.
Click the Authorize Workers
button to authorize Cloudflare to talk to GitHub.
Authorize Cloudflare Workers in the GitHub page that pops up.
Follow the instructions to configure your Cloudflare account. Select I have an account
if you have a Cloudflare account already, otherwise follow the link to create one.
Click the link to Workers Dashboard
to find your account ID.
- You can copy your account ID from the URL e.g. https://dash.cloudflare.com/ab7cb454c93987b6343350d4e84c16c7/workers-and-pages/create where
ab7cb454c93987b6343350d4e84c16c7
is the account ID. - Paste the account ID into the text box on the original Cloudflare workers page.
Click the link to My Profile
, to create an API token.
- Click
Create Token
. - Select
Use template
next toEdit Cloudflare Workers
. - Under
Account Resources
, selectInclude
and your account under the dropdown. - Under
Zone Resources
, selectAll zones
(You can select a more specific zone if you have the zones available). - At the bottom of the page, click
Continue to summary
. - On the next screen, click
Create token
. - Copy the API token and save it in a safe place, it won't be shown again.
- Paste the API token into the Cloudflare Workers API Token text box.
Click Fork the Repository
and follow the instructions to enable workflows.
Click Deploy
to deploy to Cloudflare Workers.
Congratulations! Your worker is now deploying. Please wait for the GitHub Action to build and publish your worker.
You can click the Worker dash
and GitHub repo
buttons to see the status of the deploy.
When the worker has deployed, you will need to take note of the URL. This can be found on Cloudflare under Workers and Pages -> Overview -> Proxy.
Use the URL you took note of and set up a custom proxy in the client.
Method 2 - Cloudflare (Manual)#
Login to your Cloudflare account if you have one, otherwise create one here
- If you are signing up for an account, make sure to verify your email before going further!
Download the latest version of the Cloudflare sudo-proxy-cloudflare.mjs
script from here.
Go to Workers & Pages
and then Overview
in the left-hand navigation bar.
Click the Create Worker
button
- If you've made a worker or pages application before, you will need to click
Create Application
first - Give your worker a name and click
Deploy
. This can be anything you would like!
On the Congratulations
web page, click the Edit code
button to edit the code in the worker you have just created.
There should now be a code editor on the left hand side on the web page.
- Select all of the existing template code and delete it. You must make sure all of the code is deleted for this to work!
- Go to your downloads folder and open up the
sudo-proxy-cloudflare.mjs
file you downloaded earlier in a text editor, and copy the contents. - Back in your browser, paste the contents of the file into the code editor.
The Save and deploy
button in the top right corner should now be active, click it to deploy your proxy!
A confirmation dialog will appear, click Save and deploy
once more.
Your worker is now deployed! You can click the back button in the top left to take you back to the summary screen.
On the summary screen, your worker link will be displayed under Preview
. Right click the link, click Copy link address
and save the link somewhere - you will need it to set up the client!
Method 3 - Railway (Easy)#
Railway offers you $5 of credit once you verify your account, which is enough to run the proxy for around 5-7 months.
Login to your Railway account if you have one, otherwise create one here.
- If you are signing up, then verify your account by clicking the link in the email Railway sends you.
- If you created your account with an email, then to verify your account further, go to your account, then plans and verify your account with a GitHub account.
Click the Deploy on Railway
button above.
If a Configure
button is displayed, click on it and allow Railway to access your GitHub account.
The Deploy
button at the bottom of the template should be active, click on it.
Once the proxy has deployed, copy the URL from the Deployments
page.
Congratulations! You have deployed the proxy, you can now set up the client.
Method 4 - Docker#
Experience with Docker, domains and web hosting is highly recommended for this method.
Deploying with Netlify is easier and safer to do! You are exposing your server at your own risk!
Our sudo-proxy
application is available from the GitHub Container Registry under the image ghcr.io/sussy-code/sudo-proxy:latest
The container exposes the HTTP port (Without TLS/SSL) as 3000/TCP
.
If you know what you are doing, you should know what to do with this information. If you don't, then please follow our Cloudflare guides.