You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Mar 22, 2024. It is now read-only.
Copy file name to clipboardExpand all lines: README.md
+48-30Lines changed: 48 additions & 30 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,8 +1,9 @@
1
-
<divalign="center">
1
+
<divstyle="text-align:center">
2
2
3
3
# SyncPosterProcess
4
4
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).
6
7
7
8
</div>
8
9
@@ -27,18 +28,18 @@ This is an all-in-one solution for the following scripts:
27
28
-[Stupifier Script provided in Discord](https://discord.com/channels/492590071455940612/1124032073557086258/1126226814629576858)
28
29
This is script will sync a directory with a Google Drive folder.
29
30
-[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.
This script will replace or removed the borders of the images.
33
+
This script will replace or remove the borders of the images.
33
34
34
35
# How to use it?
35
36
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
37
38
[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.
39
40
40
41
# 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:
42
43
```bash
43
44
docker run -d \
44
45
--name spp \
@@ -50,7 +51,7 @@ docker run -d \
50
51
-e UMASK=000 \
51
52
mrzablah/spp:latest
52
53
```
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,
54
55
and the volumes to the path you want to use.
55
56
56
57
## Parameters
@@ -73,7 +74,7 @@ The first part to change is the global section:
73
74
```yaml
74
75
global:
75
76
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 24hour 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
77
78
log_level: info # log_level can be: debug, info, warning, error, critical
78
79
radarr:
79
80
# name is the name of the radarr instance, this is used to reference the instance in other scripts
@@ -99,36 +100,53 @@ global:
99
100
plex:
100
101
# name is the name of the plex instance, this is used to reference the instance in other scripts
101
102
- 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/
103
104
api: abcdefghijlmnop
104
105
# url is the url for the plex instance
105
106
url: http://localhost:32400
106
107
```
107
108
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
+
108
126
## Sync Google Drive
109
-
There are sections for each of script,
127
+
There are sections for each of scripts,
110
128
you can enable or disable any of the script with the `run` variable.
111
129
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)
113
131
2. Then get a token following these [instructions](https://rclone.org/remote_setup/)
114
132
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
117
135
recommend to still add the Client ID and Client Secret and just change the token to SA, otherwise you might reach some limits.
118
136
119
137
> Instructions for creating a Google Cloud Service Account
120
138
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 project—create one if you don't.
140
+
3. Then go to "IAM & admin" -> "Service Accounts."
123
141
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.
126
144
7. These credentials are what rclone will use for authentication. If you ever need to remove access, press the "Delete service account key" button.
127
145
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.
129
147
```yaml
130
148
sync_gdrive:
131
-
run: true # If false it will skip this step
149
+
run: true # If false, it will skip this step
132
150
client_id: asdasds.apps.googleusercontent.com # Client ID for rclone usually ends with .apps.googleusercontent.com
133
151
client_secret: GOCSPX-asda123 # Client Secret for rclone, usually starts with GOCSPX-
134
152
token: # The token for rclone, this is the output of rclone config dump that needs to run manually
@@ -147,7 +165,7 @@ sync_gdrive:
147
165
renamer:
148
166
run: true # If false, it will skip this step
149
167
# 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
151
169
asset_folders: false
152
170
# Options are 'copy' or 'move'
153
171
action_type: copy
@@ -169,15 +187,15 @@ renamer:
169
187
# 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.
170
188
destination_dir: /path/to/poster/destination
171
189
# 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.
175
193
# 0 = Anything goes, 100 = Must be exact match
176
194
# 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.
177
195
collection_threshold: 99
178
196
# Decide which radarr instance you will be using for renamer, this is useful if you have,
179
197
# 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.
181
199
# This won't help and will only double the work for the script for no gain.
182
200
radarr:
183
201
- name: radarr_1
@@ -189,13 +207,13 @@ renamer:
189
207
## Border Replacer
190
208
```yaml
191
209
fix_border:
192
-
run: true # If false it will skip this step
210
+
run: true # If false, it will skip this step
193
211
input_folder: /data/input # Where your posters are going to be coming from
194
212
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'
0 commit comments