Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
32 commits
Select commit Hold shift + click to select a range
2fc2276
Sanitation and cleanup.
DaanSelen Mar 24, 2025
5c44c94
More sanitation.
DaanSelen Mar 24, 2025
7162409
Good base.
DaanSelen Mar 26, 2025
b3192ed
Conversion of images to jpeg for background and added border-radius.
DaanSelen Mar 26, 2025
1f36c6b
sanitation and css addition.
DaanSelen Mar 26, 2025
ba45fa0
Moved documents and further expanded documentation.
DaanSelen Mar 27, 2025
a38e212
Converting images and setting structure.
DaanSelen Mar 27, 2025
fd34584
Minor text addition
DaanSelen Mar 28, 2025
5d79780
Merge branch 'Ylianst:master' into docrewrite
DaanSelen May 12, 2025
4bd137d
Merge branch 'Ylianst:master' into docrewrite
DaanSelen May 22, 2025
c5f5d1d
[ENH] Improve home page documentation, meshcentral index page documen…
AlainCis Jun 15, 2025
9d585ae
[ENH]Improve submodules & features page
AlainCis Jun 18, 2025
fd50eba
[ENH]review and improve how-to-contribute page
AlainCis Jun 19, 2025
14b7861
[ENH]review and improve Design and Architecture page
AlainCis Jun 21, 2025
9246e3d
[ENH] Reviewed and improve 'Other' pages
AlainCis Jun 23, 2025
4dcbdd3
Merge branch 'Ylianst:master' into docrewrite
DaanSelen Jun 25, 2025
5e074d3
Merge branch 'Ylianst:master' into docrewrite
DaanSelen Jul 24, 2025
1e143bf
Merge pull request #9 from AlainCis/enh-adfs_sso_guide-docs
DaanSelen Jul 24, 2025
e4e83df
Merge pull request #8 from AlainCis/enh-design-and-architecture-docs
DaanSelen Jul 24, 2025
4d1b78b
Merge pull request #6 from AlainCis/enh-submodules-and-features-docs
DaanSelen Jul 24, 2025
3a1b49c
Merge pull request #7 from AlainCis/enh-how-to-contribute-docs
DaanSelen Jul 24, 2025
e90d553
Merge pull request #10 from DaanSelen/premerger
DaanSelen Jul 24, 2025
a5204ec
Merge branch 'Ylianst:master' into docrewrite
DaanSelen Jul 24, 2025
8ac2a54
reworked advanced page
Jul 25, 2025
65e51cd
Merge branch 'Ylianst:master' into docrewrite
DaanSelen Aug 3, 2025
b8007e9
Merge branch 'Ylianst:master' into docrewrite
DaanSelen Aug 7, 2025
bc0f47b
Small additions and corrections.
Aug 7, 2025
ceda62e
minor removal of dashes
Aug 7, 2025
bd7c2cf
[ENH] Review and improve install menu (With related pages) in the doc…
AlainCis Sep 16, 2025
1327afa
Merge branch 'Ylianst:master' into docrewrite
DaanSelen Sep 16, 2025
27f5851
Merge branch 'Ylianst:master' into docrewrite
DaanSelen Sep 25, 2025
7eba91a
feat: rewrite entire install directory
DaanSelen Sep 25, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ meshcentral.db.json
mesherrors.txt
bob.json
.greenlockrc
venv

