unRAID additions

master
meisnate12 3 years ago
parent 327e16e62c
commit f989d0d3cd

@ -7,7 +7,8 @@ This wiki should tell you everything you need to know about the script to get it
## Getting Started ## Getting Started
* [Local Installation](https://github.com/meisnate12/Plex-Meta-Manager/wiki/Local-Installation) * [Local Installation](https://github.com/meisnate12/Plex-Meta-Manager/wiki/Local-Installation)
* [Docker Installation](https://github.com/meisnate12/Plex-Meta-Manager/wiki/Docker) * [Docker Installation](https://github.com/meisnate12/Plex-Meta-Manager/wiki/Docker-Installation)
* [unRAID Installation](https://github.com/meisnate12/Plex-Meta-Manager/wiki/unRAID-Installation)
* [Example Configuration File](https://github.com/meisnate12/Plex-Meta-Manager/blob/master/config/config.yml.template) * [Example Configuration File](https://github.com/meisnate12/Plex-Meta-Manager/blob/master/config/config.yml.template)
* [Example Metadata File](https://github.com/meisnate12/Plex-Meta-Manager/blob/master/config/Movies.yml.template) * [Example Metadata File](https://github.com/meisnate12/Plex-Meta-Manager/blob/master/config/Movies.yml.template)

@ -41,3 +41,7 @@ mal:
#### OAuth Flow using Docker #### OAuth Flow using Docker
To authenticate MyAnimeList the first time, you need run the container with the `-it` flags in order to walk through the OAuth flow mentioned above. Once you have the MyAnimeList authentication data saved into the YAML, you'll be able to run the container normally. To authenticate MyAnimeList the first time, you need run the container with the `-it` flags in order to walk through the OAuth flow mentioned above. Once you have the MyAnimeList authentication data saved into the YAML, you'll be able to run the container normally.
#### OAuth Flow using unRAID Docker
Directions on how to authenticate MyAnimeList on unRAID can be found on the [unRAID Installation](https://github.com/meisnate12/Plex-Meta-Manager/wiki/unRAID#advanced-installation-authenticating-trakt-or-myanimelist) page.

@ -34,4 +34,8 @@ trakt:
#### OAuth Flow using Docker #### OAuth Flow using Docker
To authenticate Trakt the first time, you need run the container with the `-it` flags in order to walk through the OAuth flow mentioned above. Once you have the Trakt authentication data saved into the YAML, you'll be able to run the container normally. To authenticate Trakt the first time, you need run the container with the `-it` flags in order to walk through the OAuth flow mentioned above. Once you have the Trakt authentication data saved into the YAML, you'll be able to run the container normally.
#### OAuth Flow using unRAID Docker
Directions on how to authenticate Trakt on unRAID can be found on the [unRAID Installation](https://github.com/meisnate12/Plex-Meta-Manager/wiki/unRAID#advanced-installation-authenticating-trakt-or-myanimelist) page.

@ -1,6 +1,7 @@
- [Home](Home) - [Home](Home)
- [Local Installation](Local-Installation) - [Local Installation](Local-Installation)
- [Docker Installation](Docker) - [Docker Installation](Docker-Installation)
- [unRAID Installation](unRAID-Installation)
- [Configuration File](Configuration-File) - [Configuration File](Configuration-File)
- [Libraries Attributes](Libraries-Attributes) - [Libraries Attributes](Libraries-Attributes)
- [Settings Attributes](Settings-Attributes) - [Settings Attributes](Settings-Attributes)

@ -1,5 +1,5 @@
Thankfully, getting Plex-Meta-Manager working on unRAID is a fairly simple task. unRAID works mostly with docker containers, so the pre-built container available on docker hub works perfectly with a little configuration. Thankfully, getting Plex Meta Manager working on unRAID is a fairly simple task. unRAID works mostly with docker containers, so the pre-built container available on docker hub works perfectly with a little configuration.
To install a container from docker hub, you will need community applications - a very popular plugin for unRAID servers. If you don't already have this installed, check here: https://forums.unraid.net/topic/38582-plug-in-community-applications/ To install a container from docker hub, you will need community applications - a very popular plugin for unRAID servers. If you don't already have this installed, you can install it [here](https://forums.unraid.net/topic/38582-plug-in-community-applications/)
## Basic Installation ## Basic Installation
@ -7,7 +7,7 @@ To install a container from docker hub, you will need community applications - a
2. Click the download icon on the `plex meta manager` container by `meisnate12`. 2. Click the download icon on the `plex meta manager` container by `meisnate12`.
3. Create your [Docker values](https://github.com/meisnate12/Plex-Meta-Manager-Wiki/blob/master/Docker.md) using `Add another Path, Port, Variable, Label or Device`. Example config: 3. Create your [Docker values](https://github.com/meisnate12/Plex-Meta-Manager/wiki/Docker-Installation) using `Add another Path, Port, Variable, Label or Device`. Example config:
| Config Type | Name | Key | Value | Container Path | Host Path | Access Mode | Description | | Config Type | Name | Key | Value | Container Path | Host Path | Access Mode | Description |
| :--- | :--- | :--- | :--- | :--- | :--- | :--- | :--- | | :--- | :--- | :--- | :--- | :--- | :--- | :--- | :--- |
@ -16,11 +16,11 @@ To install a container from docker hub, you will need community applications - a
| Variable | Screen Width | `width` | `100` | N/A | N/A | N/A | An integer between 90 and 300 | | Variable | Screen Width | `width` | `100` | N/A | N/A | N/A | An integer between 90 and 300 |
| Path | Config Storage Path | N/A | N/A | `/config` | `/mnt/user/appdata/plex-meta-manager` | Read/Write | Translation from docker container path to host path | | Path | Config Storage Path | N/A | N/A | `/config` | `/mnt/user/appdata/plex-meta-manager` | Read/Write | Translation from docker container path to host path |
* [Image](https://i.imgur.com/2y8RPTt.png) of the above values in the unRAID WebUI. * Full list of docker values can be found on the [Docker Installation](https://github.com/meisnate12/Plex-Meta-Manager/wiki/Docker) page
* All other settings can be left default in unRAID. * If you wish to enable one-time [Run](https://github.com/meisnate12/Plex-Meta-Manager/wiki/Docker-Installation), add `-r` to `Post Arguments` by enabling Advanced View in the top right of unRAID.
* Full list of docker values can be found here: https://github.com/meisnate12/Plex-Meta-Manager/wiki/Docker * The Image below shows the above values in the unRAID WebUI.
* If you wish to enable one-time [Run](https://github.com/meisnate12/Plex-Meta-Manager/wiki/Docker), add `-r` to `Post Arguments` by enabling Advanced View in the top right of unRAID. ![Image](https://i.imgur.com/2y8RPTt.png)
4. Hit `Apply`, and allow unRAID to download the docker container. 4. Hit `Apply`, and allow unRAID to download the docker container.
5. Navigate to the `Docker` tab in unRAID, and stop the `plex-meta-manager` container if it has auto-started. 5. Navigate to the `Docker` tab in unRAID, and stop the `plex-meta-manager` container if it has auto-started.
@ -29,13 +29,13 @@ To install a container from docker hub, you will need community applications - a
7. Once finished, run the container. Voila! Logs are located in `yourhostpath/logs`. 7. Once finished, run the container. Voila! Logs are located in `yourhostpath/logs`.
## Advanced Installation (Trakt, MAL, and other sources that require URL authentication) ## Advanced Installation (Authenticating Trakt or MyAnimeList)
Due to how unRAID handles docker containers, it can be a little confusing at first to enable Trakt, MyAnimeList, and other sources. At this time, these sources require you to follow through to a URL, and provide a code or link to Plex-Meta-Manager. unRAID doesn't have a built-in way to interact with the terminals of docker containers, so a workaround must be used: Due to how unRAID handles docker containers, it can be a little confusing at first to enable Trakt, MyAnimeList, and other sources. At this time, these sources require you to follow through to a URL, and provide a code or link to Plex Meta Manager. unRAID doesn't have a built-in way to interact with the terminals of docker containers, so a workaround must be used:
1. Stop the Plex-Meta-Manager docker container if it's currently running. 1. Stop the Plex Meta Manager docker container if it's currently running.
2. Follow the instructions for your respective source such as [Trakt](https://github.com/meisnate12/Plex-Meta-Manager/wiki/Trakt-Attributes), and add the relevant values to your `config.yml` 2. Follow the instructions for either [Trakt](https://github.com/meisnate12/Plex-Meta-Manager/wiki/Trakt-Attributes) or [MyAnimeList](https://github.com/meisnate12/Plex-Meta-Manager/wiki/Trakt-Attributes), and add the relevant values to your `config.yml`
3. Edit the `Time to Run` variable to reflect a time that is NOT the current time. We don't want the script to be running right now. Set `Run` to `false` if you've chosen to add that variable. Then, start the container. 3. Edit the `Time to Run` variable to reflect a time that is NOT the current time. We don't want the script to be running right now. Set `Run` to `false` if you've chosen to add that variable. Then, start the container.
Loading…
Cancel
Save