# Rsync Server

Rsync Server is a self-hosted backup app. A lightweight, Alpine-based rsync server for synchronising and backing up files over SSH, suitable for scheduled transfers between an Unraid host and remote machines. It is open source and self-hosted, installable on Docker Hub and Unraid.

Canonical page: https://ourlocalhost.com/app/564/rsync-server

## Description

A lightweight, Alpine-based rsync server for synchronising and backing up files over SSH, suitable for scheduled transfers between an Unraid host and remote machines.

## Platform availability

Available on 1 of 9 platforms: Unraid.

## Health score

51/100 (Fair), based on 3 of 4 factors.
- Maintained: 70 (last commit 50 days ago)
- Popular: 34 (50 GitHub stars)
- Easy to install: 35 (1 install platform, install notes, Docker image)

## Links

- Docker Hub: https://hub.docker.com/r/instrumentisto/rsync-ssh
- Unraid: https://ca.unraid.net/apps/rsync-server-1jido6e18ctimy?q=rsync-server

## Common questions

### How do I allow a client to connect to the rsync server?

Add the client's public SSH key to the SSH_AUTH_KEY_1 environment variable when starting the server. Additional client keys can be added with SSH_AUTH_KEY_n variables.

### Which port should the Docker server expose for SSH-based rsync?

The documented Docker example maps host port 2222 to container port 22. The client rsync command then uses ssh -p 2222.

### Do I need to persist SSH keys when recreating the containers?

Yes, persist the client key directory /root/.ssh and the server host key directory /ssh_host_keys in Docker volumes. The keys are created on first start and reused on later starts.

### What volume do I mount for the rsync data?

Mount the data directory to /data in the container. The examples use server_vol_to_sync for the server and client_vol_to_sync for the client.

### Can I run the rsync transfer automatically?

Set CRON_TASK_1 or CRON_TASK_2 on the client container to a cron command. The example runs an rsync command over SSH at a scheduled time.

---
Source: Our Local Host (https://ourlocalhost.com/app/564/rsync-server), the self-hosted and open-source app directory.