[bug#50808]

[bug#50808]

[Jacob Adams]

I was setting up an rsync server behind a wireguard VPN, and found that
I couldn't bind rsync to a specific IP address using the rsync service
configuration in Guix, despite it being supported in the rsyncd
configuration file.
It was an easy extension of the existing service and now I'm happily running
rsync bound to the computer's wireguard address.

[bug#50808] [PATCH] services: rsync: support binding rsync to a specific IP address

[Jacob Adams]

 * gnu/services/rsync.scm: Support IP address configuration
 * doc/guix.texi: Document new address rsync configuration option
---
 doc/guix.texi          | 4 ++++
 gnu/services/rsync.scm | 5 ++++-
 2 files changed, 8 insertions(+), 1 deletion(-)

diff --git a/doc/guix.texi b/doc/guix.texi
index 4bf14014eb..9a858de2d9 100644
--- a/doc/guix.texi
+++ b/doc/guix.texi
@@ -17151,6 +17151,10 @@ Data type representing the configuration for @code{rsync-service}.
 @item @code{package} (default: @var{rsync})
 @code{rsync} package to use.
 
+@item @code{address} (default: @code{""})
+IP address on which @command{rsync} listens for incoming connections.
+If unspecified, it defaults to listening on all available addresses.
+
 @item @code{port-number} (default: @code{873})
 TCP port on which @command{rsync} listens for incoming connections.  If port
 is less than @code{1024} @command{rsync} needs to be started as the
diff --git a/gnu/services/rsync.scm b/gnu/services/rsync.scm
index 6c117bbda4..0a9ed82a42 100644
--- a/gnu/services/rsync.scm
+++ b/gnu/services/rsync.scm
@@ -45,6 +45,8 @@
   rsync-configuration?
   (package       rsync-configuration-package              ; package
                  (default rsync))
+  (address       rsync-configuration-address              ; string
+                 (default ""))
   (port-number   rsync-configuration-port-number          ; integer
                  (default 873))
   (pid-file      rsync-configuration-pid-file             ; string
@@ -110,7 +112,7 @@
 (define rsync-config-file
   ;; Return the rsync configuration file corresponding to CONFIG.
   (match-lambda
-    (($ <rsync-configuration> package port-number pid-file lock-file log-file
+    (($ <rsync-configuration> package address port-number pid-file lock-file log-file
                               use-chroot? share-path share-comment read-only?
                               timeout user group uid gid)
      (if (not (string=? user "root"))
@@ -132,6 +134,7 @@
       "pid file = " pid-file "\n"
       "lock file = " lock-file "\n"
       "log file = " log-file "\n"
+      (if (not (string=? address "")) (string-append "address = " address "\n") "")
       "port = " (number->string port-number) "\n"
       "use chroot = " (if use-chroot? "true" "false") "\n"
       (if uid (string-append "uid = " uid "\n") "")
-- 
2.30.2

[bug#50808] Fixup bug title

[Jacob Adams]

[-- Attachment #1: Type: text/plain, Size: 152 bytes --]

Control: retitle -1 [PATCH] services: rsync: support binding rsync to a specific IP address

Apologies, I'm still learning my way around git send-email.

[-- Attachment #2: Type: text/html, Size: 331 bytes --]

[bug#50808] [PATCH] services: rsync: support binding rsync to a specific IP address

[Oleg Pykhalov]

[-- Attachment #1: Type: text/plain, Size: 702 bytes --]

Hi Jacob,

Nice catch, I would like to have this configurable, too.

Jacob Adams <jacob@tookmund.com> writes:

[…]

> +  (address       rsync-configuration-address              ; string
> +                 (default ""))

We could just use ‘#f’ here with ‘string | #f’ comment.

[…]

> +      (if (not (string=? address "")) (string-append "address = " address "\n") "")
>        "port = " (number->string port-number) "\n"
>        "use chroot = " (if use-chroot? "true" "false") "\n"
>        (if uid (string-append "uid = " uid "\n") "")

And here we could just ‘(if address (string-append ...) "")’.

Could you send an updated patch, please?

Thanks,
Oleg.

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 861 bytes --]

[bug#50808] [PATCH v2] services: rsync: support binding rsync to a specific IP address

[Jacob Adams]

 * gnu/services/rsync.scm: Support IP address configuration
 * doc/guix.texi: Document new address rsync configuration option
---
That's a much cleaner approach, thanks! I'm very new to Scheme and
didn't even realize I could do that.

 doc/guix.texi          | 4 ++++
 gnu/services/rsync.scm | 5 ++++-
 2 files changed, 8 insertions(+), 1 deletion(-)

diff --git a/doc/guix.texi b/doc/guix.texi
index 4bf14014eb..a932dbcc09 100644
--- a/doc/guix.texi
+++ b/doc/guix.texi
@@ -17151,6 +17151,10 @@ Data type representing the configuration for @code{rsync-service}.
 @item @code{package} (default: @var{rsync})
 @code{rsync} package to use.
 
+@item @code{address} (default: @code{#f})
+IP address on which @command{rsync} listens for incoming connections.
+If unspecified, it defaults to listening on all available addresses.
+
 @item @code{port-number} (default: @code{873})
 TCP port on which @command{rsync} listens for incoming connections.  If port
 is less than @code{1024} @command{rsync} needs to be started as the
diff --git a/gnu/services/rsync.scm b/gnu/services/rsync.scm
index 6c117bbda4..59faed78f6 100644
--- a/gnu/services/rsync.scm
+++ b/gnu/services/rsync.scm
@@ -45,6 +45,8 @@
   rsync-configuration?
   (package       rsync-configuration-package              ; package
                  (default rsync))
+  (address       rsync-configuration-address              ; string | #f
+                 (default #f))
   (port-number   rsync-configuration-port-number          ; integer
                  (default 873))
   (pid-file      rsync-configuration-pid-file             ; string
@@ -110,7 +112,7 @@
 (define rsync-config-file
   ;; Return the rsync configuration file corresponding to CONFIG.
   (match-lambda
-    (($ <rsync-configuration> package port-number pid-file lock-file log-file
+    (($ <rsync-configuration> package address port-number pid-file lock-file log-file
                               use-chroot? share-path share-comment read-only?
                               timeout user group uid gid)
      (if (not (string=? user "root"))
@@ -132,6 +134,7 @@
       "pid file = " pid-file "\n"
       "lock file = " lock-file "\n"
       "log file = " log-file "\n"
+      (if address (string-append "address = " address "\n") "")
       "port = " (number->string port-number) "\n"
       "use chroot = " (if use-chroot? "true" "false") "\n"
       (if uid (string-append "uid = " uid "\n") "")
-- 
2.30.2

bug#50808: [PATCH] services: rsync: support binding rsync to a specific IP address

[Ludovic Courtès]

Hi,

Jacob Adams <jacob@tookmund.com> skribis:

>  * gnu/services/rsync.scm: Support IP address configuration
>  * doc/guix.texi: Document new address rsync configuration option

I tweaked the commit message and applied it.

Thank you!

Ludo’.