This quick-start guide is appropriate for users who meet the following criteria:
If you do not meet these two criteria you can choose on of the following options:
If you choose to continue with this quick-start, here are the seven groups of actions you will perform:
Before proceeding with installation, please read the full requirements here. If the webserver running the website where WPCD will be installed does not meet all the requirements (especially the ones for timeouts and firewall/REST API), deploying servers and sites will fail.
Installing the plugin is performed just like any other WordPress plugin:
Optional: Install Premium Providers
If you have a license for one or more of our premium Cloud providers you should upload those plugins as well and activate them. The onboarding wizard will work with the following premium providers if they are activated:
At this point the plugin(s) are installed and ready to connect to your Cloud Provider.
But first though, you should add an encryption key to wp-config.php.
Once the plugin is installed and activated you should add an encryption key to your wp-config.php file. If you don’t do this now, api keys, private keys and other sensitive data will be stored without encryption in your database. If you add the key later you will have to re-enter your api keys and private key information.
define('WPCD_ENCRYPTION_KEY', 'your very long encryption key goes here');
Note: All the possible wp-config.php settings are documented on this page.
Create an API key at your cloud provider (DigitalOcean, Linode etc.) You can do this inside your Cloud Provider’s dashboard.
For DigitalOcean, use the API menu option on the left side of the screen after you login to your account.
Please make sure you create a read-write key/token.
When you log into WPCLOUDDEPLOY for the first time you will see a green banner at the top of the screen. This will allow you to invoke an easy on-boarding process as long as you are deploying your new servers into the DigitalOcean (or Linode/Vultr/UpCloud/Hetzner) cloud.
If for some reason you are not deploying servers to DigitalOcean (or Linode/Vultr/UpCloud/Hetzner) and you have one of our other premium providers (eg: AWS, Azure, etc.), you should use our generic quick start guide:
Use our Generic Quick Start Guide
Otherwise, click the button in the green banner to get started and you’ll see the first page of the on-boarding wizard.
Because you should have already added an encryption key you can just click the green CONTINUE button to move to the next step:
As mentioned earlier, you can get your API Key from your Cloud Provider’s dashboard – use the API Menu option to generate a key. Make sure the key has WRITE permissions!
Enter the api key and click the green CONTINUE button to move to the next step where you will generate your SSH key-pair:
We use SSH keys instead of passwords to access your servers. This step will allow us to generate a unique pair for you, submit the public portion to your cloud provider and securely store the private portion in WPCD.
Just click the green CONTINUE button to proceed.
At the next step click the green CONTINUE button to complete the process and go to the servers list.
WPCD depends on using SSH to connect to your servers. But the PHP and Web Server processes have short timeouts that need to be increased. It they’re not increased then the amount of time that a connection to one of your managed servers can remain open will be 30 seconds or less – not enough time to handle certain longer running tasks.
We have added instructions to the WPCLOUDDEPLOY->SETTINGS screen to help you increase your timeouts on PHP and various web servers. Please make sure you review these and update your server configurations.
If you place your WPCD server / site behind a proxy such as CloudFlare then you need to make sure that the following folders are white-listed so that they can be accessed by your new server:
This folder just contains just text files in there that happen to contain our bash scripts. These scripts are part of what makes stuff happen – such as installing WordPress on your server.
If you run a firewall plugin on your WPCD server you should also make sure the folder is always available to the outside world (or at least every server IP you’re managing).
You will also need to white-list the call-back endpoints – they all start with or contain /wp-json/wordpress-app. For this, we would recommend that you whitelist your individual server ip addresses instead of leaving it open.
To create your first server:
Important: Please choose a server size with at least 1 GB RAM. DigitalOcean offers droplets with as little as 512MB but those will not work for WPCD WordPress servers.
After a server is provisioned you will be returned to the servers list where you will see the new server available for use. You will also see a message in the health column about CALLBACKS being unavailable – you can ignore that message because they will eventually be installed in the background.
To create your first site after creating your first server: