Getting Started Omeka Classic plugin

Installation

Requirements

  • Omeka Classic 3.1 or later. Traffic Guard is built and tested on 3.2.2.
  • PHP 8.1 or later, MySQL or MariaDB.

Installing

  1. Unzip TrafficGuard-1.0.0.zip and copy the TrafficGuard folder into your Omeka Classic plugins/ folder.
  2. Log in to the admin as a Super User and go to Settings > Plugins.
  3. Click Install next to Traffic Guard.

Protection starts at once, in Normal mode. Traffic Guard appears in the admin menu for Super Users and Admins.

Traffic Guard creates five tables: request counters, bans, the event log, user-agent rules and the allowlist (see Settings Keys and Tables).

Behind a proxy or CDN

If the site is behind a reverse proxy or a CDN, every request reaches Omeka from the proxy's address, so every visitor shares one counter. Turn on Behind a proxy under Traffic Guard > Settings so the visitor's own address is read from X-Forwarded-For. Only do this behind a proxy that sets that header: otherwise anyone could claim any address.

Upgrading

Deactivate the plugin, replace the plugins/TrafficGuard folder with the new version, then click Upgrade (or Activate) on the Plugins page.

Uninstalling

Click Uninstall on the Plugins page, then delete the folder. The tables and settings are removed.

Log in for Support