Skip to main content

Requirements

info

For more technical details about requirements, read the detailed starting guide in the Hosting Docs.

Requirements are configuration settings that plugins and models need to function properly. These typically include API keys and other essential settings that can be configured through the web interface. This guide explains how to manage requirements and their limitations.

As an administrator, you have the ability to set global requirements that apply across your organization. Plugins and models may have additional requirements, these are either:

  • Automatically configured by oryelle
  • Individually set by users as needed

It's important to note that users can only use a model or plugin after all its global requirements have been properly configured.

To set a requirement:

  1. Go to the library
  2. Select the resource you want to configure
  3. Enter the required values in the modal

For security purposes, some requirements are marked as "secure". When a requirement has this designation, its value will be hidden from view once set, helping protect sensitive information like API keys.