review 2: client docs

This commit is contained in:
Christopher Dixon
2024-03-05 09:27:57 -05:00
parent 91ad96ea92
commit ab0bf06a00

View File

@@ -59,21 +59,9 @@ services:
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
@@ -87,13 +75,13 @@ services:
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.
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 -d
$ docker compose up --detach
```
8. Verify that setup was successful
@@ -116,10 +104,6 @@ $ docker compose up -d
1. Make sure `movie-web` is your current working directory and run:
```bash
# Stop the running container
$ docker compose stop
# Remove the stopped container
$ docker compose rm
# Re-build the image and start the container
$ docker compose up -d
$ docker compose up --build --detach
```