Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mefellows/mirror
A small, machine-independent utility to synchronise folders across machines and file-systems
https://github.com/mefellows/mirror
Last synced: 5 days ago
JSON representation
A small, machine-independent utility to synchronise folders across machines and file-systems
- Host: GitHub
- URL: https://github.com/mefellows/mirror
- Owner: mefellows
- License: mit
- Created: 2015-02-14T12:25:28.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2016-03-20T13:18:03.000Z (almost 9 years ago)
- Last Synced: 2024-10-30T02:28:05.266Z (about 2 months ago)
- Language: Go
- Size: 99.6 KB
- Stars: 4
- Watchers: 2
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Mirror
A small, machine-independent utility to synchronise folders across machines and file-systems.
It is similar to rsync, but is bi-directional and can transfer between varying file system types (e.g. S3) and operating systems.
[](https://travis-ci.org/mefellows/mirror)
[](https://coveralls.io/r/mefellows/mirror?branch=master)
[](https://godoc.org/github.com/mefellows/mirror)
## Getting Mirror
Mirror is go gettable with `go get github.com/mefellows/mirror`. You can also download the [binary releases](https://github.com/mefellows/mirror/releases).
## Status
Beta: features are working as expected, but it's fairly rough around the edges. In use in non-mission critical systems.
## Features
* Sync a local source directory with a remote file-system-like structure, including S3 - can sync in either direction, initiated from either side.
* Watch a directory and _continuously_ synchronise changes to a another file system (local, remote or S3)
### Remote FS sync (ala rsync):
On remote server, start the mirror daemon. By default, it will listen on port 8123:
```
mirror daemon --insecure
```
On the client, specify the hostname of the remote server:
```
mirror sync --src /tmp/foo --dest mirror://mydomain.com/tmp/bar
```
#### Watch for changes:
Simply add the `--watch` flag, and mirror will watch for changes, and continuously synchronise them to the target:
```
mirror sync --src /tmp/foo --dest mirror://mydomain.com/tmp/bar --watch
```
#### Exclude files
The `--exclude` flag accepts a POSIX regular expression that can be used to filter files to be synced:
```
mirror sync --src /tmp/foo --dest /tmp/bar --exclude ".git" --exclude "^ignore" --exclude "tmp$"
```
The `--exclude` flag may be specified multiple times.
### Remote FS sync with SSL enabled
The use of SSL is recommended when transferring files between remote file systems, let's
see how we go about this with mirror.
To begin with, setup the PKI for the host with `mirror pki --caHost mydomain.com`, being careful to replace `mydomain.com` with your own domain/hostname.
You may now start the daemon with `mirror daemon`.
This will create a Certificate Authority (CA) in `~/.mirror.d/ca/`,
and client certificates in `~/.mirror.d/certs`. We will need
this to communicate securely across the network, let's extract them:
```
mirror pki --outputCA > ca.crt
mirror pki --outputClientCert > client.crt
mirror pki --outputClientKey > client.pem
```
Download these files to your local system. From the client, we import them back in:
```
mirror pki --importCA ca.crt
mirror pki --importClientCert client.crt --importClientKey client.pem
```
We can now communicate securely with the remote host over a trusted connection:
```
bin/mirror sync --src /tmp/dat1 --dest mirror://myserver/var/backups/dat1
```
### Sync/Copy To/From S3
Ensure your AWS Credentials are loaded in the [appropriate](http://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-started.html) environment variables or files:
```
bin/mirror sync --src /tmp/dat1 --dest s3://mybucket.s3.amazonaws.com/dat2
```