Installation

The module is installed in the same way as other WordPress modules involving two steps:

1. Add the source files to the WordPress server.
2. Enable the plugin in WordPress.

Source files

WordPress plugin repository

This plugin is available from the WordPress plugin repository and so can be installed as follows:

1. Navigate to the Plugins page of the Administrator dashboard.
2. Click on the Add New button.
3. Enter LTI Tool as the Keyword.
4. Click on the Install Now button for the LTI Tool plugin.

Repeat the above steps to install the ceLTIc LTI Library plugin and activate it once installed.

Using Composer

The source files can be installed on the WordPress server using composer:

1. Log into the WordPress server.
2. Navigate to the wp-content/plugins directory of the WordPress installation.
3. Run the command composer create-project celtic/wordpress-lti lti.

Manually

Alternatively the source files and dependencies can be added manually in one of the following ways:

1. Extract the source files from this repository into a directory named lti within the plugins area of your WordPress instance and follow the manual instructions in the LTI class library documentation for installing the LTI library and its dependencies; or
2. Use the lti.zip file available from the project site in OSCELOT to add the plugin using the WordPress admin interface.

Enable the plugin

1. Log into WordPress as an administrator.
2. Navigate to the Admin Dashboard (for the network when using a multisite instance of WordPress).
3. Select the Activate option on the Plugins page to enable the module.

Once enabled, the module will automatically create a set of tables in the WordPress database and a new menu option named LTI Platforms will appear on the dashboard menu.

Updating the plugin

From Version 1

If you already have version 1 of the plugin installed, then it is possible to upgrade to version 2 as follows:

1. Remove the files from the existing plugins/lti-tool directory.
2. Install the new source files (see above).
3. Log into WordPress as an administrator.
4. Navigate to the Admin Dashboard.
5. Select the Deactivate option on the Plugins page to disable the module.
6. Select the Activate option on the Plugins page to enable the module (which will create the new database tables).
7. Migrate the data from the old tables by running the migration script (note that the script assumes a table name prefix of wp_; edit the file if your system is using a different value).
8. Optionally remove the old database tables; e.g.:

DROP TABLE wp_lti_user;
DROP TABLE wp_lti_nonce;
DROP TABLE wp_lti_share_key;
DROP TABLE wp_lti_context;
DROP TABLE wp_lti_consumer;

From Version 2

Version 3 of the plugin involves a change in its slug from lti to lti-tool and so the upgrade involves a few additional steps:

1. Deactivate the old LTI plugin.
2. Install the new LTI Tool plugin (see above).
3. Enable the new LTI Tool plugin (see above).

The settings for the old plugin will be automatically migrated to the new plugin. The message URLs will now contain lti-tool but the old form containing lti is still supported for backward compatibility.

The old plugin may be deleted from WordPress but ensure that the Delete data on uninstall? option is NOT selected before doing so.

Removing the plugin

To completely remove the plugin from the WordPress installation use the Deactivate option on the Plugins page in the Admin Dashboard, and then select the Delete option for the plugin. To permanently remove the data created by the plugin from the WordPress instance, ensure that the following option has been checked before it is deactivated:

• Delete data on uninstall?

This will remove the LTI tables from the database as well as the plugin option settings.