💾 Archived View for gem.benscraft.info › gemcaps › configuration.gmi captured on 2021-12-17 at 13:26:06. Gemini links have been rewritten to link to archived content

-=-=-=-=-=-=-

Configuration

There are several configuration files used with gemcaps. They all use yaml formatting.

┐/etc/gemcaps
│  gemcaps.yml
├─┐handlers/
│ └  myhandler.yml
└─┐capsules/
  └  mycapsule.yml

Each config file has a specific purpose. The main gemcaps.yml file is for global settings regarding gemcaps. The handlers folder holds all of the configurations for custom handlers. The capsules folder holds all the configs for each capsule rule.

gemcaps.yml

handlers: The folder where your handler configs live
capsules: The folder where your capsule configs live
port: the port to listen on
cert: the certificate file to use
key: the certificate key file to use

Handler settings

symbol: The name of the symbol in your shared library object entry point
library: The name/file of the shared library file to load
name: The name of the handler (This is the name that capsules will use)

Capsule settings

Each handler has different settings that are available to a capsule, but each capsule can have the following settings:

handler: [required] The name of the handler to use
name: [required] The name of the capsule
host: [default: *] The host glob to match against
documentRoot: [default: /] The root folder of the path to match against
priority: [default: 0] The level of priority to check this capsule. (Higher priorities are checked first)

For more information on handler specific settings:

Internal Handlers