summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/guix.texi20
1 files changed, 12 insertions, 8 deletions
diff --git a/doc/guix.texi b/doc/guix.texi
index a3b17578a8f..78f9ffc3128 100644
--- a/doc/guix.texi
+++ b/doc/guix.texi
@@ -46886,15 +46886,19 @@ A custom name that will be displayed on connected clients.
The list of media folders to serve content from. Each item is a
@code{readymedia-media-directory}.
-@item @code{cache-directory} (default: @code{"/var/cache/readymedia"}) (type: string)
-A folder for ReadyMedia's cache files. If not existing already, the
-folder will be created as part of the service activation and the
-ReadyMedia user will be assigned ownership.
+@item @code{cache-directory} (type: gexp-or-string)
+A folder for ReadyMedia's cache files, defaulting to
+@file{"/var/cache/readymedia"}. If the path is relative, like
+@file{".cache/readymedia"}, it will be looked up in the user's home
+directory. If the directory does not exist already, the folder will be
+created as part of the service activation and the "readymedia" user will
+be assigned ownership. For Guix Home services, the value defaults to
+@file{".cache/readymedia"}.
-@item @code{log-directory} (default: @code{"/var/log/readymedia"}) (type: string)
-A folder for ReadyMedia's log files. If not existing already, the
-folder will be created as part of the service activation and the
-ReadyMedia user will be assigned ownership.
+@item @code{log-file} (type: gexp-or-string)
+Where the service will write its logs, defaulting to
+@file{"/var/log/readymedia.log"}. For Guix Home services, it defaults to
+@file{@env{XDG_STATE_HOME}/shepherd/readymedia.log}.
@item @code{port} (default: @code{#f}) (type: maybe-integer)
A custom port that the service will be listening on.