Skip to content

docs: follow-up nits on log paths, YAJL_LIB and CRS reporting link - #408

Open
airween wants to merge 1 commit into
masterfrom
docs/406-followup-nits
Open

airween wants to merge 1 commit into
masterfrom
docs/406-followup-nits

Conversation

@airween

@airween airween commented Nov 14, 2026 •

Copy link
Copy Markdown
Member

Follow-up to #406 with the remaining review nits, which were left out of that PR.

  • README, debug log: a missing log directory doesn't only stop nginx from starting; on a reload, nginx rejects the new configuration and keeps running with the old rules. That's the case people tend to miss, so it's now spelled out.
  • README, debug log: the directory needs to be writable by the user nginx is started as only when the log file doesn't exist yet; a pre-created file is enough. The rule that nobody else may write to the directory or its parents is unchanged.
  • README, YAJL_LIB: config turns it into -L… -lyajl, which also ends up on the MSVC link line (config:46) where it doesn't work. Noted for Windows users.
  • SECURITY.md: the CRS entry now links to coreruleset/coreruleset/security/advisories/new (the report form), matching the libmodsecurity entry, instead of the policy page.

Docs only, no code changes.

AI disclosure

Made with help of Claude Code (Opus 5.5)

Summary by CodeRabbit

  • Documentation
    • Clarified when YAJL_LIB is used and which builds support it.
    • Explained how nginx handles reloads when debug-log rules fail to load.
    • Clarified when the nginx startup user needs write access to the log directory.
    • Updated the security-reporting link to point to the security advisories page.

- README: a debug-log directory that does not exist also makes a reload
  fail; nginx then keeps running with the old configuration.
- README: the directory only has to be writable by the user nginx is
  started as when the log file does not exist yet.
- README: YAJL_LIB becomes -L/-lyajl linker flags and does not work for
  MSVC builds.
- SECURITY.md: link CRS to its "Report a vulnerability" form, like the
  libmodsecurity entry.

Follow-up to #406.
@coderabbitai

coderabbitai Bot commented Nov 14, 2026 •

Copy link
Copy Markdown

Explain Change →

No actionable comments were generated in the recent review.

Walkthrough

The documentation updates describe build configuration options, debug-log rule-loading outcomes, and the destination for the OWASP CRS security-reporting link.

Changes: README guidance

Layer / File(s) Summary
Build configuration guidance
README.md
The README documents when YAJL_LIB applies, when library auto-discovery ignores it, and that it does not apply to MSVC builds.
Debug-log rule-loading guidance
README.md
The README describes startup and reload outcomes when debug-log rule loading fails. It also states when the log directory must be writable by the nginx startup user.

Security reporting link

Layer / File(s) Summary
Advisory destination
SECURITY.md
The OWASP CRS security-reporting link now points to the security advisories page.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Change: Other

Suggested reviewers: fzipi

Merge Risk: Minimal · up to 6a3a7

This is a documentation-only update to the build, debug-log, and security-reporting guidance. It does not change runtime behavior, and no merge-blocking risk remains.

Pre-merge checks: Passed 4

Check name Status Explanation
Description Check Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check Passed The title uses the "docs:" prefix and names three documentation-only changes: log paths, YAJL_LIB guidance, and the CRS reporting link. These match the README and SECURITY.md changes in the summary an…
Linked Issues check Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check Passed Check skipped because no linked issues were found for this pull request.
Full details: Title check

Explanation

The title uses the "docs:" prefix and names three documentation-only changes: log paths, YAJL_LIB guidance, and the CRS reporting link. These match the README and SECURITY.md changes in the summary and objectives. The title does not state the main point, which is that the README now explains log-directory reload behavior and YAJL_LIB limits. It is a partial description rather than an unrelated one, and the "nits" wording is informal but not vague.

Finishing Touches

Generate unit tests (beta)

  • Commit to this branch
  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

Share

Recent review info

Run configuration

  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: defaults
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: 9c454078-6815-456f-aa7e-9a9c9c488f9e
Commits

Reviewing files that changed from the base of the PR and between 30a4747 and 6a3a730.

Files selected for processing: 2

  • README.md
  • SECURITY.md

Included review availability: This review used your included allowance. Your plan provides up to 4 included reviews per hour; 3 remain after this review.

@sonarqubecloud

Copy link
Copy Markdown

@airween
airween requested a review from fzipi November 14, 2026 14:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant