Merge pull request #242 from BadCoder2/patch-1

Update README.md to reflect uv update; make environment setting more clear
This commit is contained in:
Luigi311
2025-02-25 23:05:30 -07:00
committed by GitHub

View File

@@ -48,20 +48,14 @@ Full list of configuration options can be found in the [.env.sample](.env.sample
### Baremetal ### Baremetal
- Setup virtualenv of your choice - [Install uv](https://docs.astral.sh/uv/getting-started/installation/)
- Install dependencies - Create a .env file similar to .env.sample; fill in baseurls and tokens, **remember to uncomment anything you wish to use** (e.g., user mapping, library mapping, black/whitelist, etc.)
```bash
pip install -r requirements.txt
```
- Create a .env file similar to .env.sample, uncomment whitelist and blacklist if needed, fill in baseurls and tokens
- Run - Run
```bash ```bash
python main.py uv run main.py
``` ```
### Docker ### Docker
@@ -104,6 +98,7 @@ Full list of configuration options can be found in the [.env.sample](.env.sample
- Configuration - Configuration
- Do not use quotes around variables in docker compose - Do not use quotes around variables in docker compose
- If you are not running all 3 supported servers, that is, Plex, Jellyfin, and Emby simultaneously, make sure to comment out the server url and token of the server you aren't using.
## Contributing ## Contributing