Skip to content

Installation

Jo Dickson edited this page Feb 5, 2020 · 2 revisions

Navigation


Installation requirements

This plugin is developed and tested against WordPress 4.9.7+ and PHP 5.3.x+.

While this plugin should work against any server running the minimum requirements for WordPress installations, we cannot guarantee compatibility with, or provide support for, installations on non-LAMP stacks (e.g. Windows installations).

Required plugins

These plugins must be activated for UCF RSS Feed Plugin to function properly.

  • n/a

Supported plugins

The plugins listed below are extended upon in this plugin--this may include custom layouts for feeds, additional functionality, etc. These plugins are not technically required on sites running this plugin, and shouldn't be activated on sites that don't require their features. A plugin does not have to be listed here to be compatible with UCF RSS Feed Plugin.

  • n/a

Installation instructions

Before getting started: make sure you've satisfied all the installation requirements, and that any required plugins or recommended plugins that you wish to use are installed and activated.

  1. Install the plugin:**

    • via Github Updater

      This plugin supports installation and updates via the Github Updater plugin. See their documentation for more information on setup and usage. (Requires PHP 5.6.0+)

    • via standard (manual) installation

      Download the plugin .zip file here: https://github.com/UCF/UCF-RSS-Feed-Plugin/archive/master.zip

      Unzip and upload the plugin files to your WordPress instance's wp-content/plugins/ directory.

      Alternatively, upload the .zip file using the WordPress plugins interface directly:

      • On single sites: navigate to Plugins > Add New.
      • On multisite instances: navigate to Network Admin > Plugins > Add New.
    • via WP-CLI

      $ wp plugin install https://github.com/UCF/UCF-RSS-Feed-Plugin/archive/master.zip

      See the WP-CLI docs for more information.

  2. Activate the plugin: from your site's admin, click "Plugins" in the admin menu, find UCF RSS Feed Plugin in the list of plugins, and click "Activate".

  3. Configure the plugin: Navigate to Settings > UCF RSS Feeds, and update any default plugin settings as necessary for your site. See the plugin settings docs for detailed information on available options.

That's it! Now you're ready to start using this plugin.

** Note that this plugin is not deployed to the WordPress plugin directory, and therefore will not notify you of plugin updates, unless you are using Github Updater. You are responsible for keeping your copy of this plugin up-to-date with bugfixes and other new releases.

Clone this wiki locally