Files
zoraxy/docs/plugins/docs/2. Architecture/3. Configure.md
Toby Chui c56e317bfd Added doc generator
- Added plugin doc generator
- Added getting start plugin doc
2025-05-25 22:17:38 +08:00

737 B

Configure

Configure or Configure Spec is the exec call where Zoraxy start the plugin. The configure spec JSON structure is defined in zoraxy_plugin library.

As the time of writing, the ConfigureSpec only contains information on some basic info.

type ConfigureSpec struct {
	Port         int                  `json:"port"`          //Port to listen
	RuntimeConst RuntimeConstantValue `json:"runtime_const"` //Runtime constant values
	//To be expanded
}

The ConfigureSpec struct will be parsed to JSON and pass to your plugin via the -configure=(json payload here).

In your plugin, you can use the zoraxy_plugin library to parse it or parse it manually (if you are developing a plugin with other languages).