From: "Jan (janneke) Nieuwenhuizen" <janneke@gnu.org>
To: 43921@debbugs.gnu.org
Cc: Efraim Flashner <efraim@flashner.co.il>
Subject: [bug#43921] [Shepherd PATCH v2 2/2] Add User Service example.
Date: Sun, 11 Oct 2020 14:10:00 +0200 [thread overview]
Message-ID: <20201011121000.26307-1-janneke@gnu.org> (raw)
In-Reply-To: <874kn1rtgn.fsf@gnu.org>
* modules/shepherd/support.scm: Export %user-cache-dir, %user-config-dir,
%user-runtime-dir.
* doc/shepherd.texi (User Service examples): Use them in new subsection with
example.
Co-authored-by: Efraim Flashner <efraim@flashner.co.il>
---
doc/shepherd.texi | 79 ++++++++++++++++++++++++++++++++++--
modules/shepherd/support.scm | 4 ++
2 files changed, 79 insertions(+), 4 deletions(-)
diff --git a/doc/shepherd.texi b/doc/shepherd.texi
index 7c9a739..e6207b3 100644
--- a/doc/shepherd.texi
+++ b/doc/shepherd.texi
@@ -13,6 +13,7 @@ Copyright @copyright{} @value{OLD-YEARS} Wolfgang J@"ahrling@*
Copyright @copyright{} @value{NEW-YEARS} Ludovic Courtès@*
Copyright @copyright{} 2020 Brice Waegeneire@*
Copyright @copyright{} 2020 Oleg Pykhalov
+Copyright @copyright{} 2020 Jan (janneke) Nieuwenhuizen@*
Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.3 or
@@ -146,10 +147,11 @@ configuration file. When it is started with superuser privileges, it
tries to use @code{/etc/shepherd.scm}. When started as normal user, it
looks for a file called @code{$XDG_CONFIG_HOME/shepherd/init.scm}. If
the @code{XDG_CONFIG_HOME} environment variable is not defined,
-@code{$HOME/.config/shepherd/init.scm} is used instead. With the option
-@code{--config} (or, for short, @code{-c}), you can specify where to
-look instead. So if you want to start @command{shepherd} with an
-alternative file, use one of the following commands:
+@code{$HOME/.config/shepherd/init.scm} is used instead (@pxref{User
+Service examples}). With the option @code{--config} (or, for short,
+@code{-c}), you can specify where to look instead. So if you want to
+start @command{shepherd} with an alternative file, use one of the
+following commands:
@example
shepherd --config=/etc/shepherd.scm.old
@@ -1025,6 +1027,75 @@ also specifies some more initial values for the slots:
(restart (...)))))
@end lisp
+@menu
+* User Service examples::
+@end menu
+
+@node User Service examples
+@subsection User Service examples
+
+For starters, use a toplevel @code{$XDG_CONFIG_HOME/shepherd/init.scm}
+that looks like this:
+
+@lisp
+;;; Commentary:
+;;;
+;;; Add to your ~/.bash_profile:
+;;;
+;;; if [[ ! -S ${XDG_RUN_HOME-$HOME/.cache}/shepherd/socket ]]; then
+;;; shepherd
+;;; fi
+;;;
+;;; Code:
+
+(use-modules (shepherd service)
+ ((ice-9 ftw) #:select (scandir)))
+
+;; Load all the files in the directory 'init.d' with a suffix '.scm'.
+(for-each
+ (lambda (file)
+ (load (string-append "init.d/" file)))
+ (scandir (string-append (dirname (current-filename)) "/init.d")
+ (lambda (file)
+ (string-suffix? ".scm" file))))
+
+;; Send shepherd into the background
+(action 'shepherd 'daemonize)
+@end lisp
+
+Then, individual user services can be put in
+@code{$XDG_CONFIG_HOME/shepherd/init.d/}, e.g., for ssh-agent
+
+@lisp
+;;; Commentary:
+;;;
+;;; Add to your ~/.bash_profile:
+;;;
+;;; SSH_AUTH_SOCK=${XDG_RUN_HOME-$HOME/.cache}/ssh-agent/socket
+;;; export SSH_AUTH_SOCK
+;;;
+;;; Code:
+
+(use-modules (shepherd support))
+
+(define ssh-agent
+ (make <service>
+ #:provides '(ssh-agent)
+ #:docstring "Run `ssh-agent'"
+ #:start (let ((socket-dir (string-append %user-runtime-dir "/ssh-agent")))
+ (unless (file-exists? socket-dir)
+ (mkdir-p socket-dir)
+ (chmod socket-dir #o700))
+ (make-forkexec-constructor
+ `("ssh-agent" "-D" "-a" ,(string-append socket-dir "/socket"))
+ #:log-file (string-append %user-cache-dir "/ssh-agent.log")))
+ #:stop (make-kill-destructor)
+ #:respawn? #t))
+(register-services ssh-agent)
+
+(start ssh-agent)
+@end lisp
+
@c @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
@node The root and unknown services
diff --git a/modules/shepherd/support.scm b/modules/shepherd/support.scm
index fe64a05..bf34ada 100644
--- a/modules/shepherd/support.scm
+++ b/modules/shepherd/support.scm
@@ -61,6 +61,10 @@
persistency
persistency-state-file
+ %user-cache-dir
+ %user-config-dir
+ %user-runtime-dir
+
verify-dir))
(define-syntax-rule (if-2.0 subsequent alternate)
--
Jan Nieuwenhuizen <janneke@gnu.org> | GNU LilyPond http://lilypond.org
Freelance IT http://JoyofSource.com | Avatar® http://AvatarAcademy.com
next prev parent reply other threads:[~2020-10-11 12:11 UTC|newest]
Thread overview: 10+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-10-11 9:40 [bug#43921] [Shepherd PATCH 0/2] Add User Service example Jan Nieuwenhuizen
2020-10-11 9:43 ` [bug#43921] [Shepherd PATCH 1/2] Use XDG_CACHE_HOME/shepherd for unprivileged users' log directory Jan (janneke) Nieuwenhuizen
2020-10-11 9:43 ` [bug#43921] [Shepherd PATCH 2/2] Add User Service example Jan (janneke) Nieuwenhuizen
2020-10-11 10:38 ` Jan Nieuwenhuizen
2020-10-11 12:10 ` Jan (janneke) Nieuwenhuizen [this message]
2020-10-12 5:15 ` [bug#43921] [PATCH v3 " Jan (janneke) Nieuwenhuizen
2020-10-23 13:31 ` Ludovic Courtès
2020-10-23 16:37 ` Jan Nieuwenhuizen
2020-11-18 21:37 ` bug#43921: " Ludovic Courtès
2020-11-19 6:00 ` [bug#43921] " Jan Nieuwenhuizen
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: https://guix.gnu.org/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20201011121000.26307-1-janneke@gnu.org \
--to=janneke@gnu.org \
--cc=43921@debbugs.gnu.org \
--cc=efraim@flashner.co.il \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://git.savannah.gnu.org/cgit/guix.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).