Home

Traffic Server Software Developers Kit

Prev — Accessing Installed Plugin Files
Setting Up Licensing — Next

Licensing Your Plugin

When installing a plugin that requires a license, plugin.db must be updated. This file contains the license keys for the plugins. At load time, Traffic Server reads the keys in the plugin.db file and checks the validity of each. If a key is not valid, then the plugin is not executed.

Format of plugin.db

# comments start with a # character

[plugin_name]
Object=plugin.so
License=Key

Be careful with the syntax:

  • Object is with an uppercase 'O'

    Example: object=plugin.so is bad

  • License is with an uppercase 'L'

    Example: license=key is bad

  • No blank between '=' and value.

    Example: Object = plugin.so is bad

  • No blank after the value, either.

    Example: License=Key is bad