To install the Cloudflare module:

  1. Log in as Administrator.

  2. Navigate to Modules → select Cloudflare → click Install.

  3. Get registered with Cloudflare Partner program. To do so, follow the link and fill out the sign-up form. The confirmation of your registration may take several days. After that generate the API-token which you will need at Step 6.

  4. Navigate to Modules.

  5. Click Settings.

  6. Specify the generated token in the Api Token field.

    Cloudflare settings

  7. Click  Save.

If a token is specified under the Administrator, all users will use this token.

In order for users to use their own tokens, you need to leave the Api Token field empty in the plugin settings.

Generating Api Token

To create an Api Token in Cloudflare, you need to create an account. If you already have an account, you need to log in.

  1. Create an account and log in to Cloudflare.

  2. Click My Profile.

  3. Select the tab API Tokens.

  4. In the form that opens, click on Create Token.

  5. At the bottom of the templates list, click Get Started opposite Create Custom Token.

  6. Set the token name in the field Token name and add the necessary permissions.

    Example of setting a token

  7. After adding the necessary settings, click Continue to summary at the bottom.

  8. The form will open with a description of all the added permissions for the token.

    Example of token permissions

  9. If everything is correct, click Create Token, otherwise click Edit token and add permissions.

  10. After clicking on the Create Token button, a page with a ready-to-use token will open.

    an example of a ready-to-use token

Permissions

For the correct work of the Cloudflare plugin, select the following permissions:

  1. Account, Account Firewall Access Rules, Read

  2. Zone, Cache Rules, Edit

  3. Zone, Zone Settings, Read, Edit

  4. Zone, Zone DNS, Read, Edit

  5. Zone, Zone, Edit

  6. Zone, Cache Purge, Purge

  7. Zone, Firewall Services, Read, Edit

After adding the necessary permissions, the plugin functions should work. It may take some time to update the token data on Cloudflare servers.