cPanel
Concord CRM supports cPanel Integration to automate hosting resource management during tenant provisioning. This feature enables the creation of isolated environments for each tenant using your cPanel account - streamlining tasks like subdomain/addon domain setup, database creation, and credential configuration for cPanel-based setups, under a dedicated Integration Settings tab, called "Cpanel".
🧩 This type of automated integration is ideal for effortless server automation without manual intervention and settings. * You can still configure your cPanel-based hosting using the manual way - To do so, please refer to MySQL Root settings section of this documentation.
⚙️ Features and Capabilities
When cPanel Integration is enabled and correctly configured, Concord CRM will automatically perform the following during tenant provisioning:
Subdomain or Addon Domain Creation Creates
tenant1.yourcrm.com(subdomain) orclientdomain.com(addon domain), depending on your setup.MySQL Database Creation Creates a new database with the required prefix via the cPanel API.
Database User Credential Setup Automatically generates and assigns users with the correct permissions.
DNS Routing Configures DNS entries for subdomains or addon domains for seamless access.
🔧 Configuration Guide
You can configure cPanel integration in Concord CRM > SaaS > Settings > Integrations > cPanel.
Available Fields:
cPanel Enabled
Toggle to activate or deactivate cPanel integration.
cPanel Login Domain
The domain used to access cPanel (e.g., cpanel.example.com).
cPanel Port
Port used to communicate with the cPanel API (default: 2083 for SSL).
cPanel Username
The primary username for your cPanel account.
cPanel Password
The password for the cPanel account.
Document Root
Directory path where your CRM is installed. Required when using addon or custom domains.
cPanel DB Prefix
Prefix for tenant databases (usually limited to 8 characters by cPanel).
Addon Domain
Toggle to allow creation of addon domains instead of subdomains.
⚠️ Important Notes
API Access Required: Ensure API access is enabled for your cPanel account.
Manual Setup Fallback: If disabled, Concord CRM will skip automatic domain/database setup. You’ll need to manually handle subdomains or use wildcard DNS.
DB Prefix Limitation: cPanel restricts database prefixes to 8 characters. If your cPanel username exceeds this, only the first 8 characters will be used (e.g.,
ulutfacpanel→ulutfacp).
🧪 Testing the Integration
✅ Create a Test Tenant
Go to Concord CRM > SaaS > Tenants.
Click to create a new test tenant.
The system will automatically:
Create a subdomain or addon domain.
Set up the corresponding database and user.
Configure DNS routing entries.
🔍 Verify Setup
Open the tenant’s subdomain or custom domain in a browser.
Confirm the database was created under cPanel → MySQL Databases.
Ensure SSL is active and DNS has propagated (this can take up to 24 hours).
🛠️ Common Errors & Troubleshooting
Error: “...does not begin with the required prefix...”
Cause: The DB prefix does not match cPanel restrictions.
Solution: Adjust the prefix to match the first 8 characters of your cPanel username.
Issue: SSL Not Active on Subdomains After 24 Hours
Cause: SSL may take time to auto-activate, or DNS may not be pointing correctly.
Solution:
Confirm your hosting provider enables SSL automatically for subdomains/addon domains.
Ensure DNS records point to the correct cPanel server.
Last updated