Mirrors/Plex-Meta-Manager
2
0
Fork 0
mirror of https://github.com/meisnate12/Plex-Meta-Manager synced 2024-11-22 12:33:10 +00:00
Code Issues Projects Releases Packages Wiki Activity

reformatting, added docker

Browse source
This commit is contained in:
Chaz Larson 2023-12-02 17:33:18 -06:00 committed by GitHub
parent 3222135ba0
commit 043d15cb15
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 86 additions and 54 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

140
docs/pmm/essentials/kb.md
View file

@ -18,156 +18,188 @@ This sections aims to answer the most commonly asked questions that users have.
=== ":fontawesome-brands-linux: Linux"
[type this into your terminal]
```
cd /Users/mroche/Plex-Meta-Manager
[type this into your terminal, changing `YOUR_USERNAME`` to your username]
cd /Users/YOUR_USERNAME/Plex-Meta-Manager
git pull
source pmm-venv/bin/activate
python -m pip install -r requirements.txt
```
=== ":fontawesome-brands-apple: macOS"
[type this into your terminal]
```
cd /Users/mroche/Plex-Meta-Manager
[type this into your terminal, changing `YOUR_USERNAME`` to your username]
cd /Users/YOUR_USERNAME/Plex-Meta-Manager
git pull
source pmm-venv/bin/activate
python -m pip install -r requirements.txt
```
=== ":fontawesome-brands-windows: Windows"
[type this into your terminal]
```
cd C:\Users\mroche\Plex-Meta-Manager
[type this into your terminal, changing `YOUR_USERNAME`` to your username]
cd C:\Users\YOUR_USERNAME\Plex-Meta-Manager
git pull
.\pmm-venv\Scripts\activate
python -m pip install -r requirements.txt
```
=== ":fontawesome-brands-docker: Docker"
[type this into your terminal]
```
docker pull meisnate12/plex-meta-manager
```
[type this into your terminal]
docker pull meisnate12/plex-meta-manager:TAG_HERE
replacing TAG_HERE with latest, develop, or nightly [whichever you are currently using]
Then recreate your container via whatever means you used to create it [docker run, docker-compose, etc.].
If you are using Docker on a NAS like Synology or UNRaid, they will provide some means of doing those two things.
??? question "How do I switch to the develop branch?"
=== ":fontawesome-brands-linux: Linux"
[type this into your terminal]
```
cd /Users/mroche/Plex-Meta-Manager
[type this into your terminal, changing `YOUR_USERNAME`` to your username]
cd /Users/YOUR_USERNAME/Plex-Meta-Manager
git checkout develop
git pull
source pmm-venv/bin/activate
python -m pip install -r requirements.txt
```
=== ":fontawesome-brands-apple: macOS"
[type this into your terminal]
```
cd /Users/mroche/Plex-Meta-Manager
[type this into your terminal, changing `YOUR_USERNAME`` to your username]
cd /Users/YOUR_USERNAME/Plex-Meta-Manager
git checkout develop
git pull
source pmm-venv/bin/activate
python -m pip install -r requirements.txt
```
=== ":fontawesome-brands-windows: Windows"
[type this into your terminal]
```
cd C:\Users\mroche\Plex-Meta-Manager
[type this into your terminal, changing `YOUR_USERNAME`` to your username]
cd C:\Users\YOUR_USERNAME\Plex-Meta-Manager
git checkout develop
git pull
.\pmm-venv\Scripts\activate
python -m pip install -r requirements.txt
```
=== ":fontawesome-brands-docker: Docker"
[type this into your terminal]
docker pull meisnate12/plex-meta-manager:develop
Then recreate your container via whatever means you used to create it [docker run, docker-compose, etc.], changing the image in the docker command or the `docker-compose.yml` to `meisnate12/plex-meta-manager:develop`.
If you are using Docker on a NAS like Synology or UNRaid, they will provide some means of doing those two things.
??? question "How do I switch to the nightly branch"
=== ":fontawesome-brands-linux: Linux"
[type this into your terminal]
```
cd /Users/mroche/Plex-Meta-Manager
[type this into your terminal, changing `YOUR_USERNAME`` to your username]
cd /Users/YOUR_USERNAME/Plex-Meta-Manager
git checkout nightly
git pull
source pmm-venv/bin/activate
python -m pip install -r requirements.txt
```
=== ":fontawesome-brands-apple: macOS"
[type this into your terminal]
```
cd /Users/mroche/Plex-Meta-Manager
[type this into your terminal, changing `YOUR_USERNAME`` to your username]
cd /Users/YOUR_USERNAME/Plex-Meta-Manager
git checkout nightly
git pull
source pmm-venv/bin/activate
python -m pip install -r requirements.txt
```
=== ":fontawesome-brands-windows: Windows"
[type this into your terminal]
```
cd C:\Users\mroche\Plex-Meta-Manager
[type this into your terminal, changing `YOUR_USERNAME`` to your username]
cd C:\Users\YOUR_USERNAME\Plex-Meta-Manager
git checkout nightly
git pull
.\pmm-venv\Scripts\activate
python -m pip install -r requirements.txt
```
=== ":fontawesome-brands-docker: Docker"
[type this into your terminal]
docker pull meisnate12/plex-meta-manager:nightly
Then recreate your container via whatever means you used to create it [docker run, docker-compose, etc.], changing the image in the docker command or the `docker-compose.yml` to `meisnate12/plex-meta-manager:nightly`.
If you are using Docker on a NAS like Synology or UNRaid, they will provide some means of doing those two things.
??? question "How do I switch back to the master branch?"
=== ":fontawesome-brands-linux: Linux"
[type this into your terminal]
```
cd /Users/mroche/Plex-Meta-Manager
[type this into your terminal, changing `YOUR_USERNAME`` to your username]
cd /Users/YOUR_USERNAME/Plex-Meta-Manager
git checkout master
git pull
source pmm-venv/bin/activate
python -m pip install -r requirements.txt
```
=== ":fontawesome-brands-apple: macOS"
[type this into your terminal]
```
cd /Users/mroche/Plex-Meta-Manager
[type this into your terminal, changing `YOUR_USERNAME`` to your username]
cd /Users/YOUR_USERNAME/Plex-Meta-Manager
git checkout master
git pull
source pmm-venv/bin/activate
python -m pip install -r requirements.txt
```
=== ":fontawesome-brands-windows: Windows"
[type this into your terminal]
```
cd C:\Users\mroche\Plex-Meta-Manager
[type this into your terminal, changing `YOUR_USERNAME`` to your username]
cd C:\Users\YOUR_USERNAME\Plex-Meta-Manager
git checkout master
git pull
.\pmm-venv\Scripts\activate
python -m pip install -r requirements.txt
```
=== ":fontawesome-brands-docker: Docker"
[type this into your terminal]
docker pull meisnate12/plex-meta-manager:latest
Then recreate your container via whatever means you used to create it [docker run, docker-compose, etc.], changing the image in the docker command or the `docker-compose.yml` to `meisnate12/plex-meta-manager:latest`.
If you are using Docker on a NAS like Synology or UNRaid, they will provide some means of doing those two things.
#### Performance & Scheduling
??? question "Any tips on increasing PMM performance?"
Use PMM Caching where possible, this allows PMM to temporarily store commonly-used information so that it can be retreived more efficiently. There are [multipe things](https://metamanager.wiki/en/latest/search.html?q=cache&check_keywords=yes&area=default) that can be cached within PMM.
Use PMM Caching where possible, this allows PMM to temporarily store commonly-used information so that it can be retrieved more efficiently. There are [multipe things](https://metamanager.wiki/en/latest/search.html?q=cache&check_keywords=yes&area=default) that can be cached within PMM.
Run PMM after PLEX Scheduled Tasks, as Plex's API tends to be slower at responding whilst it is performing the tasks. By default, PMM runs at 5AM to avoid the 3-5am window that Plex suggests for Scheduled Tasks.