syncFolders is python script, based on rsync, which will synchronized a set of folder from/to a server.
- synchronize folders using rsync
- support different folder configuration
- send notifications of synced files thru Pushbullet or Telegram
- post-sync script execution, per file
- run on Synology NAS out-of-the-box (required modules included)
git clone https://github.com/gauth-fr/syncFolders.git
#optionnally, you can install the modules
cd syncFolders
pip install -r requirements.txtA sample config.yaml is provided
cp config.yaml.sample config.yamlYou can have as many folder configuration as needed. Each folder has its own configuration. Each folder is synchronized indepedently.
folders
- title: 'Sync test mary'
server:
ip: '1.2.3.4'
port: '22'
user: 'mary'
source: '/home/mary/test'
target: '/volume1/test'
target_is: 'local'
source_postcommand: null
target_postcommand: '/home/mary/post_process.sh FILE'
notify:
recipient:
- 'mary_telegram'
- 'bob_pushbullet'
title_prefix: 'Prefix message'
subtitle: 'single'
video: 'grouped'
other: null
delete: false| Parameter | Type/Value | Description |
|---|---|---|
| title | string | Title of this folder synchronization (mostly cosmetic in the logs) |
| server.ip | string | IP/Hostname of the server to synchronize to/from |
| server.port | string | SSH port of the server |
| server.user | string | User for SSH connection |
| source | string | source folder to synchronize |
| target | string | target folder to synchronize to |
| target_is | string | define if the target the local (machine where the script is started) or remote (the defined server) |
| source_postcommand | string | Command to execute on the source for each file |
| target_postcommand | string | Command to execute on the target for each file |
| delete | bool | unused for now |
| notify.recipient | array of string | list of recipient for notification. Each recipient should be defined in the notifications section of the config file |
| notify.title_prefix | string | Prefix string added to the notification title |
| subtitle (optional) | string or null | define is the subtitle notifications should be grouped (1 notification for all synced subtitles) or single (1 notification per synced subtitle) |
| video (optional) | string or null | define is the video notifications should be grouped (1 notification for all synced videos) or single (1 notification per synced video) |
| other (optional) | string or null | define is the other files (not subtitle or video) notifications should be grouped (1 notification for all files) or single (1 notification per synced file) |
Post-process commands are executed either or the source or the target, for each files.
You can use the following placeholders in your command, which will be replaced by the relevant value before execution:
FILE: Complete file pathBASEDIR: Where the file has been synchronized. Basically, it's thesourceortargetpath
As of today, only PushBullet and Telegram are supported for notification.
notifications:
video_extensions: ['.mp4','.avi','.mkv','.mov','.webm','.flv','.vob','.ogv','.qt','.asf','.wmv','.mpg','.m4v','.3gp','.3g2']
subtitle_extensions: ['.srt','.sub','.sbv']
other_extensions: []
recipients:
bob_pushbullet:
provider: 'pushbullet'
api_key: 'o.z0jsDS14bH35zIw1214io5MG42HMTbG'
mary_telegram:
provider: 'telegram'
recipient_id: '-123456788'
bot_id: '1234567890:CDG6QIDKAqKdpzu1qC2PDJpc0a3XE_PSODN'| Parameter | Type/Value | Description |
|---|---|---|
| notifications.video_extensions | array of string | list of file extensions considered as videos |
| notifications.subtitle_extensions | array of string | list of file extensions considered as subtitles |
| notifications.other_extensions | UNUSED | UNUSED - files that are not video or subtiles are considered as other files |
| notifications.recipient | dictionnary | this dictionnary contains the different recipient configuration |
| notifications.recipient.CONFIG_NAME | dictionnary | this CONFIG_NAME contains the recipient configuration. CONFIG_NAME name is the key that should be specified in folder.notify.recipient |
| Parameter | Type/Value | Description |
|---|---|---|
| CONFIG_NAME.provider | string=pushbullet | define this configation as a PushBullet configuration |
| CONFIG_NAME.api_key | string | recipient PushBullet API key |
To use telegram notification, you need to create a bot first, start a conversation with it or add it to a group and start it. You also need the user or group id where the bot will send messages.
| Parameter | Type/Value | Description |
|---|---|---|
| CONFIG_NAME.provider | string=telegram | define this configation as a PushBullet configuration |
| CONFIG_NAME.recipient_id | string | Telegram recipient id (group or user) |
| CONFIG_NAME.bot_id | string | Telegram bot id (group or user) |
- from Telegram, contact @botfather, start a conversation and click on start
- type
/newbotand answer the questions - Note the provided access token. You will need to use it as the
bot_id
- from Telegram, contact @myidbot, start a conversation and click on start
- type
/getid - Note the id. You will need to use it as the
recipient_id
- From Telegram, create a group
- Add the bot to the group
- Get the group id
- Add @myidbot to the group
- type
/getgroupid - note the group id, which should be a negative number. You will need to use it as the
recipient_id
- try to send a message with curl!
curl -X POST -H 'Content-Type: application/json' -d '{"chat_id": "RECIPIENT_ID","text": "This is a test from curl", "disable_notification": true}' https://api.telegram.org/botBOT_ID/sendMessageI made this script to run on my Synology NAS, where python 2.7.12 is installed, but not pip.
So at least, it's running out-of the box.
You can still remove the modules folder and install the modules using pip install -r requirements.txt