docs/content/3.client/1.deploy.md

title

title
Deploy

Deploying the client

Method 1 - Vercel - Recommended

1. Click the Deploy button.

2. Sign in using either a GitHub, GitLab, or Bitbucket.

3. Follow the instructions to create a repository for movie-web.

4. Configure the environment variables:

   • VITE_CORS_PROXY_URL: Enter your proxy URL here. Make sure to not have a slash at the end of your URL.

     Example (THIS IS AN EXAMPLE, IT WON'T WORK FOR YOU): https://test-proxy.test.workers.dev

   • VITE_TMDB_READ_API_KEY: Enter your TMDB Read Access Token here. Please read the TMDB page on how to get an API key.

   • VITE_BACKEND_URL: Only set if you have a self-hosted backend. Put in your backend URL. Check out configuration reference for details. Make sure to not have a slash at the end of the URL.

5. Click "Deploy"

6. Congrats! You have your own version of movie-web hosted.

7. You may wish to configure a custom domain - Please consult the Vercel docs for how to do this.

Method 2 - Static Web Host

1. Download the file movie-web.zip from the latest release: https://github.com/movie-web/movie-web/releases/latest.

2. Extract the ZIP file so you can edit the files.

3. Open config.js in an editor such as Notepad, Visual Studio Code or similar.

4. Put your proxy URL in-between the double quotes of VITE_CORS_PROXY_URL: "". Make sure to not have a slash at the end of your URL.

   Example (THIS IS AN EXAMPLE, IT WON'T WORK FOR YOU): VITE_CORS_PROXY_URL: "https://test-proxy.test.workers.dev"

5. Put your TMDB Read Access Token inside the quotes of VITE_TMDB_READ_API_KEY: "". Please read the TMDB page on how to get an API key.

6. If you have a self-hosted backend server, enter your URL in the VITE_BACKEND_URL variable. Check out configuration reference for details. Make sure to not have a slash at the end of the URL.

7. Save the file.

8. Upload all of the files to a static website hosting such as:

   • GitHub Pages
   • Netlify
   • Vercel
   • Etc, there are lots of options{target="_blank"}.

9. Congrats! You have your own version of movie-web hosted.

Method 3 - Docker Compose - Home Network

This method is meant for those using a desktop device or single board computer with a minimum 4GB of RAM such as a Raspberry Pi to run movie-web on there home network to make a private instance of movie-web available to their network devices.

1. Download the file movie-web.zip from the latest release: https://github.com/movie-web/movie-web/releases/latest.
2. Extract the ZIP file so you can edit the files.
3. Open docker-compose.yaml and uncomment args, TMDB_READ_API_KEY, CORS_PROXY_URL.

• Make sure args is in-line with context
• Make sure TMDB_READ_API_KEY and CORS_PROXY_URL are tabbed once to the right of args.

4. Put your proxy URL in-between the double quotes of CORS_PROXY_URL: "". Make sure to not have a slash at the end of your URL.

   Example (THIS IS AN EXAMPLE, IT WON'T WORK FOR YOU): VITE_CORS_PROXY_URL: "https://test-proxy.test.workers.dev"

5. Put your TMDB Read Access Token inside the quotes of TMDB_READ_API_KEY: "". Please read the TMDB page on how to get an API key.

6. Uncomment and add any additional environment variables you may need

7. Save the file

8. Use [docker] to run movieweb as background service

# movie-web is current working directory
$ docker compose up -d

9. Verify that setup was successful

• Navigate to http://localhost. You should see the UI for movie-web. Find something to watch and make sure that it plays.

• View logs with

  $ docker compose logs --follow movieweb
  

10. Set a static IP address for your device.

• For Raspberry Pi: guide
• For Mac: guide
• For Windows: guide

11. Navigate to movie web at http://<static-ip-address from another device connected to your network