Skip to content
This repository was archived by the owner on Mar 22, 2024. It is now read-only.

Commit 67ce67c

Browse files
committed
[UPDATE] Renamer to 6.3.2 with dependency's
1 parent cf4d8e4 commit 67ce67c

File tree

10 files changed

+656
-224
lines changed

10 files changed

+656
-224
lines changed

README.md

Lines changed: 48 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
1-
<div align="center">
1+
<div style="text-align:center">
22

33
# SyncPosterProcess
44

5-
This is a simple script that is meant to used with the provided Dockerfile or the docker container on the [Docker Hub](https://hub.docker.com/r/mrzablah/spp) or [GHCR](https://github.com/MrZablah/SyncPosterProcess/pkgs/container/spp).
5+
This is a simple script
6+
meant to be used with the provided Dockerfile or the docker container on the [Docker Hub](https://hub.docker.com/r/mrzablah/spp) or [GHCR](https://github.com/MrZablah/SyncPosterProcess/pkgs/container/spp).
67

78
</div>
89

@@ -27,18 +28,18 @@ This is an all-in-one solution for the following scripts:
2728
- [Stupifier Script provided in Discord](https://discord.com/channels/492590071455940612/1124032073557086258/1126226814629576858)
2829
This is script will sync a directory with a Google Drive folder.
2930
- [Drazzilb08 User Scripts](https://github.com/Drazzilb08/userScripts)
30-
This script will fix naming of the images base on the naming you have on arr apps.
31+
This script will fix naming of the image based on the naming you have on arr apps.
3132
- [MM2k-BORDER-REPLACER](https://github.com/listentofaze/mm2k-border-replacer/tree/main)
32-
This script will replace or removed the borders of the images.
33+
This script will replace or remove the borders of the images.
3334

3435
# How to use it?
3536

36-
The recommend use of the script is to use the docker container provided in the
37+
The recommended use of the script is to use the docker container provided in the
3738
[Docker Hub](https://hub.docker.com/r/mrzablah/spp) or [GHCR](https://github.com/MrZablah/SyncPosterProcess/pkgs/container/spp)
38-
and configure it as explain below, but you can also use the script directly.
39+
and configure it as explained below, but you can also use the script directly.
3940

4041
# Docker
41-
They are several ways to run the docker container, but the recommend way is to use the following command:
42+
There are several ways to run the docker container, but the recommended way is to use the following command:
4243
```bash
4344
docker run -d \
4445
--name spp \
@@ -50,7 +51,7 @@ docker run -d \
5051
-e UMASK=000 \
5152
mrzablah/spp:latest
5253
```
53-
Keep in mind that you need to change the TZ variable to your timezone so you can se the schedule correctly,
54+
Keep in mind that you need to change the TZ variable to your timezone, so you can se the schedule correctly,
5455
and the volumes to the path you want to use.
5556

5657
## Parameters
@@ -73,7 +74,7 @@ The first part to change is the global section:
7374
```yaml
7475
global:
7576
run_now: true # If true it will run the script immediately, if false it will wait until the schedule_hour
76-
schedule_hour: 4 # This is the hour of the day you want the script to run, it's based on a 24 hour clock and defaults to 4am
77+
schedule_hour: 4 # This is the hour of the day you want the script to run, it's based on a 24-hour clock and defaults to 4am
7778
log_level: info # log_level can be: debug, info, warning, error, critical
7879
radarr:
7980
# name is the name of the radarr instance, this is used to reference the instance in other scripts
@@ -99,36 +100,53 @@ global:
99100
plex:
100101
# name is the name of the plex instance, this is used to reference the instance in other scripts
101102
- name: plex
102-
# api is the token key for the plex instance, if you don't know your token please see https://support.plex.tv/articles/204059436-finding-an-authentication-token-x-plex-token/
103+
# api is the token key for the plex instance, if you don't know your token, please see https://support.plex.tv/articles/204059436-finding-an-authentication-token-x-plex-token/
103104
api: abcdefghijlmnop
104105
# url is the url for the plex instance
105106
url: http://localhost:32400
106107
```
107108
109+
## Discord and Notifiarr
110+
This is the section for discord and notifiarr. If you don't use any of them, you can leave this blank.
111+
```yaml
112+
discord:
113+
# This is the webhook for Notifiarr. if you don't use Notifiarr, you can leave this blank
114+
notifiarr_webhook:
115+
# These are the webhooks for the discord scripts. if you don't use discord, you can leave these blanks
116+
renamer:
117+
# This is the discord webhook for this script
118+
discord_webhook:
119+
# This is the channel id for the discord script. Channel id is only needed if using Notifiarr
120+
channel_id:
121+
unmatched-assets:
122+
discord_webhook:
123+
channel_id:
124+
```
125+
108126
## Sync Google Drive
109-
There are sections for each of script,
127+
There are sections for each of scripts,
110128
you can enable or disable any of the script with the `run` variable.
111129

112-
1. Get rclone client ID and Secret following these [instructions](https://rclone.org/drive/#making-your-own-client-id)
130+
1. Get RClone client ID and Secret following these [instructions](https://rclone.org/drive/#making-your-own-client-id)
113131
2. Then get a token following these [instructions](https://rclone.org/remote_setup/)
114132

115-
> Alternative use Google Cloud Service Account instead of token:
116-
- Creating and using this option will make it, so you don't need to create the token manually but I will still strongly
133+
> Alternatively, use Google Cloud Service Account instead of token:
134+
- Creating and using this option will make it, so you don't need to create the token manually, but I will still strongly
117135
recommend to still add the Client ID and Client Secret and just change the token to SA, otherwise you might reach some limits.
118136

119137
> Instructions for creating a Google Cloud Service Account
120138
1. To create a service account and obtain its credentials, go to the [Google Developer Console](https://console.developers.google.com/).
121-
2. You must have a project - create one if you don't.
122-
3. Then go to "IAM & admin" -> "Service Accounts".
139+
2. You must have a projectcreate one if you don't.
140+
3. Then go to "IAM & admin" -> "Service Accounts."
123141
4. Use the "Create Service Account" button. Fill in "Service account name" and "Service account ID" with something that identifies your client.
124-
5. Select "Create And Continue". Step 2 and 3 are optional.
125-
6. Once created you will need to go to the Actions of the SA -> Manage Keys and create a JSON key and saved it as a file.
142+
5. Select "Create And Continue." Step 2 and 3 are optional.
143+
6. Once created, you will need to go to the Actions of the SA -> Manage Keys and create a JSON key and save it as a file.
126144
7. These credentials are what rclone will use for authentication. If you ever need to remove access, press the "Delete service account key" button.
127145

128-
> As a fallback you can use sync_location and gdrive_id, but this is deprecated and will be removed in the future.
146+
> As a fallback, you can use sync_location and gdrive_id, but this is deprecated and will be removed in the future.
129147
```yaml
130148
sync_gdrive:
131-
run: true # If false it will skip this step
149+
run: true # If false, it will skip this step
132150
client_id: asdasds.apps.googleusercontent.com # Client ID for rclone usually ends with .apps.googleusercontent.com
133151
client_secret: GOCSPX-asda123 # Client Secret for rclone, usually starts with GOCSPX-
134152
token: # The token for rclone, this is the output of rclone config dump that needs to run manually
@@ -147,7 +165,7 @@ sync_gdrive:
147165
renamer:
148166
run: true # If false, it will skip this step
149167
# Options are 'true' or 'false'
150-
dry_run: true # dry_run can be true or false, if true it will not actually rename anything
168+
dry_run: true # dry_run can be true or false, if true, it will not rename anything
151169
asset_folders: false
152170
# Options are 'copy' or 'move'
153171
action_type: copy
@@ -169,15 +187,15 @@ renamer:
169187
# Where your posters are going to go. In my usecase I use Plex-Meta-Manager. This is the /config/assets dir for PMM for me.
170188
destination_dir: /path/to/poster/destination
171189
# The thresholds are used to consider what is a "Match"
172-
# As with any automation there is never a 100% guarantee of accuracy.
173-
# There will be times the script will mess up.
174-
# If however you see it messing up more often on things you can restrict the threshold.
190+
# As with any automation, there is never a 100% guarantee of accuracy.
191+
# There will be timed the script will mess up.
192+
# If, however, you see it messing up more often on things, you can restrict the threshold.
175193
# 0 = Anything goes, 100 = Must be exact match
176194
# The default numbers here are based upon what I've seen to be the most effective, I've had one-offs where I had to manually fix things.
177195
collection_threshold: 99
178196
# Decide which radarr instance you will be using for renamer, this is useful if you have,
179197
# for example, A Sonarr/Sonarr-Anime and/or Radarr/Radarr-Anime
180-
# If you however duplicate entries between a Radarr/Radarr4K for example.
198+
# If you however duplicate entries between a Radarr/Radarr4K, for example.
181199
# This won't help and will only double the work for the script for no gain.
182200
radarr:
183201
- name: radarr_1
@@ -189,13 +207,13 @@ renamer:
189207
## Border Replacer
190208
```yaml
191209
fix_border:
192-
run: true # If false it will skip this step
210+
run: true # If false, it will skip this step
193211
input_folder: /data/input # Where your posters are going to be coming from
194212
output_folder: /data/fix_posters # Where your posters are going to go
195-
border_color: none # This will remove the border of the image, but you can also add a color to change th border to any hex color, Ej: '#000000'
196-
overwrite_existing: true # If true it will overwrite the existing poster, if false it will skip the poster
197-
resize: false # If true it will resize the poster to 1000x1500, this requires border_color to be set to a 'none'
198-
bottom_only: false # If true it will only keep the bottom border, this requires border_color to be set to a color Ej: '#000000'
213+
border_color: none # This will remove the border of the image, but you can also add a color to change the border to any hex color, Ej: '#000000'
214+
overwrite_existing: true # If true, it will overwrite the existing poster, if false it will skip the poster
215+
resize: false # If true, it will resize the poster to 1000x1500; this requires border_color to be set to a 'none'
216+
bottom_only: false # If true, it will only keep the bottom border; this requires border_color to be set to a color Ej: '#000000'
199217
```
200218

201219

config.sample.yml

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,19 @@ global:
3737
# url is the url for the plex instance
3838
url: http://localhost:32400
3939

40+
discord:
41+
# This is the webhook for Notifiarr, if you don't use Notifiarr you can leave this blank
42+
notifiarr_webhook:
43+
# These are the webhooks for the discord scripts, if you don't use discord you can leave these blank
44+
renamer:
45+
# This is the discord webhook for this script
46+
discord_webhook:
47+
# This is the channel id for the discord script. Channel id is only needed if using Notifiarr
48+
channel_id:
49+
unmatched-assets:
50+
discord_webhook:
51+
channel_id:
52+
4053
# THIS SCRIPT SYNCS GDRIVE TO A LOCAL FOLDER. ANYTHING UNIQUE IN THE FOLDER WILL BE DELETED.
4154
# -> You can use client_id, client_secret, and token to authenticate, or you can use gdrive_sa_location to use a service account.
4255
# DRAZZILB GDRIVE ID: 1VeeQ_frBFpp6AZLimaJSSr0Qsrl6Tb7z
@@ -142,7 +155,8 @@ unmatched_assets:
142155
- "The Batman Universe"
143156
- "Collectionless"
144157
- "DC Extended Universe"
145-
assets_path: /path/to/poster-assets/
158+
assets_paths:
159+
- /path/to/poster-assets/
146160
media_paths:
147161
- /path/to/media/folders/movies
148162
- /path/to/media/folders/tv-shows

0 commit comments

Comments
 (0)