dev
/
docs
mirror of https://github.com/sussy-code/docs.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
docs/content/3.client/1.deploy.md

5.1 KiB
Raw Blame History

title
Deploy

Deploying the client

Method 1 - Vercel - Recommended

Deploy with Vercel

  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:

  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 of 4GB of RAM such as a Raspberry Pi to run movie-web on there home network for network connected devices.

  1. Ensure you have docker installed. In a newly created directory called movie-web create a file called docker-compose.yaml. Paste the contents of the code block below into this file.
version: "3.8"

services:

  movieweb:
    build:
      context: https://github.com/movie-web/movie-web.git
      # args:
      #   PWA_ENABLED: "false"
      #   GA_ID: ""
      #   APP_DOMAIN: ""
      #   OPENSEARCH_ENABLED: "false"
      #   TMDB_READ_API_KEY: ""
      #   CORS_PROXY_URL: ""
      #   DMCA_EMAIL: ""
      #   NORMAL_ROUTER: "false"
      #   BACKEND_URL: ""
      #   HAS_ONBOARDING: "false"
      #   ONBOARDING_CHROME_EXTENSION_INSTALL_LINK: ""
      #   ONBOARDING_PROXY_INSTALL_LINK: ""
      #   DISALLOWED_IDS: ""
      #   CDN_REPLACEMENTS: ""
      #   TURNSTILE_KEY: ""
    ports:
      - "80:80"
    restart: unless-stopped
  1. Within the docker-compose.yaml file 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.

  1. 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): CORS_PROXY_URL: "https://test-proxy.test.workers.dev"

  2. 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.

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

  4. Save the file!

  5. Now use docker to run movieweb as background service.

# movie-web is the current working directory
$ docker compose up -d
  1. 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
  1. Set a static IP address for your device.
  1. Navigate to movie web at http://<static-ip-address from another device connected to your network.