Automated Agent Deployments
A
Written by Aaron Phillips
Updated over a week ago

If automating Monarx Agent deployments of new cPanel & WHM or Linux Servers, WHMCS will handle most of the backend work, but we recommend the following:

monarx-agent.conf

The monarx-agent.conf has settings that need pre-populated before the Monarx Agent install takes place.

/etc/monarx-agent.conf 

The client_id and client_secret are required for the agent to communicate with the cloud. It will not run without these set properly. These values are set automatically if you download this file from the Monarx web application.

If you downloaded this file from the Monarx web application it will have any custom configuration settings in it other than the client_id and client_secret.

client_id =
client_secret =


UNCOMMENT ONE OF THE user_base DIRECTIVES BELOW, OR ADD YOUR OWN
BE SURE TO HAVE A virtfs EXCLUSION *AFTER EACH* user_base DIRECTIVE

user_base = /home/ ; common for cPanel environments
exclude_users = ^virtfs$ ; matches /home/virtfs

Agent Tags

Tags are used to label agents for any number of purposes. You can tag your agents by environment / server type, brand, etc. Tags are also used to apply the proper billing scheme to each agent.

An agent can have any number of tags, which will show up in the Agents module in the web app, and can be used in API query filters. Multiple tags can be specified in a single directive, separated by commas. Also, multiple tag directives are supported, with all of the specified tags accumulated.

tags = Upsell, whmcs-shared-upsell ; for cPanel & WHM
tags = Upsell, whmcs-server-upsell ; for Linux Servers

; example tags to consider
;tags = shared ; env type: or "vps", "dedi", etc.
;tags = hostingbrand1 ; tag by brand
;tags = customer1 ; tag by customer (for vps, dedi, ...)
;tags = myserverid1 ; tag with your own ids
; note you can always identify agents by

Did this answer your question?