Updated fwd input plugin for fixing user auth, added 1 missing config option and general cleanup to doc. Fixes #2212.

[eschabell]

Updated fwd input plugin for fixing user auth, added 1 missing config option and general cleanup to doc. Fixes #2212.

Summary by CodeRabbit

Release Notes

• Documentation
  • Forward input configuration parameter names updated to snake_case format
  • Expanded documentation with new user authentication scenarios and configuration examples
  • Enhanced security configuration guidance clarifying relationships between authentication options

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[coderabbitai]

Warning

Rate limit exceeded

@eschabell has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 16 minutes and 12 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between 7344d28 and fea3fbb.

📒 Files selected for processing (1)

• pipeline/inputs/forward.md (3 hunks)

Walkthrough

Documentation for the Forward input plugin was updated to standardize configuration parameter names from CamelCase to snake_case, restructure authentication guidance into warning blocks, and add detailed user authentication examples with the empty_shared_key parameter.

Changes

Cohort / File(s)	Change Summary
Forward Input Documentation pipeline/inputs/forward.md	Standardized parameter names to snake_case (e.g., Listen→listen, Buffer_Max_Size→buffer_max_size), reformatted authentication information into warning-styled notes, added detailed examples and guidance for user authentication scenarios with empty_shared_key, and clarified relationships between security.users, shared_key, and empty_shared_key parameters.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

• Review parameter name consistency and accuracy across all renamed fields
• Verify that new authentication examples (YAML/CONF snippets) align with actual plugin behavior
• Confirm that the warning block and guidance text accurately represent the security requirements and constraints

Suggested reviewers

• esmerel

Poem

🐰 The Forward plugin docs take flight,
With snake_case names, now clean and right!
Authentication tales are told anew,
In warning blocks of gentle hue—
Configuration clarity blooms bright! ✨

Pre-merge checks and finishing touches

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title accurately describes the main changes: Forward input plugin user auth fixes, added missing config option, and documentation cleanup.
Linked Issues check	✅ Passed	The PR addresses the linked issue #2212 by fixing username parsing and authentication issues in the Forward input plugin documentation.
Out of Scope Changes check	✅ Passed	All changes are within scope: documentation updates to the Forward input plugin configuration, user authentication guidance, and configuration option standardization.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

---

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

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[eschabell]

Waiting....

Rate limit exceeded
eschabell has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 4 minutes and 12 seconds before requesting another review.

[eschabell]

@coderabbitai review

[coderabbitai]

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

[eschabell]

@coderabbitai review

[coderabbitai]

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

[eschabell]

@coderabbitai review

[coderabbitai]

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

[eschabell]

@coderabbitai review

[coderabbitai]

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

[eschabell]

@coderabbitai review

[coderabbitai]

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

[coderabbitai]

Actionable comments posted: 1

♻️ Duplicate comments (1)

pipeline/inputs/forward.md (1)

143-187: New empty_shared_key examples are well-structured and consistent.

The YAML and .conf examples in this new section demonstrate the feature appropriately. However, the .conf examples (lines 170-184) continue to use PascalCase naming (Security.Users, Empty_Shared_Key, Self_Hostname), which conflicts with the snake_case names in the parameter table above.

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 863ec6d and 7344d28.

📒 Files selected for processing (1)

• pipeline/inputs/forward.md (3 hunks)

🔇 Additional comments (2)

pipeline/inputs/forward.md (2)

93-98: Well-structured authentication requirement warning.

The warning block clearly communicates the requirement that security.users must be paired with either shared_key or empty_shared_key. This directly addresses the authentication issues mentioned in the PR objectives and helps prevent misconfiguration.

---

13-13: Documentation for new empty_shared_key parameter is clear and useful.

The parameter description and the dedicated section (lines 143-187) with practical examples effectively document how to use user authentication without requiring a shared key. This addresses the missing configuration option mentioned in the PR objectives.

[eschabell]

AI review passed, merging.