zoeissleeping/gloom
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

small fix

Browse Source
This commit is contained in:
Zoe
2025-05-22 19:53:56 +00:00
parent 1e4dc0c558
commit e858308421
8 changed files with 234 additions and 48 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@@ -58,14 +58,19 @@ GLoom will also use a config file in the `GLOOM_DIR` to configure plugins and ot
```toml
[[plugins]]
file = "gloomi.so"
name = "GLoomI"
domains = ["localhost"]
```
The `[[plugins]]` array is a list of plugins to preload. Each plugin is an object with the following fields:
- `file` - The path to the plugin file. This is a string value.
- `domains` - An array of domains to forward requests to this plugin. This is an array of strings.
The config is in TOML and has the following keys:
- `plugins` - An array of plugins to load. Each plugin is an object with the following keys:
- `file` - The name of the plugin file.
- `name` - The name of the plugin. Can only contain alphanumeric characters and `-` and `_`.
- `domains` - An array of domains to load the plugin on.
- `pluginDir` - The directory to store plugins in relative to `GLOOM_DIR`. Defaults to `plugs`.
- `enableChroot` - Whether to enable chroot, this forces plugins to a specific directory that they cannot escape.
Defaults to `false`.
## Usage