Zoe
98c0f45ca8
I have documented GLoom's new RPC, how a plugin developer might create a plugin, and more. I have also created GLoomI, the included management interface for GLoom and added a LICENSE.
57 lines
2.2 KiB
Markdown
57 lines
2.2 KiB
Markdown
# GLoom Documentation
|
|
|
|
## Plugins
|
|
|
|
Plugins are the core of GLoom, they are responsible for handling requests and providing routes.
|
|
|
|
### Plugin Interface
|
|
|
|
The `Plugin` interface is the main interface for plugins to implement. It has three methods:
|
|
|
|
- `Init()` - This method is called when the plugin is loaded. It is the function that is initially called when the plugin is loaded.
|
|
- `Name()` - This method returns the name of the plugin.
|
|
- `RegisterRoutes(router fiber.Router)` - This method is called when the plugin is loaded and is responsible for registering routes to the router.
|
|
|
|
An example plugin is provided in the `plugin` directory and can be built using the following command:
|
|
|
|
```bash
|
|
zqdgr build
|
|
```
|
|
|
|
This will generate a `plugin.so` file in the `plugin` directory.
|
|
|
|
## RPC
|
|
|
|
GLoom exposes an RPC server on port 7143. This server is used for GLoom's plugin management system. Gloom currently provides two methods:
|
|
|
|
- `ListPlugins(struct{}, reply *[]PluginData) error` - This method returns a list of all registered plugins and their domains.
|
|
- `UploadPlugin(PluginUpload, reply *string) error` - This method uploads a plugin to GLoom.
|
|
|
|
PluginData is a struct that looks like this:
|
|
|
|
```go
|
|
type PluginData struct {
|
|
Name string `json:"name"`
|
|
Domains []string `json:"domains"`
|
|
}
|
|
```
|
|
|
|
PluginUpload is a struct that looks like this:
|
|
|
|
```go
|
|
type PluginUpload struct {
|
|
Name string `json:"name"`
|
|
Domains []string `json:"domains"`
|
|
Data []byte `json:"data"`
|
|
}
|
|
```
|
|
|
|
## GLoomI
|
|
|
|
GLoomI is the included plugin management interface for GLoom, it utilizes the GLoom RPC, much like you would if you wanted to make your own management interface. By default, GLoomI is configured to use 127.0.0.1 as the hostname, but you con configure it to use a different hostname by setting the `GLOOMI_HOSTNAME` environment variable. The endpoints for GLoomI are as follows:
|
|
|
|
- `GET /api/plugins` - This endpoint returns a list of all registered plugins and their domains.
|
|
- `POST /api/plugins` - This endpoint uploads a plugin to GLoom. it takes a multipart/form-data request with the following fields:
|
|
- `plugin` - The plugin file to upload.
|
|
- `domains` - A comma-separated list of domains to associate with the plugin.
|