don't alter configuration on package updates by joergsteffens · Pull Request #2338 · bareos/bareos

joergsteffens · 2025-08-06T15:34:33Z

Thank you for contributing to the Bareos Project!

Currently, how Bareos is handling configuration files differs between platforms.
On most platform, the default configuration is stored in a configtemplatedirectory, like /usr/lib/bareos/defaultconfigs/ (Debian, macOS, Windows). Until now, RPM-based systems have the configuration directly stored at /etc/bareos.

This PR also stores the default configuration in /usr/lib/bareos/defaultconfigs/.
Currently it uses deploy_config to initially deply the configuration, but this will change soon.

See bareos/internal#318

when packages contain additional configuration file for other packages (or example configuration files), it is not guaranteed that these packages are copied into the live configuration. In doubt, they are only available in the defaultconfigs directory. => doc: don't alter configuration on package updates #2392
documentation needs to be adapted => doc: don't alter configuration on package updates #2392
breaking change needs to be documented in release-notes, also mention that configuration files may seem changed even when they are not (because of the copying during upgrade)

Please check

Short description and the purpose of this PR is present above this paragraph
Your name is present in the AUTHORS file (optional)

If you have any questions or problems, please give a comment in the PR.

Helpful documentation and best practices

Checklist for the reviewer of the PR (will be processed by the Bareos team)

Make sure you check/merge the PR using devtools/pr-tool to have some simple automated checks run and a proper changelog record added.

General

Is the PR title usable as CHANGELOG entry?
Purpose of the PR is understood
Commit descriptions are understandable and well formatted
~~Required backport PRs have been created~~
Correct milestone is set

Source code quality

Source code changes are understandable
Variable and function names are meaningful
Code comments are correct (logically and spelling)
Required documentation changes are present and part of the PR

arogge

That looks pretty weird, but good.
I have a few remarks, that should be addressed and I haven't yet tried it.

arogge · 2025-09-09T14:31:54Z

core/scripts/bareos-ctl-dir.in

+BAREOS_DIRECTOR_USER=${BAREOS_DIRECTOR_USER-@dir_user@}
+BAREOS_DIRECTOR_GROUP=${BAREOS_DIRECTOR_GROUP-@dir_group@}


that doesn't look right

Why not? After I changed some cmake settings, @dir_user@ etc. is set also for the systemtests directory. Therefore it has been required to set them to "". However, these scripts still set the configured @dir_user@ and only use "", if :- was changed to -
So there is a reason to make this change. Do you propose another approach?

Agreed to keep it like this for now and change it in some other PR.

I'm not sure to understand what was agreed to be kept, the proposed changes?
If we keep the actual code :-VAR I'm ok.

No, we keep the change from this PR, so ${BAREOS_DIRECTOR_GROUP-@dir_group@}.
We need it, as BAREOS_DIRECTOR_GROUP (and others) can be set to "". With :- it would use the default value (@dir_group@), with : it will use "". The need the second behavior. However, once #2383 is implemented, this is no longer required.

core/scripts/bareos-ctl-fd.in

core/scripts/bareos-ctl-sd.in

core/scripts/bareos-config-lib.sh.in

core/platforms/freebsd/bareos-freebsd/bareos.com-common/pkg-plist.common

core/platforms/freebsd/bareos-freebsd/bareos.com-common/pkg-plist.storage-dplcompat

arogge · 2025-09-26T14:52:26Z

core/platforms/freebsd/bareos-freebsd/bareos.com-common/pkg-plist.storage-fifo

+lib/bareos/defaultconfigs/bareos-dir.d/storage/NULL.conf.example
+lib/bareos/defaultconfigs/bareos-sd.d/device/NULL.conf.example


Use %%BAREOS_CONFIG_TEMPLATE_DIR%%

arogge · 2025-09-26T14:52:37Z

core/platforms/freebsd/bareos-freebsd/bareos.com-common/pkg-plist.storage-tape

