Improve Docker documentation for 6.0.0+ and MacOS users

[gonzaarancibia]

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 6.0.0+.

A key improvement is documenting that in version 6.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.

Additionally, this PR documents the --no-start flag which allows developers to prevent automatic startup and manually control the initialization process when needed for debugging or custom configurations.

Issues Resolved

• Lack of clear MacOS-specific instructions for setting up the development environment
• Missing information about automatic startup behavior in version 6.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
• No documentation for preventing automatic startup when manual control is needed

Evidence

1. Automatic startup in version 6.0.0+

• Video showing the dashboard automatically starting without manual intervention
• Container logs showing automatic dependency installation and server startup

without.flag.mov

2. Manual control with --no-start flag

• Video demonstration showing:
  • Starting the environment with ./dev.sh --no-start -a up
  • Container running but dashboard service not starting automatically
  • Manually connecting to the container, install dependencies and starting the service
  • Dashboard becoming accessible after manual startup

--no-start-redorc.mov

3. MacOS-specific vm.max_map_count configuration

• Screenshot showing successful execution of the Docker command to set vm.max_map_count on MacOS:

4. MacOS user permissions setup

• Terminal screenshot showing successful execution of the MacOS-specific commands:

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 6.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 6.0.0+

Check List

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

[yenienserrano]

Test: 🔴

When I execute the line sudo chown -R $USER:staff $WZ_HOME it gives an error

sudo dscl . -create /Groups/docker-desktop 
sudo dscl . -create /Groups/docker-desktop PrimaryGroupID 100999
sudo dscl . -create /Users/docker-desktop
sudo dscl . -create /Users/docker-desktop UniqueID 100999
sudo dscl . -create /Users/docker-desktop PrimaryGroupID 100999
sudo chown -R $USER:staff $WZ_HOME
zsh: bad substitution

[gonzaarancibia]

Test: 🔴

When I execute the line sudo chown -R $USER:staff $WZ_HOME it gives an error

sudo dscl . -create /Groups/docker-desktop 
sudo dscl . -create /Groups/docker-desktop PrimaryGroupID 100999
sudo dscl . -create /Users/docker-desktop
sudo dscl . -create /Users/docker-desktop UniqueID 100999
sudo dscl . -create /Users/docker-desktop PrimaryGroupID 100999
sudo chown -R $USER:staff $WZ_HOME
zsh: bad substitution

@yenienserrano Could you please try replace the last command:

sudo chown -R $USER:staff $WZ_HOME

to:

sudo chown -R $(whoami):staff $WZ_HOME

I've identified the bug and fixed it in this commit.

The problem is that in zsh the $USER variable isn't always expanded correctly, causing the "zsh: bad substitution" error. I've modified the command to use $(whoami) instead, which works consistently in all shells, including zsh.

[yenienserrano]

🟢

[github-actions]

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 )

[github-actions]

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 )

[github-actions]

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 )