From patchwork Sun Oct 11 09:43:57 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Janneke Nieuwenhuizen X-Patchwork-Id: 24556 Return-Path: X-Original-To: patchwork@mira.cbaines.net Delivered-To: patchwork@mira.cbaines.net Received: by mira.cbaines.net (Postfix, from userid 113) id 3505227BBEB; Sun, 11 Oct 2020 10:45:37 +0100 (BST) X-Spam-Checker-Version: SpamAssassin 3.4.2 (2018-09-13) on mira.cbaines.net X-Spam-Level: X-Spam-Status: No, score=-2.9 required=5.0 tests=BAYES_00,MAILING_LIST_MULTI, RCVD_IN_MSPIKE_H4,RCVD_IN_MSPIKE_WL,URIBL_BLOCKED autolearn=unavailable autolearn_force=no version=3.4.2 Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mira.cbaines.net (Postfix) with ESMTPS id D783027BBEA for ; Sun, 11 Oct 2020 10:45:36 +0100 (BST) Received: from localhost ([::1]:58062 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1kRXv6-00011Q-3G for patchwork@mira.cbaines.net; Sun, 11 Oct 2020 05:45:36 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:51242) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1kRXuY-0000eT-93 for guix-patches@gnu.org; Sun, 11 Oct 2020 05:45:02 -0400 Received: from debbugs.gnu.org ([209.51.188.43]:55831) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1kRXuX-0007Mf-Rv for guix-patches@gnu.org; Sun, 11 Oct 2020 05:45:01 -0400 Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1kRXuX-0006g7-Nl for guix-patches@gnu.org; Sun, 11 Oct 2020 05:45:01 -0400 X-Loop: help-debbugs@gnu.org Subject: [bug#43921] [Shepherd PATCH 1/2] Use XDG_CACHE_HOME/shepherd for unprivileged users' log directory. References: <874kn1rtgn.fsf@gnu.org> In-Reply-To: <874kn1rtgn.fsf@gnu.org> Resent-From: "Jan (janneke) Nieuwenhuizen" Original-Sender: "Debbugs-submit" Resent-CC: guix-patches@gnu.org Resent-Date: Sun, 11 Oct 2020 09:45:01 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 43921 X-GNU-PR-Package: guix-patches X-GNU-PR-Keywords: patch To: 43921@debbugs.gnu.org Received: via spool by 43921-submit@debbugs.gnu.org id=B43921.160240945325597 (code B ref 43921); Sun, 11 Oct 2020 09:45:01 +0000 Received: (at 43921) by debbugs.gnu.org; 11 Oct 2020 09:44:13 +0000 Received: from localhost ([127.0.0.1]:39142 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1kRXtf-0006eh-JX for submit@debbugs.gnu.org; Sun, 11 Oct 2020 05:44:13 -0400 Received: from eggs.gnu.org ([209.51.188.92]:44282) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1kRXtd-0006dz-Lp for 43921@debbugs.gnu.org; Sun, 11 Oct 2020 05:44:06 -0400 Received: from fencepost.gnu.org ([2001:470:142:3::e]:50040) by eggs.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1kRXtX-0007HN-Li; Sun, 11 Oct 2020 05:43:59 -0400 Received: from [2001:980:1b4f:1:42d2:832d:bb59:862] (port=48246 helo=dundal.fritz.box) by fencepost.gnu.org with esmtpa (Exim 4.82) (envelope-from ) id 1kRXtX-0008H9-4x; Sun, 11 Oct 2020 05:43:59 -0400 From: "Jan (janneke) Nieuwenhuizen" Date: Sun, 11 Oct 2020 11:43:57 +0200 Message-Id: <20201011094358.14013-1-janneke@gnu.org> X-Mailer: git-send-email 2.28.0 MIME-Version: 1.0 X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list X-BeenThere: guix-patches@gnu.org List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: guix-patches-bounces+patchwork=mira.cbaines.net@gnu.org Sender: "Guix-patches" X-getmail-retrieved-from-mailbox: Patches * modules/shepherd/support.scm (%user-cache-dir): New variable. (user-default-log-file): Use it. * doc/shepherd.texi (Invoking shepherd): Document it. --- doc/shepherd.texi | 4 +++- modules/shepherd/support.scm | 11 +++++++++-- 2 files changed, 12 insertions(+), 3 deletions(-) diff --git a/doc/shepherd.texi b/doc/shepherd.texi index 696477e..7c9a739 100644 --- a/doc/shepherd.texi +++ b/doc/shepherd.texi @@ -417,7 +417,9 @@ permissions are not as expected. Log output into @var{file}. For unprivileged users, the default log file is -@file{$XDG_CONFIG_HOME/shepherd/shepherd.log}. +@file{$XDG_CACHE_HOME/shepherd/shepherd.log}. If the +@code{XDG_CACHE_HOME} environment variable is not defined, +@code{$HOME/.cache/shepherd/shepherd.log} is used instead. @cindex syslog When running as root, the default behavior is to connect to diff --git a/modules/shepherd/support.scm b/modules/shepherd/support.scm index cdb7b35..fe64a05 100644 --- a/modules/shepherd/support.scm +++ b/modules/shepherd/support.scm @@ -4,6 +4,7 @@ ;; Copyright (C) 2002, 2003 Wolfgang Jährling ;; Copyright (C) 2016 Mathieu Lirzin ;; Copyright (C) 2018 Danny Milosavljevic +;; Copyright (C) 2020 Jan (janneke) Nieuwenhuizen ;; ;; This file is part of the GNU Shepherd. ;; @@ -265,6 +266,12 @@ There is NO WARRANTY, to the extent permitted by law."))) (false-if-exception (passwd:dir (getpwuid (getuid)))) "/")) +(define %user-cache-dir + ;; Default cache directory if shepherd is run as a normal user. + (string-append (or (getenv "XDG_CACHE_HOME") + (string-append user-homedir "/.cache")) + "/shepherd")) + (define %user-config-dir ;; Default config directory if shepherd is run as a normal user. (string-append (or (getenv "XDG_CONFIG_HOME") @@ -302,8 +309,8 @@ TARGET should be a string representing a filepath + name." ;; Logging. (define (user-default-log-file) "Return the file name of the user's default log file." - (mkdir-p %user-config-dir #o700) - (string-append %user-config-dir "/shepherd.log")) + (mkdir-p %user-cache-dir #o700) + (string-append %user-cache-dir "/shepherd.log")) (define default-logfile-date-format ;; 'strftime' format string to prefix each entry in the log. From patchwork Sun Oct 11 09:43:58 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Janneke Nieuwenhuizen X-Patchwork-Id: 24557 Return-Path: X-Original-To: patchwork@mira.cbaines.net Delivered-To: patchwork@mira.cbaines.net Received: by mira.cbaines.net (Postfix, from userid 113) id 52C9027BBEA; Sun, 11 Oct 2020 10:46:36 +0100 (BST) X-Spam-Checker-Version: SpamAssassin 3.4.2 (2018-09-13) on mira.cbaines.net X-Spam-Level: X-Spam-Status: No, score=-2.9 required=5.0 tests=BAYES_00,MAILING_LIST_MULTI, RCVD_IN_MSPIKE_H4,RCVD_IN_MSPIKE_WL,URIBL_BLOCKED autolearn=unavailable autolearn_force=no version=3.4.2 Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mira.cbaines.net (Postfix) with ESMTPS id 790F827BBEB for ; Sun, 11 Oct 2020 10:46:35 +0100 (BST) Received: from localhost ([::1]:59550 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1kRXw2-0001gx-N0 for patchwork@mira.cbaines.net; Sun, 11 Oct 2020 05:46:34 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:51244) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1kRXuY-0000ez-J5 for guix-patches@gnu.org; Sun, 11 Oct 2020 05:45:02 -0400 Received: from debbugs.gnu.org ([209.51.188.43]:55832) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1kRXuY-0007NA-6m for guix-patches@gnu.org; Sun, 11 Oct 2020 05:45:02 -0400 Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1kRXuY-0006gJ-4i for guix-patches@gnu.org; Sun, 11 Oct 2020 05:45:02 -0400 X-Loop: help-debbugs@gnu.org Subject: [bug#43921] [Shepherd PATCH 2/2] Add User Service example. Resent-From: "Jan (janneke) Nieuwenhuizen" Original-Sender: "Debbugs-submit" Resent-CC: guix-patches@gnu.org Resent-Date: Sun, 11 Oct 2020 09:45:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 43921 X-GNU-PR-Package: guix-patches X-GNU-PR-Keywords: patch To: 43921@debbugs.gnu.org Cc: Efraim Flashner Received: via spool by 43921-submit@debbugs.gnu.org id=B43921.160240945325604 (code B ref 43921); Sun, 11 Oct 2020 09:45:02 +0000 Received: (at 43921) by debbugs.gnu.org; 11 Oct 2020 09:44:13 +0000 Received: from localhost ([127.0.0.1]:39144 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1kRXtl-0006eo-58 for submit@debbugs.gnu.org; Sun, 11 Oct 2020 05:44:13 -0400 Received: from eggs.gnu.org ([209.51.188.92]:44288) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1kRXte-0006e6-5y for 43921@debbugs.gnu.org; Sun, 11 Oct 2020 05:44:06 -0400 Received: from fencepost.gnu.org ([2001:470:142:3::e]:50041) by eggs.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1kRXtY-0007Ha-Sn; Sun, 11 Oct 2020 05:44:00 -0400 Received: from [2001:980:1b4f:1:42d2:832d:bb59:862] (port=48246 helo=dundal.fritz.box) by fencepost.gnu.org with esmtpa (Exim 4.82) (envelope-from ) id 1kRXtY-0008H9-5m; Sun, 11 Oct 2020 05:44:00 -0400 From: "Jan (janneke) Nieuwenhuizen" Date: Sun, 11 Oct 2020 11:43:58 +0200 Message-Id: <20201011094358.14013-2-janneke@gnu.org> X-Mailer: git-send-email 2.28.0 In-Reply-To: <20201011094358.14013-1-janneke@gnu.org> References: <20201011094358.14013-1-janneke@gnu.org> MIME-Version: 1.0 X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list X-BeenThere: guix-patches@gnu.org List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: guix-patches-bounces+patchwork=mira.cbaines.net@gnu.org Sender: "Guix-patches" X-getmail-retrieved-from-mailbox: Patches * 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 --- doc/shepherd.texi | 71 ++++++++++++++++++++++++++++++++++-- modules/shepherd/support.scm | 4 ++ 2 files changed, 71 insertions(+), 4 deletions(-) diff --git a/doc/shepherd.texi b/doc/shepherd.texi index 7c9a739..41cc651 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 @ref{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,67 @@ 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 +(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=/run/user/$UID/ssh-agent/socket +;;; export SSH_AUTH_SOCK +;;; +;;; Code: + +(use-modules (shepherd support)) + +(define ssh-agent + (make + #: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)) + (unless (file-exists? log-dir) + (mkdir-p log-dir)) + (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)