5.0 KiB
title |
---|
Deploy |
Deploying the client
Method 1 - Vercel - Recommended
-
Click the Deploy button.
-
Sign in using either a GitHub, GitLab, or Bitbucket.
-
Follow the instructions to create a repository for movie-web.
-
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.
-
-
Click "Deploy"
-
Congrats! You have your own version of movie-web hosted.
-
You may wish to configure a custom domain - Please consult the Vercel docs for how to do this.
Method 2 - Static Web Host
-
Download the file
movie-web.zip
from the latest release: https://github.com/movie-web/movie-web/releases/latest. -
Extract the ZIP file so you can edit the files.
-
Open
config.js
in an editor such as Notepad, Visual Studio Code or similar. -
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"
-
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. -
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. -
Save the file.
-
Upload all of the files to a static website hosting such as:
- GitHub Pages
- Netlify
- Vercel
- Etc, there are lots of options{target="_blank"}.
-
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.
- Ensure you have docker installed. In a newly created directory called
movie-web
create a file calleddocker-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:
# TMDB_READ_API_KEY: ""
# CORS_PROXY_URL: ""
# BACKEND_URL: ""
ports:
- "80:80"
restart: unless-stopped
- Within the
docker-compose.yaml
file uncommentargs
,TMDB_READ_API_KEY
,CORS_PROXY_URL
.
- Make sure
args
is in-line withcontext
- Make sure
TMDB_READ_API_KEY
andCORS_PROXY_URL
are tabbed once to the right ofargs
.
-
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"
-
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. -
Uncomment and add any additional environment variables you may need. Remove the
VITE_
prefix when adding an environment variable toargs
. -
Save the file!
-
Now use docker to run
movieweb
as background service.
# movie-web is the current working directory
$ docker compose up --detach
- Verify that setup was successful
-
Navigate to
http://localhost
. You should see the UI formovie-web
. Find something to watch and make sure that it plays. -
View logs with
$ docker compose logs --follow movieweb
- Set a static IP address for your device.
- Navigate to movie web at
http://<static-ip-address
from another device connected to your network.
To Perform Updates For New Releases of Movie Web
- Make sure
movie-web
is your current working directory and run:
# Re-build the image and start the container
$ docker compose up --build --detach