Home

Traffic Server Software Developers Kit

Prev — Licensing Your Plugin
Generating a License Key — Next

Setting Up Licensing

Set up licensing with the steps below:

  1. Develop your plugin using the INKPluginLicenseRequired function.

  2. Create an installation program for your plugin. The installation program must update both plugin.config and plugin.db. When your plugin customer installs the plugin, the program should ask the customer for the license key.

  3. Use the gen_key tool to generate license keys. You can generate different keys for different customers and you can set expiration dates for each key.

  4. Distribute your plugin, with the license key, to customers.

When the customer installs the plugin, the installation program should ask for the license key. The installation program should then make an entry in plugin.db and plugin.config for the new plugin. When the customer runs the plugin, Traffic Server checks the license key. If it passes, then Traffic Server calls INKPluginInit.

Example

  • Suppose you have a plugin filtering, implemented in the object filtering.so

  • Generate a key for your plugin filtering via:

    gen_key filtering ABCDE 03312002

  • The key generated by gen_key is:

    ABCDE2E01E07D95

  • Update plugin.db by adding the following lines:

    [filtering]
Object=filtering.so
License=ABCDE2E01E07D95

The following function is used to license your plugin: