Perfex SaaS Module allows full integrations with cPanel from database to subdomain and custom domain automation since v0.1.2 beta.
Capabilities: #
- Creating a single database: give you the “cPanel” database scheme option from package settings or when creating a new instance as an admin, allowing creating a separate database and user for each tenant.
- Creating a subdomain for each tenant: when the addon domain is enabled on the cPanel integration settings, all tenants on the package(s) with subdomain featured enabled will have a subdomain created through the cpanel as an addon domain during deployment of the instance. This saves you from needing Wildcard SSL/DNS or its maintenance
- Setup custom domain for each tenant (beta): when the addon domain on cPanel integration settings is enabled, this module attempts to add a custom domain DNS entry for each tenant onto the cPanel account. This requires that the customer’s custom domain is pointing at your cpanel server already preferably by forwarding his nameservers for the custom domain to your cPanel server.
Note: it might take a while for the addon domain SSL to be effective, depending on the server, but mostly within a few minutes. If the subdomains are not having active SSL after 24 hours, this might have been disabled for your cPanel and we suggest you reach out to your host provider.
Requirements: #
This feature requires that your setup is running on cPanel. We confirm this internally by checking the existence of “/usr/local/cpanel”.
We encourage that the CRM be set up on the main domain of the cPanel account but this is not a requirement.
Configurations #
Go to SaaS > Settings > Integrations and ensure cPanel integration is in view.
Enable the cPanel functionalities by toggling the switch close to the “Enabled ?” field. Then fill the form appropriately. We have provided some aid, kindly hover on the question mark “?” icon close to each field for a hint or guide about each field.
The “Password” field can be your cPanel login password and an API Token.
Note that, if you will be using a subdomain and custom domain feature, you are required to use a cPanel login password and not an API token.
The “Primary domain” field is the cPanel primary main domain, this is necessary when the Addon domain feature is enabled. This domain might not be the same as your CRM installation domain
The “Document root” field is essential for addon domains (subdomain and custom domain for each tenant). Ensure this is the right installation base path for your CRM setup
Common errors #
‘…does not begin with the required prefix…’
- The ‘DB name and User Prefix‘ field represents your database’s prefix and is typically restricted to 8 characters in most cPanel API setups.
- In the majority of cases, this will correspond to your username.
- If you encounter an error message referencing the prefix, such as ‘…does not begin with the required prefix’, it is likely because your username exceeds 8 characters. For instance, if your username is longer than 8 characters, such as ‘ulutfacpanel,’ then your prefix will be the first 8 characters of the username, namely ‘ulutfacp’.
