Skip to content

Commit b85563d

Browse files
marcusquinnsuperdav42
marcusquinn
and
superdav42
authored
Update documentation links and add hosting integration docs (#66)
* Update documentation links to GitHub wiki * Add host provider integration wiki pages --------- Co-authored-by: David Stone <david@nnucomputerwhiz.com>
1 parent 385580c commit b85563d

32 files changed

Lines changed: 879 additions & 51 deletions

‎.wiki/Closte-Integration.md‎

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
# Closte Integration
2+
3+
## Overview
4+
Closte is a managed WordPress hosting platform built on Google Cloud infrastructure. This integration enables automatic domain syncing and SSL certificate management between WP Multisite WaaS and Closte.
5+
6+
## Features
7+
- Automatic domain syncing
8+
- SSL certificate management
9+
- Wildcard domain support
10+
- No configuration needed if running on Closte
11+
12+
## Requirements
13+
The following constant must be defined in your `wp-config.php` file if you're using Closte:
14+
15+
```php
16+
define('CLOSTE_CLIENT_API_KEY', 'your_api_key');
17+
```
18+
19+
This constant is typically already defined if you're hosting on Closte.
20+
21+
## Setup Instructions
22+
23+
### 1. Verify Your Closte API Key
24+
25+
If you're hosting on Closte, the `CLOSTE_CLIENT_API_KEY` constant should already be defined in your `wp-config.php` file. You can verify this by checking your `wp-config.php` file.
26+
27+
### 2. Enable the Integration
28+
29+
1. In your WordPress admin, go to WP Multisite WaaS > Settings
30+
2. Navigate to the "Domain Mapping" tab
31+
3. Scroll down to "Host Integrations"
32+
4. Enable the Closte integration
33+
5. Click "Save Changes"
34+
35+
## How It Works
36+
37+
When a domain is mapped in WP Multisite WaaS:
38+
39+
1. The integration sends a request to Closte's API to add the domain to your application
40+
2. Closte automatically handles SSL certificate provisioning
41+
3. When a domain mapping is removed, the integration will remove the domain from Closte
42+
43+
The integration also works with the DNS check interval setting in WP Multisite WaaS, allowing you to configure how frequently the system checks for DNS propagation and SSL certificate issuance.
44+
45+
## Domain Record Creation
46+
47+
This integration ensures that when a site is created or duplicated, a domain record is automatically created. This is particularly important for the Closte integration, as the domain record creation triggers the Closte API to create the domain and SSL certificate.
48+
49+
## Troubleshooting
50+
51+
### API Connection Issues
52+
- Verify that your Closte API key is correct
53+
- Ensure that your Closte account has the necessary permissions
54+
55+
### SSL Certificate Issues
56+
- Closte may take some time to issue SSL certificates (usually 5-10 minutes)
57+
- Verify that your domains are properly pointing to your Closte server's IP address
58+
- Check the DNS records for your domain to ensure they're correctly configured
59+
60+
### Domain Not Added
61+
- Check the WP Multisite WaaS logs for any error messages
62+
- Verify that the domain is not already added to Closte
63+
- Ensure that your domain's DNS records are properly configured
64+
65+
### DNS Check Interval
66+
- If SSL certificates are taking too long to issue, you can adjust the DNS check interval in the Domain Mapping settings
67+
- The default interval is 300 seconds (5 minutes), but you can set it as low as 10 seconds for faster checking during testing

‎.wiki/Cloudflare-Integration.md‎

Lines changed: 92 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
1+
# Cloudflare Integration
2+
3+
## Overview
4+
Cloudflare is a leading content delivery network (CDN) and security provider that helps protect and accelerate websites. This integration enables automatic domain management between WP Multisite WaaS and Cloudflare, particularly for subdomain multisite installations.
5+
6+
## Features
7+
- Automatic subdomain creation in Cloudflare
8+
- Proxied subdomain support
9+
- DNS record management
10+
- Enhanced DNS record display in the WP Multisite WaaS admin
11+
12+
## Requirements
13+
The following constants must be defined in your `wp-config.php` file:
14+
15+
```php
16+
define('WU_CLOUDFLARE_API_KEY', 'your_api_key');
17+
define('WU_CLOUDFLARE_ZONE_ID', 'your_zone_id');
18+
```
19+
20+
## Setup Instructions
21+
22+
### 1. Get Your Cloudflare API Key
23+
24+
1. Log in to your Cloudflare dashboard
25+
2. Go to "My Profile" (click on your email in the top-right corner)
26+
3. Select "API Tokens" from the menu
27+
4. Create a new API token with the following permissions:
28+
- Zone.Zone: Read
29+
- Zone.DNS: Edit
30+
5. Copy your API token
31+
32+
### 2. Get Your Zone ID
33+
34+
1. In your Cloudflare dashboard, select the domain you want to use
35+
2. The Zone ID is visible in the "Overview" tab, in the right sidebar under "API"
36+
3. Copy the Zone ID
37+
38+
### 3. Add Constants to wp-config.php
39+
40+
Add the following constants to your `wp-config.php` file:
41+
42+
```php
43+
define('WU_CLOUDFLARE_API_KEY', 'your_api_token');
44+
define('WU_CLOUDFLARE_ZONE_ID', 'your_zone_id');
45+
```
46+
47+
### 4. Enable the Integration
48+
49+
1. In your WordPress admin, go to WP Multisite WaaS > Settings
50+
2. Navigate to the "Domain Mapping" tab
51+
3. Scroll down to "Host Integrations"
52+
4. Enable the Cloudflare integration
53+
5. Click "Save Changes"
54+
55+
## How It Works
56+
57+
### Subdomain Management
58+
59+
When a new site is created in a subdomain multisite installation:
60+
61+
1. The integration sends a request to Cloudflare's API to add a CNAME record for the subdomain
62+
2. The subdomain is configured to be proxied through Cloudflare by default (this can be changed with filters)
63+
3. When a site is deleted, the integration will remove the subdomain from Cloudflare
64+
65+
### DNS Record Display
66+
67+
The integration enhances the DNS record display in the WP Multisite WaaS admin by:
68+
69+
1. Fetching DNS records directly from Cloudflare
70+
2. Displaying whether records are proxied or not
71+
3. Showing additional information about the DNS records
72+
73+
## Important Notes
74+
75+
As of Cloudflare's recent updates, wildcard proxying is now available for all customers. This means that the Cloudflare integration is less critical for subdomain multisite installations than it used to be, as you can simply set up a wildcard DNS record in Cloudflare.
76+
77+
## Troubleshooting
78+
79+
### API Connection Issues
80+
- Verify that your API token is correct and has the necessary permissions
81+
- Check that your Zone ID is correct
82+
- Ensure that your Cloudflare account has the necessary permissions
83+
84+
### Subdomain Not Added
85+
- Check the WP Multisite WaaS logs for any error messages
86+
- Verify that the subdomain is not already added to Cloudflare
87+
- Ensure that your Cloudflare plan supports the number of DNS records you're creating
88+
89+
### Proxying Issues
90+
- If you don't want subdomains to be proxied, you can use the `wu_cloudflare_should_proxy` filter
91+
- Some features may not work correctly when proxied (e.g., certain WordPress admin functions)
92+
- Consider using Cloudflare's Page Rules to bypass the cache for admin pages

‎.wiki/Cloudways-Integration.md‎

Lines changed: 114 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,114 @@
1+
# Cloudways Integration
2+
3+
## Overview
4+
Cloudways is a managed cloud hosting platform that allows you to deploy WordPress sites on various cloud providers like DigitalOcean, AWS, Google Cloud, and more. This integration enables automatic domain syncing and SSL certificate management between WP Multisite WaaS and Cloudways.
5+
6+
## Features
7+
- Automatic domain syncing
8+
- SSL certificate management
9+
- Support for extra domains
10+
- DNS validation for SSL certificates
11+
12+
## Requirements
13+
The following constants must be defined in your `wp-config.php` file:
14+
15+
```php
16+
define('WU_CLOUDWAYS_EMAIL', 'your_cloudways_email');
17+
define('WU_CLOUDWAYS_API_KEY', 'your_api_key');
18+
define('WU_CLOUDWAYS_SERVER_ID', 'your_server_id');
19+
define('WU_CLOUDWAYS_APP_ID', 'your_app_id');
20+
```
21+
22+
Optionally, you can also define:
23+
24+
```php
25+
define('WU_CLOUDWAYS_EXTRA_DOMAINS', 'comma,separated,list,of,domains');
26+
```
27+
28+
## Setup Instructions
29+
30+
### 1. Get Your Cloudways API Credentials
31+
32+
1. Log in to your Cloudways dashboard
33+
2. Go to "Account" > "API Keys"
34+
3. Generate an API key if you don't already have one
35+
4. Copy your email and API key
36+
37+
### 2. Get Your Server and Application IDs
38+
39+
1. In your Cloudways dashboard, go to "Servers"
40+
2. Select the server where your WordPress multisite is hosted
41+
3. The Server ID is visible in the URL: `https://platform.cloudways.com/server/{SERVER_ID}`
42+
4. Go to "Applications" and select your WordPress application
43+
5. The App ID is visible in the URL: `https://platform.cloudways.com/server/{SERVER_ID}/application/{APP_ID}`
44+
45+
### 3. Add Constants to wp-config.php
46+
47+
Add the following constants to your `wp-config.php` file:
48+
49+
```php
50+
define('WU_CLOUDWAYS_EMAIL', 'your_cloudways_email');
51+
define('WU_CLOUDWAYS_API_KEY', 'your_api_key');
52+
define('WU_CLOUDWAYS_SERVER_ID', 'your_server_id');
53+
define('WU_CLOUDWAYS_APP_ID', 'your_app_id');
54+
```
55+
56+
If you have additional domains that should always be included:
57+
58+
```php
59+
define('WU_CLOUDWAYS_EXTRA_DOMAINS', 'domain1.com,domain2.com,*.wildcard.com');
60+
```
61+
62+
### 4. Enable the Integration
63+
64+
1. In your WordPress admin, go to WP Multisite WaaS > Settings
65+
2. Navigate to the "Domain Mapping" tab
66+
3. Scroll down to "Host Integrations"
67+
4. Enable the Cloudways integration
68+
5. Click "Save Changes"
69+
70+
## How It Works
71+
72+
### Domain Syncing
73+
74+
When a domain is mapped in WP Multisite WaaS:
75+
76+
1. The integration retrieves all currently mapped domains
77+
2. It adds the new domain to the list (along with a www version if applicable)
78+
3. It sends the complete list to Cloudways via the API
79+
4. Cloudways updates the domain aliases for your application
80+
81+
Note: The Cloudways API requires sending the complete list of domains each time, not just adding or removing individual domains.
82+
83+
### SSL Certificate Management
84+
85+
After domains are synced:
86+
87+
1. The integration checks which domains have valid DNS records pointing to your server
88+
2. It sends a request to Cloudways to install Let's Encrypt SSL certificates for those domains
89+
3. Cloudways handles the SSL certificate issuance and installation
90+
91+
## Extra Domains
92+
93+
The `WU_CLOUDWAYS_EXTRA_DOMAINS` constant allows you to specify additional domains that should always be included when syncing with Cloudways. This is useful for:
94+
95+
- Domains that are not managed by WP Multisite WaaS
96+
- Wildcard domains (e.g., `*.example.com`)
97+
- Development or staging domains
98+
99+
## Troubleshooting
100+
101+
### API Connection Issues
102+
- Verify that your email and API key are correct
103+
- Check that your server and application IDs are correct
104+
- Ensure that your Cloudways account has the necessary permissions
105+
106+
### SSL Certificate Issues
107+
- Cloudways requires that domains have valid DNS records pointing to your server before issuing SSL certificates
108+
- The integration validates DNS records before requesting SSL certificates
109+
- If SSL certificates are not being issued, check that your domains are properly pointing to your server's IP address
110+
111+
### Domain Not Added
112+
- Check the WP Multisite WaaS logs for any error messages
113+
- Verify that the domain is not already added to Cloudways
114+
- Ensure that your Cloudways plan supports the number of domains you're adding

‎.wiki/GridPane-Integration.md‎

Lines changed: 86 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
1+
# GridPane Integration
2+
3+
## Overview
4+
GridPane is a specialized WordPress hosting control panel built for serious WordPress professionals. This integration enables automatic domain syncing and SSL certificate management between WP Multisite WaaS and GridPane.
5+
6+
## Features
7+
- Automatic domain syncing
8+
- SSL certificate management
9+
- Automatic configuration of SUNRISE constant
10+
11+
## Requirements
12+
The following constants must be defined in your `wp-config.php` file:
13+
14+
```php
15+
define('WU_GRIDPANE', true);
16+
define('WU_GRIDPANE_API_KEY', 'your_api_key');
17+
define('WU_GRIDPANE_SERVER_ID', 'your_server_id');
18+
define('WU_GRIDPANE_APP_ID', 'your_app_id');
19+
```
20+
21+
## Setup Instructions
22+
23+
### 1. Get Your GridPane API Credentials
24+
25+
1. Log in to your GridPane dashboard
26+
2. Go to "Settings" > "API"
27+
3. Generate an API key if you don't already have one
28+
4. Copy your API key
29+
30+
### 2. Get Your Server and Site IDs
31+
32+
1. In your GridPane dashboard, go to "Servers"
33+
2. Select the server where your WordPress multisite is hosted
34+
3. Note the Server ID (visible in the URL or on the server details page)
35+
4. Go to "Sites" and select your WordPress site
36+
5. Note the Site ID (visible in the URL or on the site details page)
37+
38+
### 3. Add Constants to wp-config.php
39+
40+
Add the following constants to your `wp-config.php` file:
41+
42+
```php
43+
define('WU_GRIDPANE', true);
44+
define('WU_GRIDPANE_API_KEY', 'your_api_key');
45+
define('WU_GRIDPANE_SERVER_ID', 'your_server_id');
46+
define('WU_GRIDPANE_APP_ID', 'your_site_id');
47+
```
48+
49+
### 4. Enable the Integration
50+
51+
1. In your WordPress admin, go to WP Multisite WaaS > Settings
52+
2. Navigate to the "Domain Mapping" tab
53+
3. Scroll down to "Host Integrations"
54+
4. Enable the GridPane integration
55+
5. Click "Save Changes"
56+
57+
## How It Works
58+
59+
When a domain is mapped in WP Multisite WaaS:
60+
61+
1. The integration sends a request to GridPane's API to add the domain to your site
62+
2. GridPane automatically handles SSL certificate provisioning
63+
3. When a domain mapping is removed, the integration will remove the domain from GridPane
64+
65+
The integration also automatically handles the SUNRISE constant in your wp-config.php file, which is required for domain mapping to work correctly.
66+
67+
## SUNRISE Constant Management
68+
69+
One unique feature of the GridPane integration is that it automatically reverts the SUNRISE constant in wp-config.php to prevent conflicts with GridPane's own domain mapping system. This ensures that both systems can work together without issues.
70+
71+
## Troubleshooting
72+
73+
### API Connection Issues
74+
- Verify that your API key is correct
75+
- Check that your server and site IDs are correct
76+
- Ensure that your GridPane account has the necessary permissions
77+
78+
### SSL Certificate Issues
79+
- GridPane may take some time to issue SSL certificates
80+
- Verify that your domains are properly pointing to your server's IP address
81+
- Check the GridPane SSL settings for your site
82+
83+
### Domain Not Added
84+
- Check the WP Multisite WaaS logs for any error messages
85+
- Verify that the domain is not already added to GridPane
86+
- Ensure that your domain's DNS records are properly configured

0 commit comments

Comments
 (0)