branch master updated: doc: cookbook: Document a dynamic DNS update mcron job.

[guix-commits]

This is an automated email from the git hooks/post-receive script.

apteryx pushed a commit to branch master
in repository guix.

The following commit(s) were added to refs/heads/master by this push:
     new 55f1c1c8a1 doc: cookbook: Document a dynamic DNS update mcron job.
55f1c1c8a1 is described below

commit 55f1c1c8a17daf1a578e6c99e2634254a5c785ed
Author: Maxim Cournoyer <maxim.cournoyer@gmail.com>
AuthorDate: Wed Jul 26 20:35:06 2023 -0400

    doc: cookbook: Document a dynamic DNS update mcron job.
    
    * doc/guix-cookbook.texi (System Configuration)
    <Dynamic DNS mcron job>: New subsection.
    
    Reviewed-by: Ludovic Courtès <ludo@gnu.org>
---
 doc/guix-cookbook.texi | 59 ++++++++++++++++++++++++++++++++++++++++++++++++--
 1 file changed, 57 insertions(+), 2 deletions(-)

diff --git a/doc/guix-cookbook.texi b/doc/guix-cookbook.texi
index db29ef2c3e..aa3d6debbd 100644
--- a/doc/guix-cookbook.texi
+++ b/doc/guix-cookbook.texi
@@ -124,9 +124,10 @@ System Configuration
 * Customizing the Kernel::      Creating and using a custom Linux kernel on 
Guix System.
 * Guix System Image API::       Customizing images to target specific 
platforms.
 * Using security keys::         How to use security keys with Guix System.
+* Dynamic DNS mcron job::       Job to update the IP address behind a DuckDNS 
host name.
 * Connecting to Wireguard VPN::  Connecting to a Wireguard VPN.
 * Customizing a Window Manager::  Handle customization of a Window manager on 
Guix System.
-* Running Guix on a Linode Server:: Running Guix on a Linode Server.  Running 
Guix on a Linode Server
+* Running Guix on a Linode Server:: Running Guix on a Linode Server.  Running 
Guix on a Linode Server.
 * Setting up a bind mount::     Setting up a bind mount in the file-systems 
definition.
 * Getting substitutes from Tor::  Configuring Guix daemon to get substitutes 
through Tor.
 * Setting up NGINX with Lua::   Configuring NGINX web-server to load Lua 
modules.
@@ -1570,9 +1571,10 @@ reference.
 * Customizing the Kernel::      Creating and using a custom Linux kernel on 
Guix System.
 * Guix System Image API::       Customizing images to target specific 
platforms.
 * Using security keys::         How to use security keys with Guix System.
+* Dynamic DNS mcron job::       Job to update the IP address behind a DuckDNS 
host name.
 * Connecting to Wireguard VPN::  Connecting to a Wireguard VPN.
 * Customizing a Window Manager::  Handle customization of a Window manager on 
Guix System.
-* Running Guix on a Linode Server:: Running Guix on a Linode Server.  Running 
Guix on a Linode Server
+* Running Guix on a Linode Server:: Running Guix on a Linode Server.  Running 
Guix on a Linode Server.
 * Setting up a bind mount::     Setting up a bind mount in the file-systems 
definition.
 * Getting substitutes from Tor::  Configuring Guix daemon to get substitutes 
through Tor.
 * Setting up NGINX with Lua::   Configuring NGINX web-server to load Lua 
modules.
@@ -2132,6 +2134,59 @@ security key'' menu.  If it works, congratulations, your 
security key is
 ready to be used with applications supporting two-factor authentication
 (2FA).
 
+@node Dynamic DNS mcron job
+@section Dynamic DNS mcron job
+
+@cindex dynamic DNS, DDNS
+If your @acronym{ISP, Internet Service Provider} only provides dynamic
+IP addresses, it can be useful to setup a dynamic @acronym{DNS, Domain
+Name System} (also known as @acronym{DDNS, Dynamic DNS}) service to
+associate a static host name to a public but dynamic (often changing) IP
+address.  There are multiple existing services that can be used for
+this; in the following mcron job, @url{https://duckdns.org, DuckDNS} is
+used.  It should also work with other dynamic DNS services that offer a
+similar interface to update the IP address, such as
+@url{https://freedns.afraid.org/}, with minor adjustments.
+
+The mcron job is provided below, where @var{DOMAIN} should be
+substituted for your own domain prefix, and the DuckDNS provided token
+associated to @var{DOMAIN} added to the
+@file{/etc/duckdns/@var{DOMAIN}.token} file.
+
+@lisp
+(define duckdns-job
+  ;; Update personal domain IP every 5 minutes.
+  #~(job '(next-minute (range 0 60 5))
+        #$(program-file
+            "duckdns-update"
+            (with-extensions (list guile-gnutls) ;required by (web client)
+              #~(begin
+                  (use-modules (ice-9 textual-ports)
+                               (web client))
+                  (let ((token (string-trim-both
+                                (call-with-input-file 
"/etc/duckdns/@var{DOMAIN}.token"
+                                  get-string-all)))
+                        (query-template (string-append 
"https://www.duckdns.org/";
+                                                       
"update?domains=@var{DOMAIN}"
+                                                       "&token=~a&ip=")))
+                    (http-get (format #f query-template token))))))
+         "duckdns-update"
+         #:user "nobody"))
+@end lisp
+
+The job then needs to be added to the list of mcron jobs for your
+system, using something like:
+
+@lisp
+(operating-system
+ (services
+  (cons* (service mcron-service-type
+           (mcron-configuration
+             (jobs (list duckdns-job ...))))
+         ...
+         %base-services)))
+@end lisp
+
 @node Connecting to Wireguard VPN
 @section Connecting to Wireguard VPN