bel
/
JellyPlex-Watched
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

README: Formatting

pull/175/head
Luis Garcia 2024-06-02 23:22:06 -06:00
parent a397ceb54e
commit 74f29d44b3
1 changed files with 53 additions and 53 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

70
README.md
View File

@ -1,6 +1,6 @@
# JellyPlex-Watched # JellyPlex-Watched
[![Codacy Badge](https://app.codacy.com/project/badge/Grade/26b47c5db63942f28f02f207f692dc85)](https://www.codacy.com/gh/luigi311/JellyPlex-Watched/dashboard?utm_source=github.com\&utm_medium=referral\&utm_content=luigi311/JellyPlex-Watched\&utm_campaign=Badge_Grade) [![Codacy Badge](https://app.codacy.com/project/badge/Grade/26b47c5db63942f28f02f207f692dc85)](https://www.codacy.com/gh/luigi311/JellyPlex-Watched/dashboard?utm_source=github.com&utm_medium=referral&utm_content=luigi311/JellyPlex-Watched&utm_campaign=Badge_Grade)
Sync watched between jellyfin, plex and emby locally Sync watched between jellyfin, plex and emby locally
@ -12,33 +12,33 @@ Keep in sync all your users watched history between jellyfin, plex and emby serv
### Plex ### Plex
* \[x] Match via filenames - \[x] Match via filenames
* \[x] Match via provider ids - \[x] Match via provider ids
* \[x] Map usernames - \[x] Map usernames
* \[x] Use single login - \[x] Use single login
* \[x] One way/multi way sync - \[x] One way/multi way sync
* \[x] Sync watched - \[x] Sync watched
* \[x] Sync in progress - \[x] Sync in progress
### Jellyfin ### Jellyfin
* \[x] Match via filenames - \[x] Match via filenames
* \[x] Match via provider ids - \[x] Match via provider ids
* \[x] Map usernames - \[x] Map usernames
* \[x] Use single login - \[x] Use single login
* \[x] One way/multi way sync - \[x] One way/multi way sync
* \[x] Sync watched - \[x] Sync watched
* \[x] Sync in progress - \[x] Sync in progress
### Emby ### Emby
* \[x] Match via filenames - \[x] Match via filenames
* \[x] Match via provider ids - \[x] Match via provider ids
* \[x] Map usernames - \[x] Map usernames
* \[x] Use single login - \[x] Use single login
* \[x] One way/multi way sync - \[x] One way/multi way sync
* \[x] Sync watched - \[x] Sync watched
* \[x] Sync in progress - \[x] Sync in progress
## Configuration ## Configuration
@ -48,17 +48,17 @@ Full list of configuration options can be found in the [.env.sample](.env.sample
### Baremetal ### Baremetal
* Setup virtualenv of your choice - Setup virtualenv of your choice
* Install dependencies - Install dependencies
```bash ```bash
pip install -r requirements.txt 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, uncomment whitelist and blacklist if needed, fill in baseurls and tokens
* Run - Run
```bash ```bash
python main.py python main.py
@ -66,13 +66,13 @@ Full list of configuration options can be found in the [.env.sample](.env.sample
### Docker ### Docker
* Build docker image - Build docker image
```bash ```bash
docker build -t jellyplex-watched . docker build -t jellyplex-watched .
``` ```
* or use pre-built image - or use pre-built image
```bash ```bash
docker pull luigi311/jellyplex-watched:latest docker pull luigi311/jellyplex-watched:latest
@ -80,7 +80,7 @@ Full list of configuration options can be found in the [.env.sample](.env.sample
#### With variables #### With variables
* Run - Run
```bash ```bash
docker run --rm -it -e PLEX_TOKEN='SuperSecretToken' luigi311/jellyplex-watched:latest docker run --rm -it -e PLEX_TOKEN='SuperSecretToken' luigi311/jellyplex-watched:latest
@ -88,9 +88,9 @@ Full list of configuration options can be found in the [.env.sample](.env.sample
#### With .env #### With .env
* Create a .env file similar to .env.sample and set the variables to match your setup - Create a .env file similar to .env.sample and set the variables to match your setup
* Run - Run
```bash ```bash
docker run --rm -it -v "$(pwd)/.env:/app/.env" luigi311/jellyplex-watched:latest docker run --rm -it -v "$(pwd)/.env:/app/.env" luigi311/jellyplex-watched:latest
@ -98,12 +98,12 @@ Full list of configuration options can be found in the [.env.sample](.env.sample
## Troubleshooting/Issues ## Troubleshooting/Issues
* Jellyfin - Jellyfin
* Attempt to decode JSON with unexpected mimetype, make sure you enable remote access or add your docker subnet to lan networks in jellyfin settings
* Configuration - Attempt to decode JSON with unexpected mimetype, make sure you enable remote access or add your docker subnet to lan networks in jellyfin settings
* Do not use quotes around variables in docker compose
- Configuration
- Do not use quotes around variables in docker compose
## Contributing ## Contributing