docs/content/2.proxy/1.deploy.md

title
Deploy

Deploying the proxy

Method 1 - Cloudflare (Easy)

Cloudflare has a generous free plan, so you don't need to pay anything unless you get hundreds of users.

{target="_blank"}

1. Create a GitHub account at https://github.com if you don't have one.
2. Click the Deploy with workers button above.
3. Click the Authorize Workers button to authorize Cloudflare to talk to GitHub.
4. Authorize Cloudflare Workers in the GitHub page that pops up.
5. 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.
6. Click the link to Workers Dashboard{target="_blank"} to find your account ID.
   1. 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.
   2. Paste the account ID into the text box on the original Cloudflare workers page.
7. Click the link to My Profile{target="_blank"}, to create an API token.
   1. Click Create Token.
   2. Select Use template next to Edit Cloudflare Workers.
   3. Under Account Resources, select Include and your account under the dropdown.
   4. Under Zone Resources, select All zones (You can select a more specific zone if you have the zones available).
   5. At the bottom of the page, click Continue to summary.
   6. On the next screen, click Create token.
   7. Copy the API token and save it in a safe place, it won't be shown again.
   8. Paste the API token into the Cloudflare Workers API Token text box.
8. Click Fork the Repository and follow the instructions to enable workflows.
9. Click Deploy to deploy to Cloudflare Workers.
10. Congratulations! Your worker is now deploying. Please wait for the GitHub Action to build and publish your worker.
11. You can click the Worker dash{target="_blank"} and GitHub repo buttons to see the status of the deploy.
12. 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{target="_blank"} -> Proxy.

Method 1 - Cloudflare (Manual)

1. Login to your Cloudflare account if you have one, otherwise create one here
   1. If you are signing up for an account, make sure to verify your email before going further!
2. Download the latest version of the Cloudflare simple-proxy-cloudflare.mjs script from here.
3. Go to Workers & Pages and then Overview in the left-hand navigation bar.
4. Click the Create Worker button
   1. If you've made a worker or pages application before, you will need to click Create Application first
5. Give your worker a name and click Deploy. This can be anything you would like!
6. On the Congratulations web page, click the Edit code button to edit the code in the worker you have just created.
7. There should now be a code editor on the left hand side on the web page.
   1. Select all of the existing template code and delete it. You must make sure all of the code is deleted for this to work!
   2. Go to your downloads folder and open up the simple-proxy-cloudflare.mjs file you downloaded earlier in a text editor, and copy the contents.
   3. Back in your browser, paste the contents of the file into the code editor.
8. The Save and deploy button in the top right corner should now be active, click it to deploy your proxy!
9. A confirmation dialog will appear, click Save and deploy once more.
10. Your worker is now deployed! You can click the back button in the top left to take you back to the summary screen.
11. 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 2 - Docker

::alert{type="warning"} Experience with Docker, domains and web hosting is highly recommended for this method.
Deploying with Cloudflare is easier and safer to do! You are exposing your server at your own risk! ::

Our simple-proxy application is available from the GitHub Container Registry under the image ghcr.io/movie-web/simple-proxy:latest{target="_blank"} :copy-button{content="ghcr.io/movie-web/simple-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.