Skip to content

Automattic/wpcloud-station

Repository files navigation

WP Cloud Station

WP Cloud Station is a client plugin to manage WP Cloud sites.

Getting Started

WP Cloud Station plugin and theme can be installed on any WordPress site.

Our plugin provides a custom site type for managing your WP Cloud sites as well as many hooks for integrating with your own site.

Our theme is block-based and easy to configure and edit.

Plugin

  1. Upload wpcloud-station to the /wp-content/plugins/ directory.
  2. Activate the plugin through the 'Plugins' menu in WordPress.
  3. Navigate to /wp-admin/admin.php?page=wpcloud_admin_settings.
  4. Save your WP Cloud Client Name and API Key, as well as a default primary Domain.
  5. Make note of your IP Address at the bottom and contact your WP Cloud representative to add the IP's.

Theme

If you would like to use our block-based theme:

  1. Upload wpcloud-station to the /wp-content/themes/ directory.
  2. Activate the theme through the 'Themes' menu in WordPress.
  3. Navigate to Site Editor to alter.

Reporting Issues and Feature Requests

Issues and feature requests can be submitted in GitHub Issues.

Contribute

We welcome contributions from the community. If you would like to contribute, please see Contributing.

Code of Conduct

Local Setup

Docker

  • Copy the docker-compose.yml-example file to docker-compose.yaml
  • Update the environment variable WP_CLOUD_API_KEY to your WP Cloud API key.
  • Run docker compose up

wp-env

  • run wp-env start
  • Note: you will need to add your api key to the WP Cloud settings page

Frequently Asked Questions

  • Can I use WP Cloud Station plugin on any site?

    Yes, WP Cloud Station plugin can be installed on any existing WordPress site.

  • How much does it cost?

    WP Cloud Station plugin and theme are free. You will need a client set up and an agreement with Automattic to create new sites.

    Please contact us for more information.

  • Can I integrate WP Cloud with my own site?

    Yes! We provide a custom post type wpcloud_site to manage your sites, but we also integrate with native WordPress architecture include REST API, as well as providing numerous hooks to integrate with actions and callbacks.