Skip to content

Plugin Backend

Ben McClelland edited this page Feb 17, 2026 · 2 revisions

VersityGW can load shared object plugin files for Backend implementations not included directly in the project.

The invocation for a plugin backend is:

versitygw [global options] plugin [-c <config file>] <plugin file> 

The format of the config file should be documented along with the plugin being loaded.

More information on Go plugins can be found here: https://pkg.go.dev/plugin

It is often the case that versitygw and the plugin file will need to be compiled at the same time using the same compiler and dependency versions. If you are planning to distribute a pulgin, you may need to provide versitygw as well for the corresponding build. The primary benefit of plugins is easier code management outside of the primary versitygw repository.

Clone this wiki locally