pli_rsync

README 日本語版

Overview

• Create a command using rsync to transfer backup files located in the /plinode_backups/ directory of Plugin nodes from a VPS to a local machine.

• Create a command using rsync to transfer backup files from a local machine to the /plinode_backups/ directory of Plugin nodes simultaneously.

• Please check if /plinode_backups/ is available on the Plugin nodes before proceeding. If /plinode_backups/ is not available, the command will not be executed.

• Compatible with various encryption types. The following is a list of SSH key types that may be detected by the script:

  • ssh-dss
  • ssh-rsa
  • ecdsa-sha2-nistp
  • ssh-ed25519
  • rsa-sha2-256
  • ssh-x25519
  • ssh-x448

  Therefore, this script detects the key types of DSA, RSA, ECDSA, Ed25519, RSA-PSS, x25519, and x448.

• Corresponds to both Japanese and English

  • Created translations.csv to correspond to Japanese and English
  • If necessary, I can also correspond to other languages, so please let me know.

Features

1. Reads English and Japanese messages from a CSV file and displays them depending on the selected language.
2. Create a command to transfer the /plinode_backups/ directory of Plugin nodes to the local machine.
3. At the same time, create a command to transfer backup files from the local machine to the /plinode_backups/ directory of Plugin nodes.
4. rsync also supports ssh-key.

About rsync

rsync is a file synchronization tool that is mainly used to synchronize files/directories in different locations. rsync can synchronize files between a local machine and a remote machine, and transfer files over the network.

The main feature of rsync is that it can transfer only the modified parts. That is, by calculating the differences between the source and destination files and transferring only the parts with differences, it operates very efficiently when transferring large amounts of data.

In addition, rsync has other advantages such as:

Ability to resume transfers from where they left off if interrupted Faster transfer of multiple files than scp in some cases Display of progress during transfers, making it easier to monitor transfer status The plugin node probably has rsync installed, which can be checked with rsync --version. If it is not installed, please run the following command to install it.

sudo apt install rsync

Git Clone the repository

Clone the repository, enter the pli_rsync directory, and change the permissions of pli_rsync.sh before running it.

git clone https://github.com/11ppm/pli_rsync
cd pli_rsync
chmod +x pli_rsync.sh

Executing the script

./pli_rsync.sh

Select English or Japanese, and enter your password when prompted.

"IP Address:123.456.789.10" is an example.

Select a language 言語を選択してください :

1. English
2. 日本語

Enter the number 数字を入力してください : 1

[sudo] password for Doraemon: 

                                       Your Plugin Node                                          
-----------------------------------------------------------------------------------------------------
IP Address           : 123.456.789.10
User                 : Doraemon
Backup Directory     : /plinode_backups/
Local Directory      : ~/Documents/plugin_node/CT-TEST_123.456.789.10/plinode_backups/
SSH Port             : 22
SSH key type         : rsa
-----------------------------------------------------------------------------------------------------


                             Plugin Node    =====>>    Local Machine                             
-----------------------------------------------------------------------------------------------------

mkdir -p ~/Documents/plugin_node/CT-TEST_123.456.789.10/plinode_backups/ && rsync -avz --progress -e 'ssh -i ~/.ssh/id_rsa -p 22' Doraemon@123.456.789.10:/plinode_backups/ ~/Documents/plugin_node/CT-TEST_123.456.789.10/plinode_backups/

-----------------------------------------------------------------------------------------------------
To download backup file from the Plugin Node.run the following command in your local machine's terminal



                             Plugin Node    <<=====    Local Machine                             
-----------------------------------------------------------------------------------------------------

rsync -avz --progress -e 'ssh -i ~/.ssh/id_rsa -p 22' ~/Documents/plugin_node/CT-TEST_123.456.789.10/plinode_backups/ Doraemon@123.456.789.10:/plinode_backups/

-----------------------------------------------------------------------------------------------------
To upload backup files from your local machine to the Plugin Node.run the following command in your terminal on the local machine.
Note: Replace ~/.ssh/id_rsa with the appropriate path and filename of your private key.

Local Machine (for Linux/Mac/WSL2)

Open the terminal and paste and execute the script.

Note:

• Please check if /plinode_backups/ is available on the Plugin nodes before proceeding. If /plinode_backups/ is not available, the command will not be executed.

• Tested on Linux (Ubuntu), Mac, and WSL2 (Windows Subsystem for Linux 2), Windows 10 and 11 (with Cygwin).

• If you are using Windows, it is recommended to install and run Ubuntu on WSL2, which is easy to set up. However, it is also possible to use Cygwin. In that case, please refer to the link below.

  Setting up Cygwin to use rsync on Windows

Author

• @11ppm