Documenting partner plugins
Plugin documentation is posted on the Plugin Hub.
We are currently accepting plugin submissions to our plugin hub from trusted technical partners, on a limited basis.
For more information on technical partnerships, see the Kong Partners page.
If you’re looking to develop a plugin, see our plugin documentation:
If you have a plugin that’s verified and ready to go, the following guide walks you through submitting plugin docs to our Hub.
The Kong Plugin Hub is a documentation site. We do not host plugin source code or downloads.
Document a partner plugin
In your local clone of the docs repostory, create a new branch for your plugin.
Create a publisher directory in the
of the docs GitHub repository.
The path can consist only of alphanumeric characters and hyphens (
See other Kong Hub listings for examples of publisher names.
Create a subdirectory for your plugin within the publisher directory.
Copy the contents of the
directory into your own plugin’s directory.
You should now have a directory that looks like this:
Populate the files in the directory with your own info:
_metadata.yml: Sets the metadata for the plugin.
Follow the instructions in the file to fill it out.
_schemas/_index.json: A schema of your plugin’s configuration,
in JSON format. Include all of the parameter descriptions in this schema.
See this example schema.
_examples/_index.yml: A basic configuration example for your plugin.
At minimum, this file must contain the plugin name, as well as any required
parameters. This example is validated against the plugin’s schema.
_index.md: Markdown documentation for your plugin. This is where you
explain how the plugin works, how to install it, and how to use it.
_changelog.md: A changelog for your plugin. For the first entry, note when the
plugin was published and which versions of Gateway it has been tested against.
Add an icon for your plugin into the
Plugin icons are required for publication on the Kong plugin hub. Icons
should be a square-format PNG or SVG file, 120x120 pixels in size.
The filename of your image should be
plugin from the directory structure.
If you have any diagrams or screenshots that you want to add to your plugin documentation:
Add to the images into the
Make sure that any screenshots follow the screenshot guidelines.
Insert them into the file at
using the following format:
![Authentication flow diagram](/assets/images/docs/plugins/my-plugin-auth-flow.png)
> *Figure 1: Diagram showing an OAuth2 authentication flow with Keycloak.*
Test and submit plugin
Run the docs site locally per the instructions in
the docs README.
You should find your Hub contribution listed at
Once you are happy with your listing, push your branch to the GitHub repository
git push --set-upstream origin [name_of_your_new_branch]
Make a pull request against the docs.konghq.com
repository to add your documentation to the Plugin Hub.
The Kong docs team will review your PR, suggest improvements and adjustments as
necessary, and once approved, will merge and deploy your Plugin Hub addition!
Custom plugins and documentation
If you’re not interested in becoming a technical partner, there are other ways to publicize your plugin.
To write a custom plugin for your own needs, start with the Plugin Development Guide.
If you already wrote a plugin, and are thinking about making it available to the community, we strongly encourage you to host it on a publicly available repository (like GitHub), and distribute it via LuaRocks. A good resource on how to do so is the distribution section of the Plugin Development Guide.
To give visibility to your plugin, you can create a post in the Announcements category of Kong Nation.