Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add offline-url documentation #7193

Merged
merged 5 commits into from
Apr 18, 2024
Merged

Add offline-url documentation #7193

merged 5 commits into from
Apr 18, 2024

Conversation

GabrielEValenzuela
Copy link
Member

@GabrielEValenzuela GabrielEValenzuela commented Apr 15, 2024

Objective

This PR aims to address the omission of the offline-url option in the existing documentation for the Vulnerability Detection module. By documenting the valid values for the offline-url field, we provide users with comprehensive guidance on how to configure this feature for offline updates, enhancing usability and functionality of the system.

Description

  • Feedback and user inquiries revealed a gap in our documentation regarding the configuration of the offline-url option in the Vulnerability Detection module. This option is critical for environments where direct internet access is restricted or unavailable.
  • To remedy this, we have updated the documentation to include a dedicated section for the offline-url option. This section details the purpose of the option, describes its use cases, and lists all valid values and formats that can be used to configure the system for offline operation.
  • Key Additions:
    • Purpose and Usage: Explanation of why and when to use the offline-url option.
    • Valid Values: Comprehensive list of valid URL formats and configurations supported by the system, such as local file paths or network-shared folders, with examples for each.

- Add offline-url option.
MiguelazoDS
MiguelazoDS previously approved these changes Apr 16, 2024
Copy link
Member

@MiguelazoDS MiguelazoDS left a comment

Choose a reason for hiding this comment

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

GJ! no changes required just a comment to discuss, probably is not relevant.

source/user-manual/reference/ossec-conf/vuln-detector.rst Outdated Show resolved Hide resolved
source/user-manual/reference/ossec-conf/vuln-detector.rst Outdated Show resolved Hide resolved
- Fix review comments, urls.
MiguelazoDS
MiguelazoDS previously approved these changes Apr 16, 2024
sebasfalcone
sebasfalcone previously approved these changes Apr 16, 2024
Copy link
Member

@sebasfalcone sebasfalcone left a comment

Choose a reason for hiding this comment

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

LGTM

@javimed javimed added type/bug Bug issue level/task Task issue labels Apr 17, 2024
Copy link
Member

@javimed javimed left a comment

Choose a reason for hiding this comment

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

FYI: Created issue #7207

- Fix review comments.
javimed
javimed previously approved these changes Apr 18, 2024
sebasfalcone
sebasfalcone previously approved these changes Apr 18, 2024
Copy link
Member

@sebasfalcone sebasfalcone left a comment

Choose a reason for hiding this comment

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

LGTM!

- Fix review comments. Improve example.
@GabrielEValenzuela GabrielEValenzuela dismissed stale reviews from sebasfalcone and javimed via 0c8fd8e April 18, 2024 11:42
- Trim spaces.
@javimed javimed merged commit 73c8e81 into 4.8.0 Apr 18, 2024
3 checks passed
@javimed javimed deleted the bug/7185_add_offline-url branch April 18, 2024 11:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
level/task Task issue type/bug Bug issue
Projects
No open projects
Status: Done
Development

Successfully merging this pull request may close these issues.

offline-url option is not included in the vulnerability detection module documentation
4 participants