Missing ClousStack UI Setup commands in Install.md #10590
Description
ISSUE TYPE
Documentation Report
COMPONENT NAME
INSTALL.md
CLOUDSTACK VERSION->CloudStack 4.20.0.0
OS / ENVIRONMENT->Ubuntu LTS 22.04.5
SUMMARY
The INSTALL.md file is missing key setup commands that are essential for first-time contributors. Adding these commands will ensure a hassle-free setup process and smooth onboarding.
STEPS TO REPRODUCE
Follow the current installation steps in INSTALL.md.
Attempt to set up MySQL without securing it.
Try running the CloudStack UI without setting up dependencies correctly.
EXPECTED RESULTS
The documentation should include steps for securing MySQL.
Users should be guided on how to start the UI and set the CS_URL.
The management server should be clearly mentioned as running at http://localhost:5050/.
ACTUAL RESULTS
mysql_secure_installation is not mentioned, which may lead to an insecure setup.
The steps to install UI dependencies (npm install), build (npm build), and start (npm start) are missing.
No mention of setting CS_URL=http://localhost:8080/client in .env.local, leading to potential API connection issues.
The final expected endpoint for the management server (http://localhost:5050/) is not explicitly stated.
PROPOSED CHANGES TO INSTALL.md
Secure MySQL Installation:
$ mysql_secure_installation
CloudStack UI Setup:
Navigate to the UI directory:
$ cd /path/to/cloudstack/ui
Install dependencies:
$ npm install
Build the project:
$ npm build
Start in development mode:
$ npm start
Ensure CS_URL=http://localhost:8080/client is set in .env.local for API communication.
Management Server Access:
http://localhost:5050/
Adding these steps will make the installation process smoother for new contributors.