Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jamielsharief/file-sync
A HTTP based file synchronization library that uses public key authentication.
https://github.com/jamielsharief/file-sync
file http public-key-authentication sync
Last synced: 3 days ago
JSON representation
A HTTP based file synchronization library that uses public key authentication.
- Host: GitHub
- URL: https://github.com/jamielsharief/file-sync
- Owner: jamielsharief
- License: mit
- Created: 2020-11-09T19:45:40.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2020-11-22T09:18:52.000Z (about 4 years ago)
- Last Synced: 2024-04-18T08:45:16.210Z (8 months ago)
- Topics: file, http, public-key-authentication, sync
- Language: PHP
- Homepage:
- Size: 75.2 KB
- Stars: 1
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# File Sync (beta)
[](https://travis-ci.com/jamielsharief/file-sync)
[](https://coveralls.io/github/jamielsharief/file-sync?branch=main)
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.
```php
use FileSync\Server;
$server = new Server(__DIR__ . '/storage/keys');
$server->dispatch('/server/data');
```
Call the `Client` `dispatch` method from a script or your application
```php
use FileSync\Client;
$client = new Client(__DIR__ . '/storage/keys');
$client->dispatch('https://localhost:8000/sync.php','[email protected]','/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](https://github.com/jamielsharief/encryption) library for encryption and decryption.
To generate a key pair
```php
use Encryption\Keypair;
$keyPair = KeyPair::generate();
echo $keyPair->privateKey();
echo $keyPair->publicKey();
```
To generate a private key only
```php
use Encryption\PrivateKey;
$privateKey = PrivateKey::generate();
```
To work with private or public keys
```php
$publicKey = PublicKey::load($pathToKey);
$privateKey = PrivateKey::load($pathToKey);
```
See [jamielsharief/encryption](https://github.com/jamielsharief/encryption) for more information.
### Command Line
To generate a `private` key and save this to a file
```bash
$ openssl genpkey -algorithm RSA -pkeyopt rsa_keygen_bits:2048 -out [email protected]
```
To generate a `public` key from the `private` key
```bash
$ openssl rsa -in [email protected] -pubout > [email protected]
```
## 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
```bash
version.txt
config/details.conf
*.json
vendor/
```
## Demo
To load the demo, first start the built in PHP web server
```bash
$ php -S localhost:8000
```
Then run the following command, this will create a folder called `dest` and sync the files from `src`.
```bash
$ php demo.php
```