Skip to content

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

Merged
BareosBot merged 13 commits intomasterfrom
dev/joergs/master/config-once-doc
Oct 21, 2025
Merged

doc: don't alter configuration on package updates#2392
BareosBot merged 13 commits intomasterfrom
dev/joergs/master/config-once-doc

Conversation

@joergsteffens
Copy link
Member

@joergsteffens joergsteffens commented Oct 14, 2025

Thank you for contributing to the Bareos Project!

This PR contains the neccessary documentation change to #2338

  • 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.
  • 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
  • No Required backport
  • Correct milestone is set
Source code quality
  • Source code changes are understandable
  • Required documentation changes are present and part of the PR

@joergsteffens joergsteffens self-assigned this Oct 14, 2025
@joergsteffens joergsteffens added documentation This PR changes only documentation requires no backport This will not be backported labels Oct 14, 2025
@joergsteffens joergsteffens force-pushed the dev/joergs/master/config-once-doc branch 2 times, most recently from 522a3a8 to e3ac54f Compare October 15, 2025 12:32
@joergsteffens joergsteffens added this to the 25.0.0 milestone Oct 15, 2025
@joergsteffens joergsteffens force-pushed the dev/joergs/master/config-once-doc branch from 2df75b4 to 58e7acd Compare October 15, 2025 14:14
@joergsteffens joergsteffens marked this pull request as ready for review October 15, 2025 14:14
@joergsteffens joergsteffens force-pushed the dev/joergs/master/config-once-doc branch 2 times, most recently from f2db0ae to 1a3a794 Compare October 16, 2025 09:10
Copy link
Contributor

@bruno-at-bareos bruno-at-bareos left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great changes. See my comments.

- :file:`/usr/lib/bareos/plugins/`
- :file:`/usr/local/lib/bareos/plugins/`
- :file:`/usr/local/bareos/lib/bareos/plugins/`
- :file:`$INSTDIR\\plugins\\`
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

same as above

Suggested change
- :file:`$INSTDIR\\plugins\\`
- :file:`C:\\Program Files\\plugins\\`

@joergsteffens joergsteffens force-pushed the dev/joergs/master/config-once-doc branch 4 times, most recently from 9c45b99 to e3a285b Compare October 16, 2025 17:36
Copy link
Contributor

@bruno-at-bareos bruno-at-bareos left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice improvements, I have one pending request about the formatting of products names, but it is already acceptable.

cp -a /tmp/bareos-dir.d /etc/bareos/

Restart the |dir| and verify your configuration. Also make sure, that all resource configuration files coming from Bareos packages exists, in doubt as empty files, see :ref:`remove configuration resource files <section-deleteConfigurationResourceFiles>`.
Behavior
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we try to have component and package names in this section designed the same way ?

Suggested change
Behavior
* On upgrades, the existing configuration files for the components ``bareos-dir``, ``bareos-sd``, ``bareos-fd``, ``bconsole`` and ``bareos-traymonitor`` will not get modified.

or use double asterisk like below ... because here the name is just italic. If this is what we want, then make it also for bareos-storage-tape bareos-storage.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I chose different formatting more or less on purpose (or at least have been unsure, what to use). As we have a naming convention for packages (https://docs.bareos.org/DocumentationStyleGuide/SpecificFormatting.html#name) I changed all to that.

However, they will only be used, when the legacy configuration file does not exist.

See :ref:`section-UpdateToConfigurationSubdirectories` for details and how to migrate to :ref:`section-SubdirectoryConfigurationScheme`.
As long as your configuration didn't show any deprecation warnings before the upgrade,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems one line has escaped the changes ;-)

Suggested change
As long as your configuration didn't show any deprecation warnings before the upgrade,

joergsteffens and others added 11 commits October 21, 2025 09:24
Co-authored-by: Bruno Friedmann @bareos <89836284+bruno-at-bareos@users.noreply.github.com>
... as it is no clear, how to use them in a unified way.
to make table source more human readable
and allow multi-line cells.

Unfortenatly, the :width: parameter is ignored in our environment,
to limit the table to the available width.
@joergsteffens joergsteffens force-pushed the dev/joergs/master/config-once-doc branch from e3a285b to d47666d Compare October 21, 2025 07:26
@BareosBot BareosBot merged commit 8435136 into master Oct 21, 2025
1 check was pending
@BareosBot BareosBot deleted the dev/joergs/master/config-once-doc branch October 21, 2025 07:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation This PR changes only documentation requires no backport This will not be backported

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants