From 0cedc72bb34a29ff86499cdf67032640d543cb09 Mon Sep 17 00:00:00 2001 From: Christopher Dixon Date: Tue, 27 Feb 2024 22:17:34 -0500 Subject: [PATCH] Update client docs - 3rd option docker compose --- content/3.client/1.deploy.md | 39 ++++++++++++++++++++++++++++++++++++ 1 file changed, 39 insertions(+) diff --git a/content/3.client/1.deploy.md b/content/3.client/1.deploy.md index 8942d7a..a70ec2f 100644 --- a/content/3.client/1.deploy.md +++ b/content/3.client/1.deploy.md @@ -43,3 +43,42 @@ title: 'Deploy' - Vercel - Etc, [there are lots of options](https://www.staticwebsitehosting.org/){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](https://www.raspberrypi.com/) 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](2.tmdb.md) on how to get an API key. +6. Uncomment and add any [additional environment variables](3.configuration.md) you may need +7. Save the file +8. Use [docker] to run `movieweb` as background service + +```bash +# 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 + + ```bash + $ docker compose logs --follow movieweb + ``` + +10. Set a static IP address for your device. +- For Raspberry Pi: [guide](https://www.makeuseof.com/raspberry-pi-set-static-ip/) +- For Mac: [guide](https://www.macinstruct.com/tutorials/how-to-set-a-static-ip-address-on-a-mac/) +- For Windows: [guide](https://www.pcmag.com/how-to/how-to-set-up-a-static-ip-address) + +11. Navigate to movie web at `http://