+lib/bareos/defaultconfigs/bareos-dir.d/storage/Tape.conf.example
+lib/bareos/defaultconfigs/bareos-sd.d/autochanger/autochanger-0.conf.example
+lib/bareos/defaultconfigs/bareos-sd.d/device/tapedrive-0.conf.example


Use %%BAREOS_CONFIG_TEMPLATE_DIR%%

arogge · 2025-09-26T14:52:50Z

core/platforms/freebsd/bareos-freebsd/bareos.com-common/pkg-plist.storage-fifo

@@ -1,3 +1,3 @@
 /usr/local/lib/libbareossd-fifo.so


why do we have an absolute path here?

core/platforms/packaging/bareos.spec

bruno-at-bareos

Impressive work, I found a few possible improvements, like rpm variables.

On testing on Debian there's a few issue like warning that pop-up due to missing files

chmod: cannot access '/etc/bareos/bareos-dir-export//*/*.conf': No such file or directory

(there's a double / we should fix everywhere in bareos-config-libs

 /usr/lib/bareos/scripts/bareos-config deploy_config --add-missing bareos-fd
'/usr/lib/bareos/defaultconfigs/bareos-fd.d//./director/bareos-dir.conf' -> '/etc/bareos/bareos-fd.d/./director/bareos-dir.conf'
'/usr/lib/bareos/defaultconfigs/bareos-fd.d//./messages/Standard.conf' -> '/etc/bareos/bareos-fd.d/./messages/Standard.conf'Info: replacing 'XXX_REPLACE_WITH_CLIENT_PASSWORD_XXX' in /etc/bareos/bareos-fd.d/director/bareos-dir.conf

To be documented:

All use case like the removal of a component will not remove the whole configuration.

Re-Adding a component will not by default check if there's a missing or changed file, you will have to run the command manually

/usr/lib/bareos/scripts/bareos-config deploy_config --add-missing bareos-fd

see also internal/issue/467

bruno-at-bareos · 2025-10-07T11:51:54Z

cmake/BareosSetVariableDefaults.cmake


 # check if variables are set via cmdline else set them to default values

+include(GNUInstallDirs)


Are we sure that will also work on Windows, as we had an if contrib/CMakeLists.txt before ?

In my tests, this seams to work well. Have you any specific doubt what could break? I've seen, these has be used differently at different places in the code. I tried to use it only once.

core/platforms/freebsd/bareos-freebsd/bareos.com-common/pkg-post-install

bruno-at-bareos · 2025-10-07T12:52:56Z

core/scripts/bareos-ctl-dir.in

+BAREOS_DIRECTOR_USER=${BAREOS_DIRECTOR_USER-@dir_user@}
+BAREOS_DIRECTOR_GROUP=${BAREOS_DIRECTOR_GROUP-@dir_group@}


I'm not sure to understand what was agreed to be kept, the proposed changes?
If we keep the actual code :-VAR I'm ok.

debian/bareos-bconsole.postinst

bruno-at-bareos · 2025-10-07T13:42:40Z

core/platforms/packaging/bareos.spec

+%define backend_dir       %{_libdir}/%{name}/backends
+%define plugin_dir        %{_libdir}/%{name}/plugins
+%define script_dir        /usr/lib/%{name}/scripts
+%define working_dir       /var/lib/%{name}


Suggested change

%define working_dir /var/lib/%{name}

%define working_dir %{_sharedstatedir}/%{name}

While not using libdir is valid not using sharedstatedir doesn't rely on something valid from my point of view.
Of course we still can skip boyscout rule and let that in place for another decade ;-)

core/platforms/packaging/bareos.spec

core/README.configsubdirectories

bruno-at-bareos · 2025-10-07T15:43:02Z

It would be the good time to fix also the don't set address with localhost under debian, so pg connection will be using socket instead tcp

