Unverified Commit 74b6c574 authored by TheTechRobo's avatar TheTechRobo Committed by GitHub
Browse files

Update README.md

parent 24e07175
Loading
Loading
Loading
Loading
+6 −3
Original line number Diff line number Diff line
@@ -12,9 +12,9 @@ There are docstrings included in the module (it is contained in `lostmediafinder

## Frontend
### Running in Docker (recommended):
The software is available on Docker Hub: <https://hub.docker.com/r/thetechrobo/findyoutubevideo> Let me know if it doesn't work or if you need help.
There is an included Dockerfile. I will figure out publishing to Docker Hub soon enough.

Instead of modiying the gunicorn config, use `GUNICORN_<VARIABLE_NAME>` environment variables; the config is setup to work with that. For example, `GUNICORN_WORKERS` is the number of threads that are spawned to handle requests.
Instead of modiying the Hypercorn config, use `HYPERCORN_<VARIABLE_NAME>` environment variables; the config is setup to work with that.

A command like this should work (runs on port 8000; change the `-p` flag to `<whatever port you want>:8000` to change that):

@@ -22,6 +22,9 @@ A command like this should work (runs on port 8000; change the `-p` flag to `<wh
docker run --restart=unless-stopped -p 8000:8000 -e GUNICORN_WORKERS=4 thetechrobo/findyoutubevideo
```

### Running outside of Docker (unsupported)
You should be able to check the Dockerfile for what it is doing during the build (it's a glorified shell script).

## Licence

Copyright (c) 2022-2024 TheTechRobo