PluginConfig Schema

Schema Definition

Schema URL: https://rustybeam.net/schema/PluginConfig

⚠️ Note: This schema appears to be used incorrectly in some configuration files. The correct schema for plugin configuration is https://rustybeam.net/schema/Plugin. This documentation is provided for completeness, but you should use the Plugin schema instead.

PluginConfig is the internal Rust struct name for plugin configuration. In HTML configuration files, this should be represented using the https://rustybeam.net/schema/Plugin itemtype.

Properties

Property	Type	Cardinality	Description
plugin-path	https://rustybeam.net/schema/URL	1	Incorrect property name. Should use "library" instead. This appears in test-config-separate-auth.html but is not recognized by the parser. The correct property name is "library" with a file:// URL (e.g., "file://./plugins/basic-auth.so")

Correct Usage

Instead of using PluginConfig with plugin-path, use the Plugin schema with library property:

<tr itemprop="plugin" itemscope itemtype="https://rustybeam.net/schema/Plugin">
    <td>Plugin</td>
    <td itemprop="library">file://./plugins/basic-auth.so</td>
</tr>

Using itemref for Plugin Properties

When you need to associate properties with a plugin using itemref, the properties should reference the plugin's id:

<tr id="my-plugin" itemprop="plugin" itemscope itemtype="https://rustybeam.net/schema/Plugin">
    <td>Plugin</td>
    <td itemprop="library">file://./plugins/basic-auth.so</td>
</tr>
<tr>
    <td>Authentication File</td>
    <td itemref="my-plugin" itemprop="authFile">./auth/users.html</td>
</tr>