Documentation updates - #5539
Open
TheSyscall wants to merge 14 commits into
Open
Conversation
TheSyscall
force-pushed
the
documentation-updates
branch
from
July 10, 2026 11:21
9e072b5 to
60b4f57
Compare
jrauh01
marked this pull request as draft
July 22, 2026 11:34
Contributor
|
Converted this to draft until #5537 is ready. |
jrauh01
force-pushed
the
documentation-updates
branch
from
July 23, 2026 07:31
7cc3b1f to
f87aa8f
Compare
jrauh01
removed their request for review
July 23, 2026 07:32
jrauh01
force-pushed
the
documentation-updates
branch
from
July 23, 2026 07:46
f87aa8f to
e34aeee
Compare
jrauh01
marked this pull request as ready for review
August 6, 2026 13:44
lippserd
requested changes
Aug 7, 2026
lippserd
left a comment
lippserd
left a comment
Member
There was a problem hiding this comment.
In addition to the changes requested, please address the following before this can be merged:
The password-policy documentation changes belong in #5537 instead of being made compatible with the current main branch here. They already document #5537's User argument and Security-page placement, and keeping them in this PR would require both PRs to remain independently correct while that contract is still under discussion. Please move these changes to #5537.
While moving them, please also use mb_strlen() so that the advertised eight-character minimum counts characters rather than bytes, and explicitly state that PasswordPolicyHook always runs regardless of the providing module's module/<module-name> permission.
jrauh01
force-pushed
the
documentation-updates
branch
from
August 7, 2026 11:28
16f6ef8 to
9ea6b26
Compare
lippserd
reviewed
Aug 12, 2026
|
|
||
| This configuration is stored in the `config.ini` file in `/etc/icingaweb2`. | ||
|
|
||
| ### Password Policy Configuration <a id="configuration-security-password-policy"></a> |
Member
There was a problem hiding this comment.
Can't we move this to the modernize password policy PR as well?
Contributor
There was a problem hiding this comment.
Removed. Will be added in password policy PR.
lippserd
requested changes
Aug 12, 2026
Icinga Web falls back to enabled stack traces when the setting is omitted, and the general configuration form initializes the option enabled. The old documented default described a value that changes behavior instead of the default behavior.
The application reads this global setting when user preferences inherit the system value. Listing it in the general configuration reference makes the available system default visible to administrators.
`module_path` accepts a path list interpreted by the underlying platform. The reference should not imply Unix-style colons are valid everywhere.
The logger accepts the values exposed by `Logger::$levels`. `INFORMATION` was documented but is not a supported configuration value, while `INFO` is the value emitted by the UI and logger constants. Syslog and PHP logging both use the configured application prefix, with `icingaweb2` as the fallback. The syslog writer also falls back to the `user` facility, so the option table should state the same defaults as the runtime code.
`default_domain` is configured in the main application config, but the central `config.ini` reference did not list it. Keep the authentication page focused on the domain workflow and point readers to the option reference.
Cookie attributes can be set globally through `config.ini`, but the general configuration reference did not describe those accepted keys. Documenting them avoids requiring administrators to discover the settings from code.
Use code formatting for the theme identifier and link the strict CSP option back to the canonical general configuration section. Also fix the possessive in the CSP paragraph.
Add missing `application/migrations`, `application/sessions`, and `config/security` permissions to the permissions table.
Add an introduction to the hooks chapter covering how to implement a hook and how to register it in `run.php`.
Document how to define a custom hook type using `HookEssentials`, including the conventional file location, `getHookName()`, and `isAlwaysRun()`.
Add password_policy to the security configuration section and convert the Content Security Policy table from grid-style markdown to the simpler pipe format used elsewhere in the document.
jrauh01
force-pushed
the
documentation-updates
branch
from
August 12, 2026 07:36
fda33f6 to
3f14c38
Compare
Co-authored-by: Eric Lippmann <eric.lippmann@icinga.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
HookEssentialsconfig/securitypermission to the permissions table in the security chapter