This project is comprised of a shell script that stops any active PLEX streams, shutdown PLEX, makes a .tar backup file, and restarts PLEX
Explore the docs »
Report Bug
·
Request Feature
Table of Contents
The script is written around the Synology NAS DSM operating system Native installation of PLEX or a DOCKER installation on PLEX
- This script can be run through Synology Task Scheduler.
- Create the following directories on the NAS
1. /volume1/[shared_foler_name]/logging
2. /volume1/[shared_foler_name]/logging/notifications
Ensure [shared_foler_name] is properly set a folder of your choice
- Place the
plex_backup.shfile in the/loggingdirectory
- Open the
plex_backup.shfile in a text editor. - the script contains the following configuration variables
#plex variables
plex_backup_dir="/volume1/Server2/Backups/Plex"
PMS_IP='192.168.1.200'
plex_installed_volume="volume1"
log_file_location="/volume1/[shared_foler_name]/logging/notifications/plex_backup.txt"
lock_file_location="/volume1/[shared_foler_name]/logging/notifications/plex_backup.lock"
installation_type=0 #0 for native plex app, 1 for DOCKER
#if using docker edit these parameters, otherwise they can be ignored.
docker_container_name="plex" #edit to match the name of your PLEX docker container
plex_library_directory_location="/$plex_installed_volume/Plex"
folder_name_to_backup="AppData"
plex_Preferences_loction="PlexMediaServer/AppData/Plex Media Server/Preferences.xml"
plex_backup_dir is where the .tar backup file will be stored
PMS_IP mujst be the IP address used to access PLEX so the script can terminate any active streams
plex_installed_volume which volume on the Synology NAS is the PLEX data directory located
log_file_location where the log file of the backup process will be saved. Ensure [shared_foler_name] is properly set a folder of your choice
lock_file_location where a lock file will be saved while the script is running. Ensure [shared_foler_name] is properly set a folder of your choice. this prevents more than once instance of this script from running at once
installation_type indicates if this is a PLEX installation using the native plex installer and package manager or if using docker.
docker_container_name if using docker, what is the name of the PLEX container within docker
plex_library_directory_location if using docker, where is the PLEX data folder located?
folder_name_to_backup what folder within the PLEX data structure to backup
plex_Preferences_loction where is the PLEX preference file? this is needed to terminate any active streams
- Control Panel -> Task Scheduler
- Click
Create -> Scheduled Task -> User-defined script - Under "General Settings" name the script "PLEX Auto-backup" and choose the "root" user and ensure the task is enabled
- Click the "Schedule" tab at the top of the window. in this example we will set it to run monthly and will run at 11:00 PM
- Select "Run on the following date" and choose the day of the current or next month you wish for the script to run. also ensure "Repeat Monthly" is selected
- Under Time, set "First run time" to "23" and "00"
- under "Frequency" select "every day"
- under last run time select "23:00"
- go to the "Task Settings" tab
- Ensure "Send run details by email" is checked and enter the email address to send the logs to.
- Under "Run command" enter
bash /volume1/[shared_foler_name]/logging/plex_backup.shNOTE: ensure the/volume1/[shared_foler_name]/logging/is where the script is located - click "ok" in the bottom right
- IF desired, find the newly created task in your list, right click and select "run". when a confirmation window pops up, choose "yes". The script will run. WARNING this will shutdown any active streams and turn off PLEX while the backup process is happening.
This is free to use code, use as you wish
Your Name - Brian Wallace - [email protected]
Project Link: [https://github.com/wallacebrf/plex_backup)