From 5e05ca7b89213c5762542851474626dcae4c0211 Mon Sep 17 00:00:00 2001 From: Alaa Eddine Elamri Date: Wed, 10 Nov 2021 10:58:52 +0100 Subject: [PATCH] docs: updated `Pid Directory` directive description --- .../dir-director-PidDirectory.rst.inc | 4 +++- .../fd-client-PidDirectory.rst.inc | 2 ++ .../sd-storage-PidDirectory.rst.inc | 3 +++ 3 files changed, 8 insertions(+), 1 deletion(-) diff --git a/docs/manuals/source/manually_added_config_directive_descriptions/dir-director-PidDirectory.rst.inc b/docs/manuals/source/manually_added_config_directive_descriptions/dir-director-PidDirectory.rst.inc index 6eda3e29898..95447083370 100644 --- a/docs/manuals/source/manually_added_config_directive_descriptions/dir-director-PidDirectory.rst.inc +++ b/docs/manuals/source/manually_added_config_directive_descriptions/dir-director-PidDirectory.rst.inc @@ -1,5 +1,7 @@ -This directive is optional and specifies a directory in which the Director may put its process Id file. The process Id file is used to shutdown Bareos and to prevent multiple copies of Bareos from running simultaneously. Standard shell expansion of the Directory is done when the configuration file is read so that values such as $HOME will be properly expanded. +This directive is optional and specifies a directory in which the Director may put its process Id file. The process Id file is used to shut down Bareos and to prevent multiple copies of Bareos from running simultaneously. Standard shell expansion of the Directory is done when the configuration file is read so that values such as $HOME will be properly expanded. The PID directory specified must already exist and be readable and writable by the Bareos daemon referencing it. Typically on Linux systems, you will set this to: :file:`/var/run`. If you are not installing Bareos in the system directories, you can use the Working Directory as defined above. + +As of bareos 21, this directive is deprecated. The way to set up a pid file is to do it as an option to the Director binary with the ``-p `` option, where is the path to a pidfile of your choosing. By default, no pidfile is created. diff --git a/docs/manuals/source/manually_added_config_directive_descriptions/fd-client-PidDirectory.rst.inc b/docs/manuals/source/manually_added_config_directive_descriptions/fd-client-PidDirectory.rst.inc index ae821b4a6e3..d5e1f4987da 100644 --- a/docs/manuals/source/manually_added_config_directive_descriptions/fd-client-PidDirectory.rst.inc +++ b/docs/manuals/source/manually_added_config_directive_descriptions/fd-client-PidDirectory.rst.inc @@ -1,3 +1,5 @@ This directive specifies a directory in which the File Daemon may put its process Id file files. The process Id file is used to shutdown Bareos and to prevent multiple copies of Bareos from running simultaneously. The Bareos file daemon uses a platform specific default value, that is defined at compile time. Typically on Linux systems, it is set to :file:`/var/lib/bareos/` or :file:`/var/run/`. + +As of bareos 21, this directive is deprecated. The new way to set up a pid file is to do it as an option to the Client binary with the ``-p `` option, where is the path to a pidfile of your choosing. By default, no pidfile is created. diff --git a/docs/manuals/source/manually_added_config_directive_descriptions/sd-storage-PidDirectory.rst.inc b/docs/manuals/source/manually_added_config_directive_descriptions/sd-storage-PidDirectory.rst.inc index 59b1fb06a7d..3059cfd76ec 100644 --- a/docs/manuals/source/manually_added_config_directive_descriptions/sd-storage-PidDirectory.rst.inc +++ b/docs/manuals/source/manually_added_config_directive_descriptions/sd-storage-PidDirectory.rst.inc @@ -1 +1,4 @@ This directive specifies a directory in which the Storage Daemon may put its process Id file files. The process Id file is used to shutdown Bareos and to prevent multiple copies of Bareos from running simultaneously. Standard shell expansion of the directory is done when the configuration file is read so that values such as $HOME will be properly expanded. + +As of bareos 21, this directive is deprecated. The way to set up a pid file is to do it as an option to the Storage binary with the ``-p `` option, where is the path to a pidfile of your choosing. By default, no pidfile is created. +