Skip to content

Testing Bootstrap UI for MeshCentral

Sammy Ndabo edited this page Oct 18, 2024 · 1 revision

Testing Bootstrap UI for MeshCentral

In this guide, we'll explain how to test the new Bootstrap 5 MeshCentral UI version, which has been added to the views/default3.handlebars file. Since we're still working on a way to toggle between the classic UI and the Bootstrap UI via the config.json, the current method involves manually switching the template files.

Prerequisites

Before you begin, ensure that you have the following installed:

  • Node.js: Ensure that Node.js is installed. You can download it from here.
  • Git: Make sure Git is installed. Get it from here.

Steps to Test the Bootstrap UI

Follow these steps to switch from the classic UI to the Bootstrap version, test it locally, and switch back if needed.

1. Clone the MeshCentral Repository

First, you'll need to clone the MeshCentral repository from GitHub to your local environment.

git clone https://github.com/Ndaboom/MeshCentral.git
cd MeshCentral

2. Install Dependencies

After cloning the project, run the following command to install necessary dependencies:

npm install

3. Switch to Bootstrap UI

To switch to the Bootstrap UI, follow these steps:

  • Navigate to the views folder within the MeshCentral project directory:
cd views
  • Rename default.handlebars (the current classic UI) to something else, like default-classic.handlebars:
mv default.handlebars default-classic.handlebars
  • Rename default3.handlebars (the Bootstrap UI) to default.handlebars:
mv default3.handlebars default.handlebars

4. Restart MeshCentral Server

To apply the changes, you need to restart the MeshCentral server. Return to the project root and run the following command:

node meshcentral.js

This will restart the MeshCentral server, and you should now see the Bootstrap-based UI when accessing the platform.

5. Reverting to Classic UI

If you want to switch back to the classic UI, reverse the steps:

  • Navigate back to the views folder:
cd views
  • Rename default.handlebars (Bootstrap UI) back to default3.handlebars:
mv default.handlebars default3.handlebars
  • Rename default-classic.handlebars back to default.handlebars:
mv default-classic.handlebars default.handlebars

6. Restart the MeshCentral Server Again

After reverting to the classic UI, restart the server again:

node meshcentral.js

Now, the classic UI will be restored.

Conclusion

That's it! By following these steps, you can test the Bootstrap version of the MeshCentral UI. Once we finalize a way to switch between UIs via the config.json file, we’ll update this documentation accordingly.