README

A HTTP based file synchronization library that uses public key authentication.

This library can be used to install or update applications from private sources, sync data files or for any other reason that you can think of where you might want rsync functionality but to be able to control it using PHP easily.

Setup

Create the script on the remote server e.g. sync.php on the server, that Client will communicate with.

use FileSync\Server;
$server = new Server(__DIR__ . '/storage/keys');
$server->dispatch('/server/data');

Call the Client dispatch method from a script or your application

use FileSync\Client;
$client = new Client(__DIR__ . '/storage/keys');
$client->dispatch('https://localhost:8000/sync.php','demo@example.com','/var/www/app.example.com/public_html');

Generating Key Pairs

FileSync looks for keys using the extension based upon type of key that it needs e.g. .privateKey and .publicKey.

You need to generate a private key and save this on the client machine, save the public key on the server in the keychain folder when you are creating instances.

PHP

FileSync uses the jamielsharief/encryption library for encryption and decryption.

To generate a key pair

use Encryption\Keypair;
$keyPair = KeyPair::generate();
echo $keyPair->privateKey();
echo $keyPair->publicKey();

To generate a private key only

use Encryption\PrivateKey;
$privateKey = PrivateKey::generate();

To work with private or public keys

$publicKey = PublicKey::load($pathToKey);
$privateKey = PrivateKey::load($pathToKey);

See jamielsharief/encryption for more information.

Command Line

To generate a private key and save this to a file

$ openssl genpkey -algorithm RSA -pkeyopt rsa_keygen_bits:2048 -out demo@example.com.privateKey

To generate a public key from the private key

$ openssl rsa -in demo@example.com.privateKey -pubout > demo@example.com.publicKey

Ignoring Files

You should NEVER sync a folder that contains private data with other people.

To ignore files on either the client or server just create a .syncignore file.

Here is an example show how to exclude single files, files with an extension or complete folders

version.txt
config/details.conf
*.json
vendor/

Demo

To load the demo, first start the built in PHP web server

$ php -S localhost:8000

Then run the following command, this will create a folder called dest and sync the files from src.

$ php demo.php

jamielsharief / file-sync

Maintainers

Details