https://github.com/siegy22/synchronist

A mirroring/sync tool without having an active connection between sender and receiver
https://github.com/siegy22/synchronist

Last synced: about 5 hours ago
JSON representation

A mirroring/sync tool without having an active connection between sender and receiver

• Host: GitHub
• URL: https://github.com/siegy22/synchronist
• Owner: siegy22
• Created: 2022-12-03T16:12:46.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2024-09-18T01:01:16.000Z (16 days ago)
• Last Synced: 2024-09-18T04:52:48.970Z (15 days ago)
• Language: Ruby
• Size: 399 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 33
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
![Diagram](doc/logo.png)

[![Rails](https://github.com/siegy22/synchronist/actions/workflows/rails.yml/badge.svg)](https://github.com/siegy22/synchronist/actions/workflows/rails.yml)

Synchronist is mirroring/sync tool which allows to send increments without having an active connection between them.

## Installation

Right now the only way to easily install synchronist would be using [docker](https://www.docker.com/). You can howevery deploy it from source if you want to. However instructions for that are not covered here.

Before you start, make sure you have docker (or podman) set up with [docker-compose](https://docs.docker.com/compose/). See https://docs.docker.com/get-docker/

### Choose location

We'll use `/opt/synchronist` in this example:

```

$ mkdir /opt/synchronist

$ cd /opt/synchronist

```

### Install script

Run the install script (or download it, for inspection and run it manually):

```

$ sh -c "$(curl https://raw.githubusercontent.com/siegy22/synchronist/main/setup-deployment.sh)"

```

You'll need to specify the folders that should be exposed to synchronist, use comma-separated values to have multiple values.

### Further configuration

The installation script prepared a `docker-compose.yml` in the current working directory. With the values pre-filled.

If you want to change those at any point, feel free! The script is only here to have a quick start.

You also might wanna put this behind a reverse proxy to support https, I recommend using [jwilder/nginx-proxy](https://hub.docker.com/r/jwilder/nginx-proxy)

### Starting up!

```bash

$ systemctl start synchronist

# Or if you want to have it always running also after rebooting:

$ systemctl enable --now synchronist

```

### Acess the web interface

Visit your server name with your configured port in a web browser and configure the application!

## FAQ

### How?

- Using a so-called payload, the receiver generates the current state of the storage that it currently holds.

- The payload then needs to be sent to the sender (not covered by synchronist)

- The payload is parsed by the **sender** which will diff their current state with the payload

- The sender puts the increment into a configurable folder

- The increment then needs to be put into the receive folder on the receiver's end.

- The receiver will put all the received data into the storage folder.