Skip to content

Getting Started

This section will help you to install the Collaboration plugin on your WordPress site.

Server Requirements

Collaboration has a few system requirements. Of course, modern hosting satisfies all of these requirements, so it's highly recommended that you use modern hosting to run the Collaboration.

You will need to make sure your server meets the following requirements:

  • PHP 7.4+
  • WordPress 5.6+

Step. 1: Install the plugin

You can easily install the Collaboration plugin by uploading a zip archive of the plugin from your local computer through the Plugins admin screen.

If you have any issues or confusion about how on installing a plugin, WordPress has a comprehensive guide on how to install a plugin that will help you out.

Once installed, you can activate the plugin by clicking on the "Activate" link in the Plugins admin screen.

Step. 2: Using Pusher Channel service

The Collaboration plugin uses the Pusher Channel service on its core, allowing it to achieve real-time experience in economic and easy to setup.

To enable the real-time feature, you need a Pusher Channel App Keys.

  1. Go to the Pusher Channel website and create a new App.
  2. Click on the "Create App" button.
  3. Enter a name for your App and the cluster that you want to use.
  4. Click on the "Create app" button.
  5. Navigate to the "App Settings" tab and tick the "Enable client events" checkbox.
  6. Navigate to the "App Keys" tab and save the detail.
  7. On your WordPress site, use the detail to fill the form on the Collaboration plugin setting page.

TIP

You can reuse the Pusher Channel App Keys on multiple WordPress installations.

WARNING

On cloning/staging site, reset the Site GUID from the plugin setting page.

What's next?

By now, your Oxygen editor should have synced data across multiple tabs and browsers.