How do I install Participad?
- Participad requires a separate Etherpad Lite installation. Visit the Etherpad Lite Github repo to download EPL and for information on installation. Note: Participad does not yet support cross-domain installations, so make sure that your Etherpad Lite instance is accessible under the same domain name as your WordPress installation (eg, http://example.com/wp/ and http://example.com/etherpad/).
- Install and activate Participad. You can download Participad manually from the wordpress.org plugin repository, or you can use the auto-installer in your WordPress Dashboard (Plugins > Add New).
- When Participad is activated, you’ll see a notice telling you that the plugin is not yet set up properly. Follow the provided link (or navigate to Settings > Participad) to visit the Participad setup screen.
- Enter your Etherpad Lite URL and API key. The API key can be found in the file
APIKEY.txtin your Etherpad Lite installation directory – it is created automatically when EPL is installed.
- Alternatively, you can set up your EPL connection by defining the
PARTICIPAD_API_KEYconstants in your wp-config.php file. This will disable manual entry of these values on the plugin admin panel, and is an ideal solution for configuring WordPress Multisite installations.
Where does my content live? In Etherpad Lite or WordPress?
Both. Participad works by displaying an EPL iframe inside of WordPress. So when you’re writing using Participad, your content is actually being saved to EPL. However, content is regularly saved back to your WordPress installation. All Participad modules have autosave functionality, which syncs the content of an EPL document back to the corresponding WordPress post at two-minute intervals (you can override this value with the
PARTICIPAD_AUTOSAVE_INTERVALconstant). Moreover, whenever you manually save your work through the WordPress interface – such as by clicking Update on the Edit Post screen, or by clicking Exit Edit Mode on the front end – content is synced from EPL back to WP.
How is my content protected?
Participad uses Etherpad’s “group model” to protect your WordPress content. In a nutshell, each EPL document is placed into an EPL group, so that the only users able to edit that EPL document are those for whom there exists a valid group session. Participad manages the creation of group sessions, so that they’re only created when the WP user really ought to have edit access to the post in question. That means that permissions work just like you’d expect them to: Authors can’t edit each other’s posts while Editors can, etc. Even if you leave your EPL installation publicly accessible (so that new Pads can be created outside of Participad), documents created by Participad are only available to users with the correct session cookies.
Is Participad compatible with WordPress Multisite/Network Mode?
Yes! Participad was designed to work seamlessly on WPMS. If you plan to use a single Etherpad Lite installation for all the sites on your network, you should consider setting your EPL configuration using the
PARTICIPAD_API_KEYconstants; if defined in your wp-config.php file, manual configuration will be disabled in the Dashboard, and config details will automatically be provided for each site where Participad is activated.
What about BuddyPress?
If you’ve got BuddyPress installed on your network, Participad will record Notepad edits in your Activity stream. More BP features are planned for the future.