Doc update - Agent Invitation Customization (#5937)
* Update assistant.md * Email Invite and customization * Update assistant.md * Email Invitation pic upload * point agent invitation customization to assistant.md
adnan29979 committed
Mar 25, 2024 at 00:32 UTC
8498414ae9994c575805466407cb6fc1e8d84238
3 files changed
+20
-5
docs/docs/meshcentral/assistant.md
+16
-4
@@ -14,16 +14,28 @@
14
15
16
17
-## Agent Invitation Link
18
-
19
-For web page customization:
17
+## Agent Invitation
18
+Click on the 'Invite' button next to the device group name to access it.
19
+### Link Invitation
20
+For link invitation web page customization:
21
22
1. Alongside `meshcentral-data` create a folder called `meshcentral-web`
23
2. Create a `views` folder in it and copy the file `node_modules/meshcentral/views/invite.handlebars` into it.
23
-3. That copy will be served instead of the default one, you can customize as you want.
24
+3. That copy will be served instead of the default one, so you can customize it as you want.
25
26
27
28
+### Email Invitation
29
+This option will show up if you have a SMTP email server setup with MeshCentral.
30
+
31
+For invitation email customization:
32
+
33
+1. Alongside `meshcentral-data` create a folder called `meshcentral-web`
34
+2. Create an `emails` folder in it and copy the files `node_modules/meshcentral/emails/mesh-invite.txt` and `node_modules/meshcentral/emails/mesh-invite.html` into it.
35
+3. These copies will be used instead of the default ones, so you can customize them as you want.
36
+
37
+
38
+
39
## Email notification
40
41
You can also get an email notification when someone clicks the "Request Help" button in the Assistant agent.
docs/docs/meshcentral/customization.md
+4
-1
@@ -57,7 +57,10 @@ MeshCentral lets you change the icons for different devices shown in the Web Use
57
To update device icons, you need to edit these files: `meshcentral-web/public/images/webp/iconsXX.webp` (`icons16.webp`, `icons32.webp`, `icons50.webp`, `icons100.webp`), and `meshcentral-web/public/images/iconsXX.png` (`icons16.png`, `icons32.png`, `icons50.png`, `icons64.png`, `icons100.png`) and the corresponding `meshcentral-web/public/images/icons256-X-1.png`. Make sure to keep the resolution of these files as it is.
58
59
By following these steps, you can customize any icon in MeshCentral. Just find and change the corresponding image files in the `meshcentral-web/public/images` folder. Similarly, you can also move other folders from `node_modules/meshcentral` to `meshcentral-web` while keeping the original folder structure. This allows you to modify other parts of MeshCentral too, like the `.handlebars` templates for the web interface. Simply copy files from `node_modules/meshcentral/views` to `meshcentral-web/views` and make your changes in `meshcentral-web`. This lets you match MeshCentral's look to your company's brand or your own style.
60
-
60
+
61
+
62
+### Customizing Agent Invitation
63
+Agents can be invited by public link or via email. [Click Here](assistant.md#agent-invitation) to see details.
64
65
## Agent Branding
66
docs/docs/meshcentral/images/email-invitation.png
Binary files /dev/null and b/docs/docs/meshcentral/images/email-invitation.png differ