Submit a ticket My Tickets
Welcome
Login

Power Tool: Bouncer

Plugin name: Bouncer (local_bouncer)

Latest version: 4.1.0

Supports: Moodle Workplace 4.1, 4.2, 4.3, 4.4

Non-Core Dependencies: None


Introduction

Power Tools are plugins based on custom solutions for Moodle LMS and Workplace that are available in a subscription service that ensures regular maintenance and upgrade support. If you have any questions or would like to request a Power Tools subscription, please reach out in the Help Desk.


Usage

Bouncer (local_bouncer) is a custom local plugin that whitelists IP addresses based on tenants. The plugin allows you to upload IP addresses and tenants manually or via a .csv file. When IP addresses are added to the Bouncer whitelist report, only users logging in from the specified IP addresses will be able to gain access to the site. If the report does not contain any IP addresses users will be able to log in from anywhere using their login credentials.



Key concepts

Manually adding IP Addresses

  1. Navigate to Site Admin > Plugins > Local > Bouncer whitelist report.

Local plugins options list with Bouncer whitelist report option highlighted.


  1. Manually add IP addresses by selecting the Add button.

On the Bouncer whitelist report administration settings, click the Add button


  1. In the Create whitelist entry modal form that appears, locate the desired tenant by typing the tenant name in the search drop-down menu then selecting it from the list.On the Create whitelist entry modal, use the search box.


  1. Enter the whitelisted IP address. (Note: that fields with an exclamation mark inside a red circle are required and must be filled in.)




Bulk Upload of IP Addresses

  1. Begin by creating the .csv file using ‘tenant site short name’ and ‘ip address’ as the column headings.

Sample csv file with 'tenant site short name' and 'ip address' column headings.


  •  A sample file (whitelist.csv) file is available for download from your site by going to Site Admin > Plugins Local > Bouncer whitelist settings>Bulk.

Manager Bouncer settings administration settings with an area to upload an file and save it with example file highlighted


  1. The tenant short name can be found or added by opening the Workplace launcher in the upper right corner of the window then selecting All tenants.

Click the Workplace Launcher “waffle” icon, followed by “All tenants” in the Global section.


  1. Select the tenant name from the list of tenants.

A list of tenants on the site that are clickable links in the “Tenant name” column.


  1. Select the Details tab. Enter or copy the site short name to use in the file.

The Tenant Details modal with fields for Tenant Name, Site Name, Site short name, ID number, and a choice of Login URL.


  1. In the file enter the IP addresses.

  2. Save the file as .csv to upload.

  3. After preparing the csv upload file, navigate to Site Admin > Plugins Local > Bouncer whitelist settings.

  4. Select the Bulk button.

Bouncer whitelist report plugin administration settings with Bulk button highlighted.


  1.  Drag and drop the csv upload file you just created into the whitelist csv area then select the Save changes button.

Manager Bouncer settings administration settings with an area to upload an file and save it.


  1. Navigate to Site Admin > Plugins > Local > Bouncer whitelist report.  The list of addresses with associated tenant name will display in the table.

Bouncer Whitelist Report administration settings area with two IP addresses listed for “testtenant.” Actions of Edit and Delete are available for each IP address entry.


Once it is listed in the table above, any user in that tenant will only have access if accessing from one of the IPs listed. If the user tries to access the site from an IP not specified, they will not gain access.


The IP addresses can be edited or deleted from this report using the buttons in the Actions column.



Did you find it helpful? Yes No

Send feedback
Sorry we couldn't be helpful. Help us improve this article with your feedback.