diff --git i/core/scripts/bareos-config-lib.sh.in w/core/scripts/bareos-config-lib.sh.in
index 2e34b4018..81fc0aba6 100644
--- i/core/scripts/bareos-config-lib.sh.in
+++ w/core/scripts/bareos-config-lib.sh.in
@@ -1137,7 +1137,10 @@ apply_dbconfig_settings()
   [ "${dbc_install}" = "true" ] && [ "${dbc_upgrade}" = "true" ] || return 0

   if [ -n "${dbc_dbserver}" ]; then
-    set_config_param "bareos-dir" "Catalog" "MyCatalog" "dbaddress" "${dbc_dbserver}"
+    # Set the address only if not localhost, so local connection use socket
+    if [ "${dbc_dbserver}" != "localhost" ]; then
+      set_config_param "bareos-dir" "Catalog" "MyCatalog" "dbaddress" "${dbc_dbserver}"
+    fi
   fi

   if [ -n "${dbc_dbuser}" ]; then

bruno-at-bareos · 2025-10-08T08:10:27Z

Last point on FreeBSD (maybe other) running an --add-missing on bareos-dir component show a missing line return

...
/usr/local/etc/bareos/bareos-dir.d/./storage/File.conf not overwrittenchmod: /usr/local/etc/bareos/bareos-dir-export//*/*.conf: No such file or directory

bruno-at-bareos

While I would have enjoyed to see applying some variables changes like _rundir and _sharedstatedir
All the tests made have worked.

arogge

Looks good to me.

... instead of using RPM config files.

@sample

based on FreeBSD man page pkg-script the script order on upgrade is: 1. new pre-install 2. old pre-deinstall 3. replace binaries 4. new post-install Based on this, we implemented saving the old configuration (@sample files that are no longer defined) before they got deleted by post-deinstall. Spoiler: this does not work, as on upgrade the old package gots complete removed, including running post-deinstall, before any script of the new package is called.

@sample

Config files in Bareos <= 24 are marked as @sample files. With Bareos 25 we use "bareos-config deploy_config --init" instead to initially populate the config directory. Unfortenatly, unmodified @sample files get removed during the upgrade process. FreeBSD first fully removes the old package and than install the new new. The order is (at least on FreeBSD 14): * pkg-pre-deinstall — from old package * Remove files from old package * pkg-post-deinstall — from old package * pkg-pre-install — from new package * Install files of the new package * pkg-post-install — from new package As workaround, when upgrading from Bareos < 24, the redeploy missing files from the new package. To keep track of this, a marker file is created: "${BAREOS_CONFIG_DIR}/.${COMPONENT}.deploy_config.version" deploy_config --add-missing is only called (in pkg-post-install) when either this file does not exist or the version number in there is < 25.

When communicating with a local PostgreSQL database server, it is advised to use a socket connection instead of TCP. When dbaddress is not set in the Bareos Catalog configuration, Bareos tries connects via sockets. If it is set, it connects via TCP. As dbconfig-common by default specifies "localhost" for a local PostgreSQL database, we ignore this setting.

joergsteffens self-assigned this Aug 6, 2025

joergsteffens force-pushed the dev/joergs/master/config-once branch from 98f143c to 169a66f Compare August 26, 2025 15:41

joergsteffens force-pushed the dev/joergs/master/config-once branch 2 times, most recently from 6c0a0fb to 3a21ba9 Compare September 5, 2025 17:48

joergsteffens marked this pull request as ready for review September 5, 2025 17:51

bruno-at-bareos mentioned this pull request Sep 8, 2025

bareos-filedaemon: Debian package re-creates deleted config file during upgrade #2365

Closed

bruno-at-bareos linked an issue Sep 8, 2025 that may be closed by this pull request

bareos-filedaemon: Debian package re-creates deleted config file during upgrade #2365

Closed

joergsteffens requested a review from arogge September 8, 2025 20:23

arogge added this to the 25.0.0 milestone Sep 9, 2025

arogge requested changes Sep 26, 2025

View reviewed changes

arogge mentioned this pull request Oct 2, 2025

