Skip to content

Improve Docker documentation for 5.0.0+ and MacOS users #7406

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

Closed
wants to merge 1 commit into from

Conversation

gonzaarancibia
Copy link
Member

Description

This PR improves the Docker documentation for setting up the Wazuh development environment, with a focus on MacOS-specific instructions and clarifying behavior differences between versions. It adds detailed explanations for setting vm.max_map_count on MacOS, updates the jq installation instructions, and includes information about accessing the dashboard via HTTPS in version 5.0.0+.

A key improvement is documenting that in version 5.0.0 and later, the Wazuh Dashboard container automatically installs dependencies and starts the server with yarn start --no-base-path , eliminating the need for developers to manually enter the container to run these commands.

Issues Resolved

  • Lack of clear MacOS-specific instructions for setting up the development environment
  • Missing information about automatic startup behavior in version 5.0.0+
  • Unclear troubleshooting steps for common issues like "Wazuh dashboard server is not ready yet"
  • Incomplete host file configuration instructions for MacOS users
  • Confusion about manual vs. automatic dashboard startup in different versions

Evidence

[Provide screenshots or videos to prove this PR solves the issues]

Test

To test this PR:

  1. Follow the updated MacOS instructions to set up a new development environment
  2. Verify that the vm.max_map_count command works correctly on MacOS
  3. Confirm that the documentation accurately describes the behavior of version 5.0.0+ containers (automatic dependency installation and server startup)
  4. Test accessing the dashboard via HTTPS as described in the documentation
  5. Verify that developers no longer need to manually run yarn start in version 5.0.0+

Check List

  • New functionality includes testing.
  • New functionality has been documented.
  • Update CHANGELOG.md
  • Commits are signed per the DCO using --signoff

Copy link
Contributor

Wazuh Core plugin code coverage (Jest) test % values
Statements 28.24% ( 711 / 2517 )
Branches 28.92% ( 370 / 1279 )
Functions 26.08% ( 186 / 713 )
Lines 28.38% ( 706 / 2487 )

Copy link
Contributor

Wazuh Check Updates plugin code coverage (Jest) test % values
Statements 76.44% ( 172 / 225 )
Branches 58.65% ( 61 / 104 )
Functions 61.7% ( 29 / 47 )
Lines 76.44% ( 172 / 225 )

Copy link
Contributor

Wazuh Fleet Management plugin code coverage (Jest) test % values
Statements 40.38% ( 773 / 1914 )
Branches 36.92% ( 353 / 956 )
Functions 38.38% ( 233 / 607 )
Lines 40.2% ( 753 / 1873 )

@gonzaarancibia gonzaarancibia deleted the fix/docker-documentation-update-5.0.0 branch April 22, 2025 11:58
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