diff --git a/content/3.client/1.deploy.md b/content/3.client/1.deploy.md index 8942d7a..d718b9d 100644 --- a/content/3.client/1.deploy.md +++ b/content/3.client/1.deploy.md @@ -43,3 +43,67 @@ 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 of 4GB of RAM such as a [Raspberry Pi](https://www.raspberrypi.com/) to run movie-web on there home network for network connected devices. + +1. Ensure you have [docker](https://docs.docker.com/get-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. + +```yaml +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 +``` + +2. 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`. +3. 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"` + +4. 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. +5. Uncomment and add any [additional environment variables](3.configuration.md) you may need. Remove the `VITE_` prefix when adding an environment variable to `args`. +6. Save the file! +7. Now use [docker](https://docs.docker.com/get-docker/) to run `movieweb` as background service. + +```bash +# movie-web is the current working directory +$ docker compose up --detach +``` + +8. 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 + ``` + +9. 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) + +10. Navigate to movie web at `http://