move bareos-ctl-* scripts to systemtest directory #2383

Closed

joergsteffens force-pushed the dev/joergs/master/config-once branch 2 times, most recently from bc9401a to 85a51e2 Compare October 3, 2025 18:03

joergsteffens requested a review from arogge October 3, 2025 18:10

joergsteffens force-pushed the dev/joergs/master/config-once branch 3 times, most recently from 55abd0c to 962664d Compare October 4, 2025 08:43

bruno-at-bareos requested changes Oct 7, 2025

View reviewed changes

bruno-at-bareos linked an issue Oct 7, 2025 that may be closed by this pull request

move bareos-ctl-* scripts to systemtest directory #2383

Closed

bruno-at-bareos approved these changes Oct 9, 2025

View reviewed changes

arogge approved these changes Oct 9, 2025

View reviewed changes

joergsteffens and others added 7 commits October 10, 2025 10:29

outdated, removed

4a3b4d1

bareos-config: fix checking password for sep

1a96dfb

rpm: use configtemplatedir and deploy_config

0f47a68

... instead of using RPM config files.

move webui profiles to bareos-dir package

35d27ac

cmake: include BareosSetVariableDefaults on top level

6574253

cmake/BareosSetVariableDefaults: check-sources

a446c1d

scripts: allow empty user/groups in systemtests

b2735de

joergsteffens added 12 commits October 10, 2025 10:29

deb: permission for /etc/bareos

03494f5

config: only deploy to empty dest dir

ec8818f

doc: update info about configsubdirectories

a6dad86

freebsd: use deploy_config

27f3035

rpm spec: on update, check previous version

9a2a173

docs: cleanup

0be55f1

bareos-config: add deploy-config --add-missing

f3c48e8

docs: add Bareos Template Configuration Path

ba659f1

changelog: add breaking change note about config handling

7d7f995

joergsteffens force-pushed the dev/joergs/master/config-once branch from 436434d to 7d7f995 Compare October 10, 2025 08:30

joergsteffens mentioned this pull request Oct 10, 2025

doc: don't alter configuration on package updates #2390

Merged

17 tasks

joergsteffens added the requires no backport This will not be backported label Oct 10, 2025

BareosBot merged commit 7f7c510 into master Oct 10, 2025
3 of 4 checks passed

BareosBot deleted the dev/joergs/master/config-once branch October 10, 2025 14:29

bruno-at-bareos removed a link to an issue Oct 13, 2025

move bareos-ctl-* scripts to systemtest directory #2383

Closed

joergsteffens mentioned this pull request Oct 15, 2025

doc: don't alter configuration on package updates #2392

Merged

10 tasks

		BAREOS_DIRECTOR_USER=${BAREOS_DIRECTOR_USER-@dir_user@}
		BAREOS_DIRECTOR_GROUP=${BAREOS_DIRECTOR_GROUP-@dir_group@}

		lib/bareos/defaultconfigs/bareos-dir.d/storage/NULL.conf.example
		lib/bareos/defaultconfigs/bareos-sd.d/device/NULL.conf.example


		# check if variables are set via cmdline else set them to default values

		include(GNUInstallDirs)

	%define working_dir /var/lib/%{name}
	%define working_dir %{_sharedstatedir}/%{name}

Conversation

joergsteffens commented Aug 6, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Thank you for contributing to the Bareos Project!

Please check

Helpful documentation and best practices

Checklist for the reviewer of the PR (will be processed by the Bareos team)

General

Source code quality

Uh oh!

arogge left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

bruno-at-bareos left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

bruno-at-bareos commented Oct 7, 2025

Uh oh!

bruno-at-bareos commented Oct 8, 2025

Uh oh!

bruno-at-bareos left a comment

Choose a reason for hiding this comment

Uh oh!

arogge left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

joergsteffens commented Aug 6, 2025 •

edited

Loading

bruno-at-bareos left a comment •

edited

Loading