Skip to content

How-to guide

Installing the WordPress plugin

The plugin is free and lives on GitHub — it is not on wordpress.org yet. One install covers the waiting-list form on a Group site and Find a Group / events sync on a District site.

  1. Download the plugin from GitHub

    Open the Scout Suite WordPress plugin on GitHub. Use Code → Download ZIP, or grab a release zip if one is listed.

    The installable plugin is the scout-suite-waiting-list folder inside that download — not the whole repo wrapper. Zip that folder on its own if WordPress will upload a zip (name it something like `scout-suite-waiting-list.zip`).

  2. Upload and activate on WordPress

    In wp-admin go to Plugins → Add New → Upload Plugin, choose the zip, then Install Now. Or copy the `scout-suite-waiting-list` folder into `wp-content/plugins/` over SFTP.

    On the Plugins screen, activate Scout Suite. You need WordPress 6.0+ and PHP 7.4+.

  3. Enter the Org ID and API key

    Open Settings → Scout Suite. Org ID is the District, County, or Group id from Scout Suite URLs (for example the id in `/groups/{id}/…`).

    For directory or events sync, paste an API key from Developer → API keys — create one that is not limited to a single Group if this is a District site. Minting keys is covered in Using the API. The waiting-list form can run without a key; sync cannot.

  4. Then pick what the site should do

    Group waiting-list form on a page: Waiting list on the Group website.

    District Find a Group and What's on from Scout Suite data: Your Group on the district website.

Setup

More in this topic

Districts, WordPress, OSM, SSO, the API, privacy mode, and the assistant.