Adding note about reinstall https://github.com/Ylianst/MeshCentral/issues/4741
silversword411 committed
Nov 10, 2022 at 08:05 UTC
4c6d3437db0913a8aede6abb71231c11e03ba0f5
2 files changed
+56
-1
docs/docs/meshcentral/faq.md
+3
-1
@@ -46,5 +46,7 @@ You're sure you're typing in everything right, giving it 2FA code and can't logi
46
47
# Branding and Customisation
48
49
-You can brand and customise MeshCentral almost as much as you like without delving into the code, a few changes in the config.json file and uplaoding images can change the way your system looks. Read more [here](https://ylianst.github.io/MeshCentral/meshcentral/#branding-terms-of-use)
49
+You can brand and customise MeshCentral almost as much as you like without delving into the code, a few changes in the config.json file and uploading images can change the way your system looks. Read more [here](https://ylianst.github.io/MeshCentral/meshcentral/#branding-terms-of-use)
50
51
+!!!note
52
+ You will need to reinstall the agent for agent customizations to take effect.
docs/docs/meshcentral/index.md
+53
@@ -1258,6 +1258,59 @@ You can also customize the Agent to add your own logo.
1258
1259
1260
1261
+```json
1262
+ "agentCustomization": {
1263
+ "displayName": {
1264
+ "type": "string",
1265
+ "default": "MeshCentral Agent",
1266
+ "description": "The name of the agent as displayed to the user."
1267
+ },
1268
+ "description": {
1269
+ "type": "string",
1270
+ "default": "Mesh Agent background service",
1271
+ "description": "The description of the agent as displayed to the user."
1272
+ },
1273
+ "companyName": {
1274
+ "type": "string",
1275
+ "default": "Mesh Agent",
1276
+ "description": "This will be used as the path to install the agent, by default this is 'Mesh Agent' in Windows and 'meshagent' in other OS's."
1277
+ },
1278
+ "serviceName": {
1279
+ "type": "string",
1280
+ "default": "Mesh Agent",
1281
+ "description": "The name of the background service, by default this is 'Mesh Agent' in Windows and 'meshagent' in other OS's but should be set to an all lower case, no space string."
1282
+ },
1283
+ "installText": {
1284
+ "type": "string",
1285
+ "default": null,
1286
+ "description": "Text string to show in the agent installation dialog box."
1287
+ },
1288
+ "image": {
1289
+ "type": "string",
1290
+ "default": null,
1291
+ "description": "The filename of a image file in .png format located in meshcentral-data to display in the MeshCentral Agent installation dialog, image should be square and from 64x64 to 200x200."
1292
+ },
1293
+ "fileName": {
1294
+ "type": "string",
1295
+ "default": "meshagent",
1296
+ "description": "The agent filename."
1297
+ },
1298
+ "foregroundColor": {
1299
+ "type": "string",
1300
+ "default": null,
1301
+ "description": "Foreground text color, valid values are RBG in format 0,0,0 to 255,255,255 or format #000000 to #FFFFFF."
1302
+ },
1303
+ "backgroundColor": {
1304
+ "type": "string",
1305
+ "default": null,
1306
+ "description": "Background color, valid values are RBG in format 0,0,0 to 255,255,255 or format #000000 to #FFFFFF."
1307
+ }
1308
+ }
1309
+ ```
1310
+
1311
+!!!note
1312
+ You will need to reinstall the agent for agent customizations to take effect.
1313
+
1314
### Terms of use
1315
1316
You can change the terms of use of the web site by adding a “terms.txt” file in the “meshcentral-data” folder. The file can include HTML markup. Once set, the server does not need to be restarted, the updated terms.txt file will get used the next time it’s requested.