## Ignore Visual Studio temporary files, build results, and
## files generated by popular Visual Studio add-ons.
Expand Down
15 changes: 15 additions & 0 deletions docs/.vscode/launch.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
{
// Use IntelliSense to learn about possible attributes.
// Hover to view descriptions of existing attributes.
// For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
"version": "0.2.0",
"configurations": [
{
"type": "chrome",
"request": "launch",
"name": "Launch Chrome against localhost",
"url": "http://localhost:8080",
"webRoot": "${workspaceFolder}"
}
]
}
Binary file added docs/docs/design/images/2022-05-15-12-57-36.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/docs/design/images/2022-05-15-12-57-36.png
Binary file not shown.
Binary file added docs/docs/design/images/2022-05-15-13-01-56.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/docs/design/images/2022-05-15-13-01-56.png
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/docs/design/images/2022-05-15-13-03-25.png
Binary file not shown.
Binary file added docs/docs/design/images/2022-05-15-13-36-01.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/docs/design/images/2022-05-15-13-36-01.png
Binary file not shown.
Binary file added docs/docs/design/images/2022-05-15-13-41-26.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/docs/design/images/2022-05-15-13-41-26.png
Binary file not shown.
Binary file added docs/docs/design/images/2022-05-15-13-44-41.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/docs/design/images/2022-05-15-13-44-41.png
Binary file not shown.
Binary file added docs/docs/design/images/2022-05-15-13-47-26.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/docs/design/images/2022-05-15-13-47-26.png
Binary file not shown.
Binary file added docs/docs/design/images/2022-05-15-13-54-44.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/docs/design/images/2022-05-15-13-54-44.png
Binary file not shown.
Binary file added docs/docs/design/images/2022-05-15-13-55-28.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/docs/design/images/2022-05-15-13-55-28.png
Binary file not shown.
Binary file added docs/docs/design/images/2022-05-15-13-56-09.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/docs/design/images/2022-05-15-13-56-09.png
Binary file not shown.
Binary file added docs/docs/design/images/2022-05-15-13-56-46.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/docs/design/images/2022-05-15-13-56-46.png
Binary file not shown.
Binary file added docs/docs/design/images/2022-05-15-13-58-06.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/docs/design/images/2022-05-15-13-58-06.png
Binary file not shown.
Binary file added docs/docs/design/images/2022-05-15-13-58-29.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/docs/design/images/2022-05-15-13-58-29.png
Diff not rendered.
Binary file removed docs/docs/design/images/2022-05-15-13-58-56.png
Diff not rendered.
Binary file added docs/docs/design/images/2022-05-15-13-59-54.jpg
Binary file removed docs/docs/design/images/2022-05-15-13-59-54.png
Diff not rendered.
Binary file added docs/docs/design/images/2022-05-15-14-00-21.jpg
Binary file removed docs/docs/design/images/2022-05-15-14-00-21.png
Diff not rendered.
Diff not rendered.
Diff not rendered.
220 changes: 140 additions & 80 deletions docs/docs/design/index.md

Large diffs are not rendered by default.

99 changes: 71 additions & 28 deletions docs/docs/how-to-contribute/index.md
Original file line number Diff line number Diff line change
@@ -1,56 +1,99 @@
# Contribute to MeshCentral
# Contribute to MeshCentral

## Contributing to MeshCentral via GitHub Pull Request
---
## 📤 Contributing to MeshCentral via GitHub Pull Request

If you're looking to contribute beyond translations, such as updating documentation or enhancing the software by adding features or fixing bugs, the process involves several key steps :

If you're looking to contribute beyond translations, such as updating documentation or enhancing the software by adding features or fixing bugs, the process involves several key steps:
1. **Fork the Repository :**

