8. Hosting API docs
WPMU DEV is dedicated to supporting advanced users in every possible way. Our Hosting API Documentation is an ongoing project. Information about new commands will be added here as it becomes available.
8.1 WP-CLI
Copy chapter anchor to clipboardWP-CLI is the command-line interface for WordPress. You can update plugins, configure multisite installations, and much more, without using a web browser. WPMU DEV hosting has an integration module with WP CLI, which will allow you to simplify a few common tasks.
Clear Caches
Command
wp hosting clearcache [type] [URI]
Parameters
Examples
Clears all of the Static Cache.
wp hosting clearcache static
Clears the Static Cache of the homepage. Note that the forward slash in this command must be escaped with a \ as in this example.
wp hosting clearcache static \/
Clears the Static Cache of the given URI. Only the first forward slash in this command needs to be escaped.
wp hosting clearcache static \/sample-page/
Clears the Object Cache.
wp hosting clearcache object
Clears both the Static Cache and the Object Cache.
wp hosting clearcache all
Hosting Backups
Command
wp hosting backup [command] [id]
Parameters
Examples
Lists all available backups for the site.
wp hosting backup list
Trigger a new backup (appears as a manual backup in the Hub).
wp hosting backup create
Restore a backup. Replace xxxxxx with the backup ID found using the list command above.
wp hosting backup restore xxxxxx
See our WPMU DEV Hosting Backups documentation for more information about these backup commands and how to use them.
8.2 SSH
Copy chapter anchor to clipboardThe following SSH commands are available to members for all WPMU DEV hosted sites.
View hosting access logs in terminal
Command
accesslog-view -[days_ago]
Parameters
Examples
View logs for the current day only.
accesslog-view
View one day’s logs from 7 days ago.
accesslog-view -7
This enables you to access the access.log in a live manner, and since the logs themselves are hard to read, it’ll split up various stats.
Note that for the view command, you will need to press q to exit the shell, not ctrl+c like some linux users do.
View hosting access logs as a static file
Command
accesslog-report -[days_ago]
Parameters
Examples
Inlcude logs for the current day only.
accesslog-report
Include one day’s logs from 7 days ago.
accesslog-report -7
This command will create an .html file in the wp-content directory with all the same info as seen when using the view command above.
Note that both of these reports will be for the current day from UTC 00:00 until the time you fire the command.
8.3 CI/CD
Copy chapter anchor to clipboardContinuous integration (CI) and continuous delivery (CD) are supported by WPMU DEV to help you automate the delivery of assets to your hosting droplets. Please be sure to review our Allowed & Disabled Functions & Commands document before proceeding.
8.3.1 Bitbucket
Link to chapter 3Bitbucket Pipelines fires a Docker Instance and runs the commands in this instance. So every command sequence that the user can run manually via SSH can be automated in a Pipeline. More about Pipelines here.
Setup
You will need SSH access with a Public Key without a password so the Pipeline can access it programmatically. You need to create the user under the Hosting > SSH/SFTP tab of your site in your Hub. After that, add the Private/Public Key as well as the Host Fingerprint to the Repository Settings in Bitbucket > Repository Settings > SSH Keys, under Pipelines.
Rsync/SSH Example
This example will run a rsync from the repository to the droplet specified in the SERVER variable using the pipe rsync-deploy. After that, it will run a command to clear the server’s static cache.
8.3.2 Github
Link to chapter 3GitHub Actions fires a Linux container and runs the commands in this instance. So every command sequence that the user can run manually via SSH can be automated in an Action. More about Github actions here.
Setup for synchronizing from a GitHub repository to the droplet
Then add the required secrets to Repository Settings > Secrets and variables > Actions -> Repository secrets following the steps detailed below.
- SSH_PRIVATE_KEY – containing the private key
- SSH_KNOWN_HOSTS – host fingerprint
- SSH_USER – ssh username
- SSH_HOST – ssh destination host
1. To generate public and private keys, run the following command in your local terminal on your computer:
ssh-keygen -t ed25519 -C "wpmu user email" -f ~/.ssh/domain_com
2. Copy the private key with this command, and add it as the SSH_PRIVATE_KEY in your github repo:
pbcopy < ~/.ssh/domain_com
3. Run this command in your terminal and copy the public key content:
pbcopy < ~/.ssh/domain_com.pub
Note that if pbcopy is not available on your system, you can use the cat command to display the keys in the terminal and manually copy the output.
4. Create a new SSH user under the Hosting > SSH/SFTP tab of your site in the Hub, select Public Key, and paste in the public key content you just copied. Set the Path Restriction and Environment as needed.
5. Add the username of the SSH user you just created in your Hub as the SSH_USER in your github repo.
6. Copy the site name (connection address) from Hosting > SSH/SFTP and set it as SSH_HOST in your github repo.
7. Finally, run this command and paste the results as the SSH_KNOWN_HOSTS in your github repo:
ssh-keyscan -t ed25519 site-id.tempurl.host
Rsync/SSG
This example will run a rsync from the repository to the droplet. After that, it will run a command to clear the server's static cache. This action will run on every push.
Setup for publishing to a GitHub repository from the droplet
You will need SSH access. Create the SSH user under the Hosting > SSH/SFTP tab of your site in your Hub.
You also need to create an SSH key pair. You can create one by using the ssh-keygen command. Once created, you can view the public key using cat ~/.ssh/id_rsa.pub
Add the public key to GitHub > Settings > SSH and GPG keys.
To connect your GitHub repository to your droplet, you can use the commands below:
We highly recommend excluding any files that include credentials, such as the wp-config.php file.
8.4 Get Support
Copy chapter anchor to clipboardIf you still have questions or need assistance after reading this document, please don’t hesitate to contact our support superheroes using the available options under the Support tab in your Hub or via the Support tab in your WPMU DEV Dashboard.
