Skip to content

Commit

Permalink
Doc update - Agent Invitation Customization (#5937)
Browse files Browse the repository at this point in the history
* Update assistant.md

* Email Invite and customization

* Update assistant.md

* Email Invitation pic upload

* point agent invitation customization to assistant.md
  • Loading branch information
adnan29979 authored Mar 24, 2024
1 parent d33aa25 commit 8498414
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 5 deletions.
20 changes: 16 additions & 4 deletions docs/docs/meshcentral/assistant.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,16 +14,28 @@

![agent invite code](images/assistant_agent_code.png)

## Agent Invitation Link

For web page customization:
## Agent Invitation
Click on the 'Invite' button next to the device group name to access it.
### Link Invitation
For link invitation web page customization:

1. Alongside `meshcentral-data` create a folder called `meshcentral-web`
2. Create a `views` folder in it and copy the file `node_modules/meshcentral/views/invite.handlebars` into it.
3. That copy will be served instead of the default one, you can customize as you want.
3. That copy will be served instead of the default one, so you can customize it as you want.

![agent invite code](images/assistant_invitation_link.png)

### Email Invitation
This option will show up if you have a SMTP email server setup with MeshCentral.

For invitation email customization:

1. Alongside `meshcentral-data` create a folder called `meshcentral-web`
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.
3. These copies will be used instead of the default ones, so you can customize them as you want.

![email-invitation](images/email-invitation.png)

## Email notification

You can also get an email notification when someone clicks the "Request Help" button in the Assistant agent.
Expand Down
5 changes: 4 additions & 1 deletion docs/docs/meshcentral/customization.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,10 @@ MeshCentral lets you change the icons for different devices shown in the Web Use
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.

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.
![](images/custom-web-icons.png)
![](images/custom-web-icons.png)

### Customizing Agent Invitation
Agents can be invited by public link or via email. [Click Here](assistant.md#agent-invitation) to see details.

## Agent Branding

Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 8498414

Please sign in to comment.