1. **Fork the Repository:** Start by forking the [MeshCentral](https://github.com/Ylianst/MeshCentral) repository on GitHub. This creates a copy of the repository under your own GitHub account, allowing you to make changes without affecting the original project.
> Start by forking the [MeshCentral](https://github.com/Ylianst/MeshCentral) repository on GitHub.

> This creates a copy of the repository under your own GitHub account, allowing you to make changes without affecting the original project.

2. **Make Your Changes**
- In your forked repository, create a new branch to keep your changes organized. This helps in managing different contributions separately.
- Make the necessary changes in your repository. This could involve updating documentation files or modifying code to add new features or fix bugs.

3. **Review Your Changes:** Before submitting your work, carefully review the changes you’ve made. Check the "Files Changed" section on GitHub to ensure that all modifications are intended and correctly implemented.
> - In your forked repository, create a new branch to keep your changes organized. This helps in managing different contributions separately.

> - Make the necessary changes in your repository. This could involve updating documentation files or modifying code to add new features or fix bugs.

3. **Review Your Changes :**

> Before submitting your work, carefully review the changes you’ve made. Check the "Files Changed" section on GitHub to ensure that all modifications are intended and correctly implemented.

4. **Submit a Pull Request**
- Once your changes are ready and reviewed, submit a pull request (PR) from your branch to the `master` branch of the main MeshCentral repository.
- When creating the pull request, provide a clear and detailed description of what changes have been made and why. This helps maintainers understand the purpose of your contributions.

5. **Wait for Review:** After submitting your pull request, wait for a project maintainer to review your contribution. Review time can vary depending on the complexity of the changes and the availability of the maintainers.
> - Once your changes are ready and reviewed, submit a pull request (PR) from your branch to the `master` branch of the main MeshCentral repository.
> - When creating the pull request, provide a clear and detailed description of what changes have been made and why. This helps maintainers understand the purpose of your contributions.

5. **Wait for Review :**

> After submitting your pull request, wait for a project maintainer to review your contribution. Review time can vary depending on the complexity of the changes and the availability of the maintainers.

6. **Respond to Feedback:** The maintainer may request further modifications or provide feedback on your pull request. Be prepared to make additional changes based on their suggestions to ensure that your contribution meets the project’s standards and requirements.
6. **Respond to Feedback :**

7. **Final Steps:** Once your pull request is approved and merged by a maintainer, your contributions will be incorporated into the MeshCentral project. Congratulations, and thank you for helping improve MeshCentral!
> The maintainer may request further modifications or provide feedback on your pull request. Be prepared to make additional changes based on their suggestions to ensure that your contribution meets the project’s standards and requirements.

7. **Final Steps :**

> Once your pull request is approved and merged by a maintainer, your contributions will be incorporated into the MeshCentral project. Congratulations, and thank you for helping improve MeshCentral!

---

## Contribute to MeshCentral's Multilingual Support
## 🗣️ Contribute to MeshCentral's Multilingual Support

To make MeshCentral multilingual, your contributions are crucial. Follow these steps to translate the interface into various languages.

1. **Remove Local Translations:** Delete `translate.json` from your `meshcentral-data` folder. This file contains your local copy of translations, which may become outdated as new features and texts are added.
1. **Remove Local Translations :**

> Delete `translate.json` from your `meshcentral-data` folder. This file contains your local copy of translations, which may become outdated as new features and texts are added.

2. **Access MeshCentral :**

> Ensure you are logged into MeshCentral.

3. **Open Translation Tool:**

2. **Access MeshCentral:** Ensure you are logged into MeshCentral.
3. **Open Translation Tool:** Visit `https://YOURMESHCENTRALSERVER.COM/translator.htm` to access the translation interface.
4. **Choose a Language:** Select the language you wish to translate from the list provided.
> Visit `https://YOURMESHCENTRALSERVER.COM/translator.htm` to access the translation interface.

5. **Translate Text:** Use the search function or scroll through the list to find text segments you want to translate. Utilize the "show no translations only" checkbox to filter untranslated texts.
6. **Enter Translations:** For each text segment, enter your translation in the bottom box (not the top one) and click `SET (F1)`.
7. **Repeat Translation:** Continue translating by repeating steps 5 and 6 for other texts as desired.
4. **Choose a Language :**

> Select the language you wish to translate from the list provided.

5. **Translate Text :**

> Use the search function or scroll through the list to find text segments you want to translate. Utilize the "show no translations only" checkbox to filter untranslated texts.

6. **Enter Translations :**

> For each text segment, enter your translation in the bottom box (not the top one) and click `SET (F1)`.

7. **Repeat Translation :** Continue translating by repeating steps 5 and 6 for other texts as desired.

8. **Save and Apply Translations**
- Click `SAVE TO SERVER (F3)` to save your translations to `meshcentral-data/translate.json` locally in your MeshCentral server.
- Optionally, click `SAVE TO FILE (F4)` to download the `translate.json` file for offline review or sharing.

9. **Deploy Translations:** Click `TRANSLATE SERVER` and allow some time for the process to complete (approximately 5-15 minutes depending on server specifications). This command line output will indicate when the translation is complete.
![](images/translation-msg-output.png)
> - Click `SAVE TO SERVER (F3)` to save your translations to `meshcentral-data/translate.json` locally in your MeshCentral server.
> - Optionally, click `SAVE TO FILE (F4)` to download the `translate.json` file for offline review or sharing.

9. **Deploy Translations :**

> Click `TRANSLATE SERVER` and allow some time for the process to complete (approximately 5-15 minutes depending on server specifications). This command line output will indicate when the translation is complete.

> ![](images/translation-msg-output.png)

10. **Finalize Changes :**

> It’s crucial to restart MeshCentral to ensure that the translated files are picked up correctly.

11. **Share your translations :**

10. **Finalize Changes:** It’s crucial to restart MeshCentral to ensure that the translated files are picked up correctly.
11. **Share your translations:** Once a language translation is complete, take the latest `translation.json` and share it by emailing it to the maintainer (Ylianst, `[email protected]`) or by submitting it to the MeshCentral GitHub repository via a pull request.
> Once a language translation is complete, take the latest `translation.json` and share it by emailing it to the maintainer (Ylianst, `[email protected]`) or by submitting it to the MeshCentral GitHub repository via a pull request.

---

#### Additional Information:
- If you make any changes to `default.handlebars`, run the translate server to propagate these modifications to the language-specific handlebar files located in `node_modules/meshcentral/views/translations`.
!!! note
Additional Information :

If you make any changes to `default.handlebars`, run the translate server to propagate these modifications to the language-specific handlebar files located in `node_modules/meshcentral/views/translations`.

By following these steps, you help MeshCentral support any language you choose, making it more accessible worldwide. By sharing your translations with us, you also help make these languages available to other users, improving the community and extending the software's reach.
72 changes: 40 additions & 32 deletions docs/docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,60 +4,68 @@

MeshCentral is a full computer management web site. With MeshCentral, you can run your own web server to remotely manage and control computers on a local network or anywhere on the internet. Once you get the server started, create device group and download and install an agent on each computer you want to manage. A minute later, the new computer will show up on the web site and you can take control of it. MeshCentral includes full web-based remote desktop, terminal and file management capability.

For more information, [visit MeshCentral.com](https://www.meshcentral.com/).
For more information, [visit MeshCentral.com](https://meshcentral.com).

## Social Media
## 🌐 Social Media

[YouTube](https://www.youtube.com/channel/UCJWz607A8EVlkilzcrb-GKg/videos)
![YouTube](https://img.icons8.com/color/16/youtube-play.png) [YouTube](https://www.youtube.com/channel/UCJWz607A8EVlkilzcrb-GKg/videos)
![Reddit](https://img.icons8.com/color/16/reddit.png) [Reddit](https://www.reddit.com/r/MeshCentral/)
![Telegram](https://img.icons8.com/color/16/telegram-app.png) [Telegram](https://t.me/meshcentral)
![Discord](https://img.icons8.com/color/16/discord-logo.png) [Discord](https://discord.gg/wF9UT3Vjdj)
![BlueSky](https://img.icons8.com/color/16/internet--v1.png) [BlueSky](https://bsky.app/profile/meshcentral.bsky.social)
![BlogSpot](https://img.icons8.com/color/16/blogger.png) [BlogSpot](https://meshcentral2.blogspot.com/)

[Reddit](https://www.reddit.com/r/MeshCentral/)
## 📚 Documentation

[BlueSky](https://bsky.app/profile/meshcentral.bsky.social)
The [User's Guide](meshcentral/index.md) contains information every administrator should know including usage, the server configuration file, databases, TLS offloading, Lets Encrypt, IP Filtering, Email setup, embedding, server port aliasing, reverse proxy setup, multi factor authentication, branding & terms of use, HashiCorp Vault support, and SSO.

[BlogSpot](https://meshcentral2.blogspot.com/)
The [Installation Guide](install/install.md) has detailed instructions for installing the MeshCentral Server on Windows 8.1, Windows 10, Windows 2012 R2, Amazon Linux 2, Raspberry Pi, Microsoft Azure, Google Cloud, Ubuntu 18, Ubuntu 16 and OpenBSD.

## Documentation
The [Design and Architecture Guide](design/index.md) is a short document that includes information on the design overview, dependencies, source code descriptions of each file, certificates, TLS security, the agent to server handshake, browser to agent relay and WebRTC and the messenger service.

The [User's Guide](meshcentral) contains information every administrator should know including usage, the server configuration file, databases, TLS offloading, Lets Encrypt, IP Filtering, Email setup, embedding, server port aliasing, reverse proxy setup, multi factor authentication, branding & terms of use, HashiCorp Vault support, and SSO.
## 📺 Video Tutorials

The [Installation Guide](install/install2.md) has detailed instructions for installing the MeshCentral Server on Windows 8.1, Windows 10, Windows 2012 R2, Amazon Linux 2, Raspberry Pi, Microsoft Azure, Google Cloud, Ubuntu 18, Ubuntu 16 and OpenBSD.
You can watch many tutorial videos on the [MeshCentral YouTube Channel](https://www.youtube.com/channel/UCJWz607A8EVlkilzcrb-GKg/videos). Here are some essential ones to get you started :

The [Design and Architecture Guide](design) is a short document that includes information on the design overview, dependencies, source code descriptions of each file, certificates, TLS security, the agent to server handshake, browser to agent relay and WebRTC and the messenger service.
**[MeshCentral - Installation](https://www.youtube.com/results?search_query=MeshCentral+Installation)**
Installing MeshCentral on **Windows**, **Linux**, and **macOS**.

## Video Tutorials

You can watch many tutorial videos on the [MeshCentral YouTube Channel](https://www.youtube.com/channel/UCJWz607A8EVlkilzcrb-GKg/videos). Two videos to get started involve installation and basic usages.
**[MeshCentral - Basics](https://www.youtube.com/results?search_query=MeshCentral+Basics)**
Learn how to install the agent and use remote **desktop**, **terminal**, and **file access** features.

Installing MeshCentral on Windows, Linux and macOS.
[MeshCentral - Installation](https://www.youtube.com/watch?v=GsQbWZmRRAU)

Basic Usages including installing the agent and remote desktop, terminal and file access.
[MeshCentral - Basics](https://www.youtube.com/watch?v=D9Q7M7PdTg0)
**[MeshCentral - Two Factor Authentication](https://www.youtube.com/results?search_query=MeshCentral+Two+Factor+Authentication)**
Secure your MeshCentral instance with **two-factor authentication**.

MeshCentral support for two-factor authentication.
[MeshCentral - Two Factor Authentication](https://www.youtube.com/watch?v=luLZKcma9l0)

How to setup MeshCentral with the NGINX reverse proxy.
[MeshCentral - NGINX Reverse Proxy](https://www.youtube.com/watch?v=YSmiLyKSX2I)
**[MeshCentral - NGINX Reverse Proxy](https://www.youtube.com/results?search_query=MeshCentral+NGINX+Reverse+Proxy)**
Configure MeshCentral with an **NGINX reverse proxy** for better security and scalability.

Installing and using the MeshCentral Android agent.
[MeshCentral - Android](https://www.youtube.com/watch?v=wi1HYdW00Bk)

Using MeshCentral Router to port map TCP connections.
[MeshCentral - Basics](https://www.youtube.com/watch?v=BubeVRmbCRM)
**[MeshCentral - Android](https://www.youtube.com/results?search_query=MeshCentral+Android)**
Install and use the **MeshCentral Android agent** for mobile device management.

## Feedback

If you encounter a problem or have a suggestion to improve the product, you may file an [issue report](https://github.com/Ylianst/MeshCentral/issues/)
**[MeshCentral - Basics](https://www.youtube.com/results?search_query=MeshCentral+Router+Port+Mapping)**
Use **MeshCentral Router** to **port map TCP connections** securely.


## 💬 Feedback

If you encounter a problem or have a suggestion to improve the product, you may file an [GitHub Issue](https://github.com/Ylianst/MeshCentral/issues/).<br>
If you are filing a problem report, you should include:

* The version of the software you are using
* The Operating System and version
* The observed output
* The expected output
* Any troubleshooting you took to resolve the issue yourself
* Any other similar reports~~
* The version of the software you are using.
> For example: 1.1.46
* The Operating System and version.
> For example: Debian 12
* Any troubleshooting you took to resolve the issue yourself.
> For example: Reinstalling MeshCentral (including OS)
* Any other similar reports.
> For example: other GitHub issues.
* The observed output.
* The expected output.

If you are having issues with the following other products, you should file a report on their respective issue pages
[MeshAgent](https://github.com/Ylianst/MeshAgent/issues)
Expand Down
16 changes: 16 additions & 0 deletions docs/docs/install/abstract.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Installation

## 🧾 Abstract

These guides are specifically intended to help users install and configure MeshCentral.<br>
Once installed, you can take a look at the MeshCentral user’s guide,<br>
for information on how to configure MeshCentral for your specific use.<br>
In this document, we will look at installing MeshCentral on different operating systems like:

And remember! The `config.json` is case insensitive in its keys.

- 📢 **[Quick-start](./quickstart.md)**

- 🧐 **[Advanced Information](./advanced.md)**

- 🪟 **[Windows-specific](./windows.md)**
Loading
Loading