Skip to content

z-stream v1.3.1

Choose a tag to compare

@github-actions github-actions released this 08 Jul 02:40

z-stream v1.3.1

Encrypted TCP stream transport for ZFS replication and folder sync.
Replaces netcat in ZFS send/receive pipelines.
New in v1.3.0: tunnel-listen/tunnel-send for bidirectional encrypted proxy (e.g. rclone), with required --local=ADDR.
Used by csweb-gui job-replicate for encrypted ZFS send/receive.

Downloads

Platform File
Linux x86_64 zstream-linux-amd64
Linux ARM64 zstream-linux-arm64
Windows x86_64 zstream-windows-amd64.exe
FreeBSD x86_64 zstream-freebsd-amd64
OmniOS/Illumos x86_64 zstream-illumos-amd64
Oracle Solaris x86_64 zstream-solaris-amd64
macOS x86_64 zstream-darwin-amd64
macOS Apple Silicon zstream-darwin-arm64

Usage

# Receiver (start first):
zstream listen 9000 SESSIONKEY | zfs receive -F tank/backup

# Sender:
zfs send tank@snap | zstream send 192.168.1.10 9000 SESSIONKEY

Tunnel mode (new in v1.3.0)

# Folder sync via rclone over encrypted tunnel.
# --local=ADDR is required: the local address the wrapped child
# process binds to (tunnel-listen) or connects to (tunnel-send).

# Receiver (start first):
zstream tunnel-listen 9000 KEY --local=127.0.0.1:2222 -- rclone serve sftp /dst --addr 127.0.0.1:2222

# Sender:
zstream tunnel-send HOST 9000 KEY --local=127.0.0.1:2222 -- rclone sync /src :sftp: --sftp-host=127.0.0.1 --sftp-port=2222

Install (csweb-gui)

Download the binary for your platform and place it in:

  • Linux/OmniOS/BSD: /opt/csweb-gui/_cfg/s3/bin/zstream
  • Windows: C:\opt\csweb-gui\_cfg\s3\bin\zstream.exe
  • chmod +x on Linux/BSD/OmniOS