Easy installation from the command line or via the Plugin Store

Plugin Store #

  • Search for Patrol
  • Install

Developers #

From your project root directory

$ composer require selvinortiz/patrol
$ ./craft install/plugin patrol

Configure #

You can use a file config to setup Patrol just the way you want.

Below is a sample config you can plance in config/patrol.php


return [
    '*' => [
        'primaryDomain' => null,
        'redirectStatusCode' => 302,

        'sslRoutingBaseUrl' => "",
        'sslRoutingEnabled' => true,
        'sslRoutingRestrictedUrls' => ['/'],

        'maintenanceModeEnabled' => false,
        'maintenanceModePageUrl' => '/offline',
        'maintenanceModeAuthorizedIps' => ['::1', ''],
        'maintenanceModeResponseStatusCode' => 410,
    'dev' => [
        'sslRoutingEnabled' => false,
    'staging' => [
        'maintenanceModePageUrl' => null,
        'maintenanceModeResponseStatusCode' => 410,
    'production' => [
        'redirectStatusCode' => 301,
        'maintenanceModeResponseStatusCode' => 503,

Configuration Settings #


Defaults to null

Primary domain to enforce

If your site is accessible via multiple domains, you may want to ensure that it can only be accessed by the primary domain.


  • domain​.frb​.io (App URL)
  • www​.domain​.com (Secondary)
  • domain​.com (Primary)

If a user requests or, they will be redirected to


Defaults to 302

Redirect status code to use when…

  1. redirecting to and from SSL restricted URLs
  2. redirecting to primary domain, if one is defined.


Defaults to Craft::$app->request->hostInfo

Tells Patrol what base URL to use when redirecting to SSL


Defaults to false

Tells Patrol to force requests to be made over https://


Defaults to ['/'] (everything)

Tells Patrol where https:// should be enforced.


Defaults to false

Tells Patrol that your site is on maintenance mode and it should start routing traffic differently.

Authorized users will see your site while unauthorized users will see either your offline page or an HTTP response with a custom status code.


Defaults to ['::1', '']

IP addresses that should be allowed (without being logged in) during maintenance.


Defaults to 410

Tells Patrol what kind of HttpException to throw if you do not set a $maintenanceModePageUrl.


Defaults to []

Access tokens that can be used to automatically add an IP to the allowed list.

If you define the following access tokens:

$maintenanceModeAccessTokens =  [

You will be able to send someone a link with the access token. When the visit that link, their IP will be added to the allowed list.

You can use any string as an access token but avoid using spaces.

If you are planning on using access tokens, do not include $maintenanceModeAuthorizedIps as a file config setting.

[Work In Progress]

Please forgive my typos, partial docs, and overall mess.

I'm working hard to get everything moved over and provide amazing docs for you, my loyal supporter.

—Selvin Ortiz

Let’s Work Together

If you’d like to work together, have questions about any of my Craft CMS Plugins or just want to say hello, send me an email.

Email Me