Rsync + SSH Docker image

Docker Hub | GitHub Container Registry | Quay.io

Supported tags and respective `Dockerfile` links

alpine3.16-r3, alpine3.16, alpine, latest

What is Rsync and SSH?

SSH (Secure Shell) is a cryptographic network protocol for operating network services securely over an unsecured network. The best known example application is for remote login to computer systems by users.

Rsync is a utility for efficiently transferring and synchronizing files across computer systems, by checking the timestamp and size of files. It is commonly found on Unix-like systems and functions as both a file synchronization and file transfer program. The rsync algorithm is a type of delta encoding, and is used for minimizing network usage. Zlib may be used for additional compression, and SSH or stunnel can be used for data security.

How to use this image

Just prepend rsync/ssh command with docker run instrumentisto/rsync-ssh:

docker run --rm -i instrumentisto/rsync-ssh rsync --help

Transferring data from volume to local folder:

docker run --rm -i -v <volume-name>:/volume -v $(pwd):/mnt instrumentisto/rsync-ssh \
    rsync -avz /volume/ /mnt/

Transferring file from remote host with rsync to local host without rsync:

docker run --rm -i -v <local-dest-path>:/mnt instrumentisto/rsync-ssh \
    rsync -avz <remote host>:<remote soruce path> /mnt/

Transferring file from remote host without rsync to local host with rsync:

rsync -avz --rsync-path="docker run --rm -i -v <remote-src-path>:/mnt instrumentisto/rsync-ssh rsync" \
    <remote host>:/mnt/ <local-dest-path>

Transfer file from remote host without rsync to local host without rsync:

docker run --rm -i -v <local-dest-path>:/mnt instrumentisto/rsync-ssh \
    rsync -avz --rsync-path="docker run --rm -i -v <remote-src-path>:/mnt instrumentisto/rsync-ssh rsync" \
        <remote-host>:/mnt/ /mnt/

License

Rsync is licensed under GNU GPL version 3 license.
OpenSSH Portable is licensed under BSD licence.

As with all Docker images, these likely also contain other software which may be under other licenses (such as Bash, etc from the base distribution, along with any direct or indirect dependencies of the primary software being contained).

As for any pre-built image usage, it is the image user's responsibility to ensure that any use of this image complies with any relevant licenses for all software contained within.

The sources for producing instrumentisto/rsync-ssh Docker images are licensed under Blue Oak Model License 1.0.0.

Issues

We can't notice comments in the DockerHub (or other container registries) so don't use them for reporting issue or asking question.

If you have any problems with or questions about this image, please contact us through a GitHub issue.