docs(daemon): add TLS-in-front deployment recipes (#2052)#3500
Merged
Conversation
Document how to put TLS in front of oc-rsyncd using stunnel, an SSH local-forward, or a TCP-mode reverse proxy (HAProxy/nginx). Covers threat model, matching `oc-rsyncd.conf` snippets, client-side options including `--connect-program` and `--port`, mTLS, and DNS-SAN cert hygiene. Cross-links the daemon filter-precedence page.
oferchen
added a commit
that referenced
this pull request
May 5, 2026
Document how to put TLS in front of oc-rsyncd using stunnel, an SSH local-forward, or a TCP-mode reverse proxy (HAProxy/nginx). Covers threat model, matching `oc-rsyncd.conf` snippets, client-side options including `--connect-program` and `--port`, mTLS, and DNS-SAN cert hygiene. Cross-links the daemon filter-precedence page.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds
docs/daemon/tls-in-front.md, a new operator-facing page coveringhow to put TLS in front of an
oc-rsyncddaemon. oc-rsync's daemonmode is plaintext rsync over TCP (wire-equivalent to upstream); this
page documents the three pragmatic ways to wrap that wire in TLS
without protocol changes.
What landed
integrity, server identity, optional mTLS) and what it does not
replace (
auth users,secrets file,hosts allow, filter rules,chroot).
stunnel.conflistening on TCP/874 withcert/key, forwarding to127.0.0.1:8730, plus a matchingoc-rsyncd.confsnippet bound viaaddress = 127.0.0.1andport = 8730.ssh -N -L 8730:localhost:8730 hostplusoc-rsync rsync://localhost:8730/module/. Explicitly distinguishesthis from rsync-over-ssh transport (
-e ssh), which spawns a remote--serverand bypasses the daemon entirely.listenblock inmode tcpwithbind ... ssl crt, plus an nginxstream {}block. Calls out thatHTTP-mode proxies will corrupt the rsync wire protocol.
local stunnel,
--connect-programwithopenssl s_client(%H/%Pplaceholders), and SSH-tunnel shapes.
directives per terminator,
addressbinding, the--portflag, andwhy HTTP health checks must be avoided.
docs/daemon/filter-precedence.mdand
docs/DAEMON_PROCESS_MODEL.md, and to upstream'sstunnel-rsyncd.conf.Factual claims were verified against
crates/daemon/src/daemon/sections/config_parsing/global_directives.rs(directive names
address/port),crates/daemon/src/daemon/sections/config_parsing/module_directives.rs(
auth users,secrets file,hosts allow),crates/cli/src/frontend/command_builder/sections/build_base_command/network.rs(
--port,--connect-programwith%H/%P), and upstreamrsync-3.4.1/stunnel-rsyncd.conf/daemon-parm.txt.Closes the documentation request in #2052.
Test plan
docs/. Expectfmt/clippy/nextest/Windows/macOS/Linux-musl all green by virtue
of being a no-op for the build graph.
docs/daemon/tls-in-front.mdand verify therelative links to
filter-precedence.mdand../DAEMON_PROCESS_MODEL.mdresolve.