Server Plugins

King Phisher version 1.4.0 introduced a plugin system to allow users to load additional functionality into the King Phisher server. Plugins are available from the king-phisher-plugins repository.

Installing Plugins

To install a plugin, place the file into the data/server/king_phisher/plugins. The folder needs to be created if it does not already exist. Once installed, a plugin needs to be enabled and have all of it's required options set within the server's configuration file. Plugins must be added to the plugins: section of the config file with their respective options defined in a subsection below their name.

  plugins:
    # The plugin to enable's name, in this case "some_plugin"
    some_plugin:
      # An option specific to this particular plugin
      value_for_some_plugin: true

To find the options which are required for a specific plugin, refer to it's respective documentation.

After the configuration file has been updated with the plugin to enable, the server must be restarted. Failure to define all of an enabled plugin's required options and satisfy all of it's compatibility requirements will cause the server to fail on startup. Information will be logged regarding the missing options and unmet compatibility requirements.

Writing Plugins

To get started with writing a plugin, please see the developer documentation.