Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md to reflect uv update; make environment setting more clear #242

Merged
merged 1 commit into from
Feb 26, 2025
Merged

Update README.md to reflect uv update; make environment setting more clear #242

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 4 additions & 9 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,20 +48,14 @@ Full list of configuration options can be found in the [.env.sample](.env.sample

### Baremetal

- Setup virtualenv of your choice
- [Install uv](https://docs.astral.sh/uv/getting-started/installation/)

- Install dependencies

```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
- 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.)

- Run

```bash
python main.py
uv run main.py
```

### Docker
Expand Down Expand Up @@ -104,6 +98,7 @@ Full list of configuration options can be found in the [.env.sample](.env.sample

- Configuration
- 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

Expand Down
Loading