codux.config.schema.json

type: object

$ref: #/$defs/AddPanelConfig

description:
Configures how SVG assets load.
Refer to https://help.codux.com/kb/en/article/kb17934 for more information.

type: string

default: asset

description:
Default directory for new boards, relative to the project root.
Refer to https://help.codux.com/kb/en/article/kb19337 for more information.

description:
Configures scripts for project users to run from Codux (triggerable and on demand).
Refer to https://help.codux.com/kb/en/article/kb30920 for more information.

$ref: #/$defs/ConfiguredScript

description:
Options for using the classNames utility library, including path to classNames module, and target export.
Refer to https://help.codux.com/kb/en/article/kb36122 for more information.

$ref: #/$defs/IClassNamesPluginsOptions

description:
Path to a file that will be evaluated before each board is rendered,
Useful for importing global stylesheets and initializing global variables.
Can be absolute or relative to the project root (in which case it needs to start with './')
Refer to https://help.codux.com/kb/en/article/kb36623 for more information.

$ref: #/$defs/PreviewConfiguration

$ref: #/$defs/ICompilationConfig

$ref: #/$defs/PluggableSafeModeConfig

description: Port of HTTP server that is used to serve previews and user project itself.

type: number

$ref: #/$defs/INewComponentConfig

$ref: #/$defs/IgnoredSubPaths

description:
Configures file-naming convention for new component creation.
Refer to https://help.codux.com/kb/en/article/kb29627 for more information.
Options: "pascal-case" | "camel-case" | "kebab-case"

$ref: #/$defs/IResolveConfiguration

description:
Configures proxy servers for Codux to redirect requests to.
The key is the path to proxy requests from, and the value is the url to proxy requests to.
Refer to https://help.codux.com/kb/en/article/kb18137 for more information.

description:
Styling related configuration.
Contains field for styling solution which determines the main styling solution in the user's project.
Refer to https://help.codux.com/kb/en/article/kb31817 for more information.

description:
Default file extension to use for component style sheets in the project.
Options: "css" | "sass" | "css modules" | "sass modules" | "scss" | "scss modules" | "stylable"

$ref: #/$defs/IStyleFilesConfig

description:
Formats code styling in Codux code drawer.
Refer to https://help.codux.com/kb/en/article/kb21416 for more information.

type: array

$ref: #/$defs/Json

type: boolean

$ref: #/$defs/ComponentsDiscoveryConfig

description:
Add Panel config.
Can contain list of libraries installed in the project which provide boards for Codux.

description: The type of configured script users will define in the `codux.config.json`.

$ref: #/$defs/ScriptFromConfig

$ref: #/$defs/BatchFromConfig

description: Scripts have a `commmand` but not an array of scripts to `run`.

description: This is the command that the script runs when executed.

description:
Script title in the UI.
Will be available to use from Codux.

description: Script description in the UI.

description:
Initiate Git commands in Codux before running the rest of the scripts.
The array of triggers may include "setup" for when the user opens the project for the first time,
"pull" for when branch commits sync, and "checkout" for when switching branches.

description: Batches have a `run` array but not a `commmand`.

description: The value of this parameter is an array of script objects to include in the batch.

description: Script description in the UI.

required: classnamesPath classnamesTarget

description:
Specifies environment variables to use globally across the project.
Refer to https://help.codux.com/kb/en/article/kb37722 for more information.

description: variables that are being accessed from process.env

description:
Enables CSS modules in your project.
Refer to https://help.codux.com/kb/en/article/kb25813 for more information.

description: Enables or disables the use of CSS modules.

description: The extension types for files to load as modules.

required: activateCssModules cssModulesExt

description:
Configures maximum rendered elements.
Refer to https://help.codux.com/kb/en/article/kb18414 for more information.

description:
Configures default paths for new component and template files.
Refer to https://help.codux.com/kb/en/article/kb16522 for more information.

description: Path where new components and related files will save to.

description: Path where project templates are stored.

description:
Specifies project folders to exclude from component search.
Refer to https://help.codux.com/kb/en/article/kb14730 for more information.

description:
Includes package assets from additional sources, and creates aliases and fallbacks.
Refer to https://help.codux.com/kb/en/article/kb18719 for more information.

description:
Aliases for package requests.
Record key is the request to be mapped, value is the new target.
Alias is attempted before original request.

description:
Fallback for package requests.
Record key is the request to be mapped, value is the new target.
Original request is attempted before fallback.

description: Folders to use when searching for packages.

description:
Aliases for all package requests in a monorepo.
Record key is the request to be mapped, value is the new target.

description:
Adds Sass support to compilations.
Refer to https://help.codux.com/kb/en/article/kb19315 for more information.

description:
Defines path and module extensions for Sass modules to include and/or ignore.
Input as an array of glob patterns.

description: Array of glob patterns to include.

description: Array of glob patterns to ignore.

description: Determines whether URLs in Sass files should resolve to absolute file paths before compiling them.

description: Array of paths to resolve Sass files from.

required: modules resolveUrls

description: Style files config

description: ext glob pattern of common style files that are used by other components. Defines common rules category.

description:
Scopes component discovery in your project.
Refer to https://help.codux.com/kb/en/article/kb37113 for more information.

description: Array of glob patterns to include.

description: Array of glob patterns to exclude.


asmdef.json

enum: Android Editor iOS LinuxStandalone32 LinuxStandalone64 LinuxStandaloneUniversal Lumin macOSStandalone Nintendo3DS PS4 PSVita Stadia Switch tvOS WSA WebGL WindowsStandalone32 WindowsStandalone64 XboxOne

description: Defines an assembly in the Unity compilation pipeline

description: The name of the assembly being defined

description: The root namespace of the assembly. Requires Unity 2020.2

description: A list of assembly names or assembly asset GUIDs to reference

description: Platforms to target

$ref: #/definitions/platformValues

description: Platforms that are explicitly not targeted

description: Allow unsafe code

description: When true, this assembly definition is automatically referenced by predefined assemblies (Assembly-CSharp, Assembly-CSharp-firstpass, etc.)

description: When true, no references to UnityEngine or UnityEditor will be added to this assembly project

description: When true, any references to precompiled assembly assets are manually chosen. When false, all precompiled assembly assets are automatically referenced

default: false

description: A list of precompiled assembly assets that will be referenced. Only valid when overrideReferences is true

description: A list of the C# compiler define symbols that must evaluate to true in order for the assembly to be compiled or referenced. Absence of a symbol can be checked with a bang symbol (!DEFINE)

description: Additional optional Unity features to reference

description: A set of expressions that will define a symbol in the C# project if a package or module version matches the given expression

description: The package or module that will provide the version to be checked in the expression

description: The semantic version range of the chosen package or module

description: The name of the define that is added to the project file when expression evaluates to true

required: name expression define

title: Unity Assembly Definition


dependabot.json

type: integer

enum: javascript ruby:bundler php:composer python go:modules go:dep java:maven java:gradle dotnet:nuget rust:cargo elixir:hex docker terraform submodules elm github_actions

description: What package manager to use

description: Where to look for package manifests

enum: live daily weekly monthly

description: How often to check for updates

description: Branch to create pull requests against. By default your repository's default branch is used.

description: branchname

description: Reviewers to set on update pull requests.

description: reviewer github username

description: Assignees to set on update pull requests.

description: assignee github username

description: Labels to set on update pull requests. By default 'dependencies' is used.

description: Milestone to set on dependency update pull requests. Specified using the milestone number - you can find this in the URL when looking at details of a milestone in GitHub.

description: Limit which updates are allowed.  By default all direct/top-level dependencies are kept up to date (indirect/sub-dependencies are only updated if they include security fixes).

description: matching on dependency name

description: only allow certain updates

examples: development production direct indirect all

enum: security all

description: which updates to do

default: security

description: By default no updates are ignored. The version_requirement specifies the versions to ignore. The range format is specific to the package manager (e.g., ^1.0.0 for JS, or ~> 2.0 for Ruby).

description: matching on dependency name

description: Automerged updates must be enabled at the account level (from account settings in your dashboard) before they can be configured on a project. Specify which update pull requests should be merged automatically. By default no updates are automerged. For all of the options below Dependabot will wait until all your status checks pass before merging. You can also set working hours for automerging in your dashboard account settings.

description: matching on dependency name

enum: development production all

enum: security:patch semver:patch semver:minor in_range all

description: Specify how Dependabot should update your package manifest (e.g. package.json, Gemfile etc), as opposed to your lockfile. By default, version requirements are increased if it's an app and the range widened if it's a library.

description: Preferences for the format of Dependabot's commit messages and pull request titles. By default, Dependabot will attempt to detect your commit message preferences and use those.

title: Dependabot configuration file


description: List of tags.

description:
The mandatory name of the node. If not present, node will be
skipped at runtime. It is used for example in debug log to help
you track things.

description: List of parsers to include in the collection.

description: List of scnearios to include in the collection.

description: The name of the author.

description: description of the parser usage

description: List of collections to include in the collection.

description: List of postoverflows to include in the collection.

title: CrowdSec Collection


ize-spec.json

description: (optional) AWS Profile can be specified here (but normally it's specified via AWS_PROFILE env var)

description: (required) AWS Region of this environment should be specified here. Can be overridden by AWS_PROFILE env var or --aws-region flag.

description: (optional) Path to ize.toml config file can be specified, but normally it's read from the environment's directory automatically.

description: (optional) Environment name can be specified here. Normally it should be passed via `ENV` variable or --env flag.

description: (optional) Environment directory can be specified here. Normally it's calculated automatically based on the directory structure convention.

description: (optional) User home directory can be specified here. Normally $HOME is used.

description: (optional) Ize directory can be specified here. Normally it's assumed to be .infra or .ize in the current repo.

description: (optional) Log level can be specified here. Possible levels: info, debug, trace, panic, warn, error, fatal(default). Can be overridden via IZE_LOG_LEVEL env var or via --log-level flag.

description: (required) Namespace of the project can be specified here. It is used as a base for all naming. It can be overridden by NAMESPACE env var or --namespace flag.

description: (optional) Plain text output can be enabled here. Default is false. Can be overridden by IZE_PLAIN_TEXT env var or --plain-text flag.

description: (optional) Prefer a specific runtime. (native or docker) (default 'native')

description: (optional) Path to apps directory can be set. By default apps are searched in 'apps' and 'projects' directories. This is needed in case your repo structure is not purely ize-structured (let's say you have 'src' repo in your dotnet app, as an example)

description: (optional) Project directory can be set here. By default it's the current directory, but in case you prefer to run ize from the outside of repo it may be useful (uncommon).

description: (optional) Docker registry can be set here. By default it uses ECR repo with the name of the service.

description: (optional) TF_LOG_PATH can be set here.

description: (optional) Tag can be set statically. Normally it is being constructed automatically based on the git revision.

description: (optional) Terraform TF_LOG can be set here.  Can be TRACE, DEBUG, INFO, WARN or ERROR.

description: (optional) Custom prompt can be enabled here for all console connections. Default: false.

description: Bastion instance ID.

description: Forward host.

description: Tunnel configuration.

deprecationMessage: app block is deprecated

$ref: #/definitions/app

description: Apps configuration.

$ref: #/definitions/ecs

description: Ecs apps configuration.

$ref: #/definitions/serverless

description: Serverless apps configuration.

$ref: #/definitions/alias

description: (optional) Alias mode can be enabled here. This can be used to combine various apps via depends_on parameter.

$ref: #/definitions/terraform

description: Terraform configuration.

deprecationMessage: infra block is deprecated

description: (optional) Terraform version can be set here. 1.1.3 by default.

description: (optional) Terraform state bucket region can be specified here. Normally AWS_REGION is used here. Can be overridden via env vars or flags.

description: (optional) Terraform state bucket name can be specified here. Normally it's generated and defaults to <NAMESPACE>-tf-state

description: (optional) Terraform state name that will be used in the .tfstate file. Normally it's 'terraform' or state name.

description: (optional) Root domain name can be set here. This is the main domain that will be passed to the terraform. Generally if your app lives at 'api.dev.nutcorp.net' the root domain is `nutcorp.net`

description: (optional) Terraform-specific AWS Region of this environment should be specified here. Normally global AWS_REGION is used.

description: (optional) Terraform-specific AWS profile (optional) can be specified here (but normally it should be inherited from a global AWS_PROFILE).

description: Infrastructure configuration.

description: Bastion instance ID.

description: Forward host.

description: Tunnel configuration.

description: Infrastructure configuration.

description: app type

description: (optional) Path to serverless file can be specified here. Normally it's serverless.yml in the app directory.

description: (optional) Node version that will be used by nvm can be specified here that. Default is v14.

description: (optional) Create domain for the serverless domain manager during the deployment.

description: (optional) Path to ecs app folder can be specified here. By default it's derived from apps path and app name.

description: (optional) SLS node_modules cache mount path can be specified here. It's used to store cache during CI/CD process.

description: environment

description: environments

description: (optional) Enables unsafe mode that increases deploy time on a cost of shorter healthcheck.

description: (optional) Docker image can be specified here. By default it's derived from the app name.

description: (optional) ECS cluster can be specified here. By default it's derived from env & namespace

description: (optional) Task definition revision can be specified here. By default latest revision is used to perform a deployment. Normally this parameter can be used via cli during specific deployment needs.

description: (optional) ECS deployment timeout can be specified here.

description: (optional) skip deploy app.

description: (optional) expresses startup and shutdown dependencies between apps

description: App configuration.

description: (optional) skip deploy app.

description: (optional) set icon

description: (optional) ECS-specific AWS Region of this environment should be specified here. Normally global AWS_REGION is used.

description: (optional) ECS-specific AWS profile (optional) can be specified here (but normally it should be inherited from a global AWS_PROFILE).

description: Ecs app configuration.

description: (optional) Path to the serverless app directory can be specified here. Normally it's derived from app directory and app name.

description: environment

description: environments

description: (optional) set icon

description: (optional) Serverless-specific AWS Region of this environment should be specified here. Normally global AWS_REGION is used.

description: (optional) Serverless-specific AWS profile (optional) can be specified here (but normally it should be inherited from a global AWS_PROFILE).

description: Serverless app configuration.

description: (optional) set icon

description: Alias configuration.

description: Terraform configuration


description: The name of the catalog

description: The name of the schema

description: The comments stored for the table/view/column

description: The name of the table

description: Allows to define the 'where' condition(s) string

description: Specifies logical expression of database type(s) on which the change must be applied. Valid database type names are listed on the supported databases page. It can be a comma-separated list of multiple databases or you can also specify that a change is not applicable to a particular database type by prefixing with !. The keywords all and none are also available.

description: The name of the column.

description: The attribute which is used if the value in name isn't actually a column name but a function. Since 3.3.0

description: The boolean attribute which allows you to specify that a column should be used in a descending order in the index if it is used in a createIndex command. Default value is false (in an ascending order) Since 3.4

description: The column data type.

description: The value for which to set the column. The value will be surrounded by quote marks and nested quote marks will be escaped.

description: The numeric value to set the column to. The value will not be escaped and will not be nested in quote marks.

description: The boolean value to set the column to. The actual value string inserted will depend on the database implementation.

description: The date and time value to set the column to. The value is specified in one of the following forms: YYYY-MM-DD, hh:mm:ss, or YYYY-MM-DDThh:mm:ss.

description: The value that is returned from a function or procedure call. This attribute will contain the function to call.

description: The name of the sequence in which the current value is used.

description: The name of the sequence in which the next value is used.

description:
The path to a file, whose contents will be written as a BLOB (i.e. chunk of binary data).

The path to the changelog file location must be either absolute or relative. An example of an absolute path is: /usr/local/somefile.dat on Unix or c:\Directory\somefile.dat on Windows.

description:
The path to a file, whose contents will be written as a CLOB (i.e. chunk of character data).
The path to the changelog file location must be either absolute or relative. An example of an absolute path is: /usr/local/somefile.dat on Unix or c:\Directory\somefile.dat on Windows.

description: The default value for column.

description: The default numeric value for column.

description: The default date and time value for column. The value is specified in one of the following forms: YYYY-MM-DD, hh:mm:ss, or YYYY-MM-DDThh:mm:ss.

description: The default boolean value for column.

description: The default value that is returned from a function or procedure call. This attribute will contain the function to call.

description: The auto-increment column. Ignored on databases that do not support the autoincrement/identity functionality.

description: The value auto-increment start. Ignored on databases that do not support autoincrement/identity functionality.

description: The value of each step by auto-increment. Ignored on databases that do not support autoincrement/identity functionality.

description: A short description of the column (column comment).

description: The name of the encoding (specified in java.nio.Charset javadoc, e.g. "UTF-8") of the CLOB file (specified in valueClobFile) contents.

description: The attribute that allows you to control where in the table column order the new column goes if it is used in an addColumn command. Only one of beforeColumn, afterColumn, or position is allowed. Since 3.1

description: The attribute that allows you to control where in the table column order the new column goes if it is used in an addColumn command. Only one of beforeColumn, afterColumn, or position is allowed. Uses one based index. Since 3.1

description: Name of the column in the CSV file from which the value for the column will be taken if its different from the column name. Ignored if index is also defined.

description: Index of the column in the CSV file from which the value for the column will be taken.

description: Constraint definitions

description: The attribute that defines whether the column is nullable.

description: The not null constraint name.

description: The attribute that defines whether the column is a primary key.

description: The primary key name Since 1.6.

description: The tablespace to use for the defined primary key.

description: The attribute that defines whether a unique clause should be applied.

description: The unique constraint name.

description: The foreign key definition.

description: The name of the catalog.

description: The name of the schema.

description: The name of the table.

description: The name of the column.

description: The foreign key name.

description: The attribute that sets delete cascade.

description: The attribute that defines whether constraints are deferrable.

description: The attribute that defines whether constraints are initially deferred.

description: The attribute that defines whether to validate the defined check constraint.

description: The attribute that defines whether to validate the defined not null constraint.

description: The attribute that defines whether to validate the defined unique constraint.

description: The attribute that defines whether to validate the defined primary key constraint.

description: The attribute that defines whether to validate the defined foreign key constraint.

description:
The column constraint and foreign key information. Setting the defaultValue attribute will specify a default value for the column. Setting the value attribute will set all rows existing to the specified value without modifying the column default.
See Information about the <column> tag section for more information.

$ref: #/definitions/column

$ref: #/definitions/modifySql

description: Preconditions are changelog or changeset tags which control the execution of an update based on the state of the database.

description: Provides a custom message to output when preconditions fail. Since 2.0

description: Provides a custom message to output when preconditions fail. Since 2.0

description: Controls what happens if the preconditions check fails.

const: HALT

description: Halts the execution of the entire changelog (default). HALT can be put outside a changeset (e.g. at the beginning of the changelog).

const: CONTINUE

description: Skips over the changeset. Execution of the changeset will be attempted again on the next update. Continues with the changelog.

description: Skips over the changeset but mark it as executed. Continues with the changelog.

const: WARN

description: Sends a warning and continues executing the changeset / changelog as normal. WARN can be put outside a changeset (e.g. at the beginning of the changelog).

default: HALT

description: Controls what happens if there is an error checking whether the precondition passed or not.

description: Skips over the changeset but mark it as executed. Continues with the changelog.

description: Controls what to do in the updateSQL mode. Since 1.9.5

const: TEST

description: Runs the changeset in the updateSQL mode.

const: FAIL

description: Fails the preCondition in the updateSQL mode.

const: IGNORE

description: Ignores the preCondition in the updateSQL mode (default).

default: IGNORE

description: Defines if the database executed against matches the type specified.

description: The type of database expected. Multiple dbms values can be specified using comma-separated values. (required)

description: Defines if the database user executed under matches the username specified.

description: The database user script which is expected to run as. (required)

description: Defines if the specified changeset has already been executed.

required: id author changeLogFile

description: The changeset id. (required)

description: The changeset author. (required)

description: The file name (including classpath relative path) of the changeset. (required)

description: Defines if the specified column exists in the database.

required: tableName columnName

description: The name of the table's schema.

description: The name of the column's table. (required)

description: The name of the column. (required)

description: Defines if the specified table exists in the database.

description: The name of the table's schema.

description: The name of the table. (required)

description: Defines if the specified view exists in the database.

description: The name of the view's schema.

description: The name of the view. (required)

description: Defines if the specified foreign key exists in the database.

description: The name of the foreign key's schema.

description: The name of the foreign key. (required)

description:
Defines if the specified index exists in the database. You can either specify the indexName attribute or tableName and columnName attributes.
Note: There are a few databases where the indexName is not unique, that's why both indexName and tableName can be used.

description: The name of the index's schema.

description: The name of the index.

description: The name of the table.

description: The name of the column.

description: Defines if the specified sequence exists in the database.

description: The name of the sequences' schema.

description: The name of the sequence. (required)

description:
Defines if the specified primary key exists in the database.
(tableName or primaryKeyName is required)

description: The name of the primary key's schema.

description: The name of the primary key.

description: The name of the table containing primary key.

description:
Executes an SQL string and checks the returned value. The SQL must return a single row with a single value.

To check a number of rows, use the count SQL function.
To check for ranges of values, perform the check in the SQL and return a value that can be easily compared against.

description: The value to compare the SQL result to. (required)

description: Checks whether given changelog attribute is present. It fails if the value is not the same as given.

description: The name of the property to check. (required)

description: The required value for a given property.

description:
Can be created by adding a class that implements the liquibase.precondition.CustomPrecondition interface. Parameters on custom classes are set through reflection based on the <param> sub-tags. Pass parameters as strings to the custom precondition.

The customPrecondition sub-tags:
param - the parameter to pass to the custom precondition.
name - the name of the parameter to set. (required)
value - a string value to set parameter to. (required)

description: The name of the custom precondition class. (required)

description: You can typically use the createTable Change Type when you want to create a table in your changelog file and then deploy it to your database. It can include columns and another values listed in this documentation.

description: The name of the tablespace in which the table is created

description: Creates a new database view.

description: Name of the view to create

description: Use 'create or replace' syntax

description: Set to true if selectQuery is the entire view definition. False if the CREATE VIEW header should be added.

description: Path to file containing view definition

description: Encoding used in the file defined in the `path` attribute

description: Whether the file path relative to the root changelog file rather than to the classpath.

description: SQL for generating the view

description: It is useful for complex changes that aren't supported through Liquibase's automated Change Types and to work around bugs and limitations of Liquibase. The SQL contained in the <SQL> Change Type can be multi-line.

description: Set to true to remove any comments in the SQL before executing, otherwise false.

description: Set to false to not have Liquibase split statements on ;'s and GO's. Defaults to true if not set

description:
Indicates the end of the SQL statement and prevents incomplete SQL statements from being processed when the SQL files contain statements referencing a ; which Liquibase treats as the default end delimiter. You can use the endDelimiter when the changeset contains SQL to create a stored procedure or function that contains the default ; end delimiter to separate the statements inside the procedure.
For more information, see The endDelimiter SQL attribute.

description: Specifies the SQL to execute

description: You can typically use the update Change Type when you want to update a table in your changelog file and then deploy this update to your database. It can include columns and another values listed in this documentation.

description: Deletes data from an existing table.

description:
Value of the attribute.
Note: If not set, then the first valueXXX defined is used in the order they appear.

description: integer value of the attribute.

description: boolean value of the attribute.

description: Date and/or Time value to set the attribute to. The value shall be specified in one of the following forms: "YYYY-MM-DD", "hh:mm:ss" or "YYYY-MM-DDThh:mm:ss".

description: A value that is returned from a function or procedure call. This attribute shall contain the function name to call.

description: Name of the sequence which next value is used

description: Name of the sequence which current value is used

description: The tagDatabase Change Type applies a tag to the database for future update or rollback.

description: The tag to apply

description: Drops an existing table from your database.

description: Add the `CASCADE CONSTRAINTS` to the statement

description: Name of the view to rename

description: Name to rename the view to

description: Drops an existing view.

description: Name of the view to drop

description: empty

description: You can typically use the insert Change Type when you want to add and deploy the specific data or values to the existing table in your database. It can include columns and another attributes listed in this documentation.

description: You can typically use the addColumn Change Type when you want to add a new column and deploy it to the table in your database.

description:
The createProcedure Change Type defines the definition for a stored procedure. This Change Type is better to use for creating procedures than the raw SQL command because it will not attempt to strip comments or break up lines.

Often times it is best to use the CREATE OR REPLACE syntax along with setting runOnChange='true' on the enclosing changeset tag. That way if you need to make a change to your procedure, you can change your existing code rather than creating a new REPLACE PROCEDURE call. The advantage to this approach is that it keeps your changelog smaller and allows you to more easily see what has changed in your procedure code through your source control system's diff command.

description: The SQL creating the procedure. You need to define either this attribute or the path attribute. The procedureText attribute is not supported in the XML format; however, you can specify the procedure SQL within <createProcedure></<createProcedure> tags. See the XML example.

description: The name of the procedure. It is required if replaceIfExists= true

description: The file containing the procedure text. Either this attribute or a nested procedure text is required.

description: The encoding used in the file defined in the `path` attribute

description: Defines whether the file path is relative to the root changelog file rather than to the classpath.

description: If the stored procedure defined by procedureName already exits, alter it instead of creating it.

description: The comments you can specify in the changeset.

description: Drops an existing procedure

description: Name of the stored procedure to drop

description: The <sqlFile> Change Type is useful for complex changes that are not supported through Liquibase automated Change Types such as stored procedures. The SQL contained in the <sqlFile> Change Type can be multi-line.

description: Specifies the file path of the SQL file to load.

description: Set to true to remove any comments in the SQL before executing, otherwise false.

description: Set to false to not have Liquibase split statements on ;'s and GO's. Defaults to true if not set.

description: Specifies encoding used in the file defined in the `path` attribute.

description: Indicates whether the file path is relative to the root changelog file rather than to the classpath.

description: Stops Liquibase execution with a message. Mainly useful for debugging and stepping through a changelog

description: Message to output when execution stops

description: Renames an existing table.

description: Name of the table to rename

description: New name for the table

description: Renames an existing column.

description: Name of the existing column to rename

description: Name to rename the column to

description: Data type of the column

description: Remarks of the column

description:
Drops an existing column(s).

To drop a single column, use the simple form of this element where the tableName and columnName are specified as attributes. To drop several columns, specify the tableName as an attribute, and then specify a set of nested <column> tags. If nested <column> tags are present, the columnName attribute will be ignored.

description: Name of the column to drop, if dropping a single column. Ignored if nested 'column's are defined

description:
The mergeColumns Change Type concatenates the values in two columns and joins them with a string. The Change Type stores the resulting value in a new column.
You can typically use the mergeColumns Change Type when you want to combine the values from two columns into one.

description: The name of the column containing the first half of the data

description: The string to place between the values from column1 and column2 (may be empty)

description: The name of the column containing the second half of the data

description: The name of the column to create

description: The data type of the column to create

description: Allows you to modify data types.

description: Name of the column

description: Creates a new database sequence.

description: Name of the sequence to create

description: The first sequence number to be generated.

description: Interval between sequence numbers

description: The maximum value of the sequence

description: The minimum value of the sequence

description: Does the sequence need to be guaranteed to be generated in the order of request?

description: Number of values to fetch per query

description: Data type of the sequence

description: Can the sequence cycle when it hits the max value?

description: Alters properties of an existing sequence.

description: Name of the sequence to alter

description: New amount the sequence should increment by

description: New maximum value for the sequence

description: New minimum value for the sequence

description: Does the sequence need to be guaranteed to be generated in the order of request?

description: Change the cache size

description: Data type of the sequence

description: Can the sequence cycle when it hits the max value?

description: Drops an existing sequence.

description: Name of the sequence to drop

description: Renames an existing sequence.

description: Name of the sequence to rename

description: New name for the sequence

description: The createIndex Change Type creates an index on an existing column or a set of columns.

description: The name of the index to create.

description: The unique values in the index.

description: The attribute that creates a clustered index.

description: The tablespace in which you create the index.

description: The dropIndex Change Type drops an existing index on a column.

description: The name of the index to drop.

description: The addNotNullConstraint Change Type adds a NOT NULL constraint to an existing table.

description: The name of the column for which to add the constraint.

description: The value for which you can set all values that currently equal null in a column. If null values exist and if defaultNullValue is not set, the change will fail.

description: The current data type of the column.

description: The created constraint name (if database supports names for NOT NULL constraints).

description: The attribute which is true if the NOT NULL constraint has 'ENABLE VALIDATE' set, or which is false if the NOT NULL constrain has 'ENABLE NOVALIDATE' set.

description: Makes a column nullable.

description: Name of the column to drop the constraint from

description: Current data type of the column

description: Adds a foreign key constraint to an existing column.

required: baseColumnNames baseTableName constraintName referencedColumnNames referencedTableName

description: Catalog name of the base table

description: Schema name of the base table

description: Name of the table containing the column to constraint

description: Name of column(s) to place the foreign key constraint on. Comma-separate if multiple

description: Name of the new foreign key constraint

description: Schema name of the referenced table

description: Schema name of the referenced table

description: Name of the table the foreign key points to

description: Column(s) the foreign key points to. Comma-separate if multiple

description: Is the foreign key deferrable

description: Is the foreign key initially deferred

description: ON DELETE functionality. Possible values: 'CASCADE', 'SET NULL', 'SET DEFAULT', 'RESTRICT', 'NO ACTION'

description: ON UPDATE functionality. Possible values: 'CASCADE', 'SET NULL', 'SET DEFAULT', 'RESTRICT', 'NO ACTION'

description: Shall be true if the foreign key should 'ENABLE VALIDATE' set, or false if the foreign key should 'ENABLE NOVALIDATE' set.

description: Drops an existing foreign key.

description: Name of the table containing the column constrained by the foreign key

description: Name of the foreign key constraint to drop

description: Drops all foreign key constraints for a table.

description: Catalog name of the table containing columns constrained by foreign keys

description: Schema name of the table containing columns constrained by foreign keys

description: Name of the table containing columns constrained by foreign keys

description: Adds a primary key out of an existing column or set of columns.

description: Name of the column(s) to create the primary key on. Comma separated if multiple

description: Name of primary key constraint

description: This is true if the primary key has 'ENABLE VALIDATE' set, or false if the primary key has 'ENABLE NOVALIDATE' set.

description: The dropPrimaryKey Change Type drops an existing primary key in the table.

description: The name of the primary key.

description: The index to drop.

description: Creates a lookup table containing values stored in a column and creates a foreign key to the new table.

required: existingColumnName existingTableName newColumnName newTableName

description: Name of the table containing the data to extract

description: Name of the column in the new table to create

description: Name of lookup table to create

description: Name of the column in the new table to create

description: Data type of the new table column

description: Name of the foreign-key constraint to create between the existing table and the lookup table

description: Converts an existing column to be an auto-increment (a.k.a 'identity') column.

description: Name of the column

description: When using generationType 'BY DEFAULT' then defaultOnNull = true allows the identity to be used if the identity column is referenced, but a value of NULL is specified.

description: Type of the generation in 'GENERATED %s AS IDENTITY'. ALWAYS | BY DEFAULT

description: Current data type of the column to make auto-increment

description: Initial integer value of the increment

description: Integer value the increment increments at each call

description: The addDefaultValue Change Type adds a default value to the database definition for the specified column.

description: The name of the column for which to add a default value.

description: The current data type of the column for which to add a default value.

description: The default value. Either this property or one of the other defaultValue* properties are required.

description: The attribute that sets the default value for a column of a numeric type. For example: integer, bigint, bigdecimal, and others.

description: The attribute that sets the default value for a column of a date type. For example: timestamp, datetime, date, and others.

description: The attribute that sets the default value for a column of a boolean type.

description: The attribute that sets the default value for a column using a function which returns value of the same type as the column has.

description: The attribute that sets value for a specified column by using the value of the existing sequence. With every new input, the next value of the sequence will be taken.

description: The attribute that sets a unique name for default constraint used for a specific column. It works only along with any of defaultValue* attributes listed.

description: Removes the database default value for a column.

description: Name of column to drop the default value from

description: Adds a unique constraint to an existing column or set of columns.

description: Name of the column(s) to create the unique constraint on. Comma separated if multiple

description: Name of the unique constraint

description: 'Tablespace' to create the index in. Corresponds to file group in mssql

description: True if this constraint is disabled, False otherwise

description: True if this constraint is deferrable, False otherwise

description: True if this constraint is initially deferred, False otherwise

description: Whether create a clustered index

description: Should be true if the unique constraint shall 'ENABLE VALIDATE' set, or false if the 'ENABLE NOVALIDATE' shall.

description: Drops an existing unique constraint.

description: Name of unique constraint to drop

description: Sets remarks on a table.

description: Comment to set on the table

description: The setColumnRemarks Change Type sets remarks on a column.

description: The name of the column

description: The comment to set on the column

description: The customChange type creates a custom Change Type class.

description: Loads data from a CSV file into an existing table when you add it to your changelog.

description: CSV file to load.

description: Whether the file path relative to the root changelog file rather than to the classpath.

description: Use prepared statements instead of insert statement strings if the database supports it.

description: Encoding of the CSV file (defaults to UTF-8).

description: Character separating the fields.

description: The quote character for string fields containing the separator character.

description: Lines starting with this are treated as comment and ignored.

description:
Loads or updates data from a CSV file into an existing table. Differs from loadData by issuing a SQL batch that checks for the existence of a record. If found, the record is UPDATEd, else the record is INSERTed. Also, generates DELETE statements for a rollback.

A value of NULL in a cell will be converted to a database NULL rather than the string 'NULL'

description: Lines starting with this are treated as comment and ignored.

description: CSV file to load

description: Whether the file path relative to the root changelog file rather than to the classpath.

description: Encoding of the CSV file (defaults to UTF-8)

description: Comma delimited list of the columns for the primary key

description: If true, records with no matching database record should be ignored

description: Character separating the fields.

description: The quote character for string fields containing the separator character.

description: Use prepared statements instead of insert statement strings if the DB supports it.

description: The executeCommand Change Type executes a system command.

description: The name of the executable to run

description: The list of operating systems on which to execute the command (taken from the os.name Java system property)

description: The timeout value for executable to run

description: Arguments for the executable

description: The value of the attribute (for example: '-param')

description: Arguments for the executable

description: The value of the attribute (for example: '-param')

description: Logs a message and continues execution.

description: Message to output

description: Target for message. Possible values: STDOUT, STDERR, FATAL, WARN, INFO, DEBUG. Default value: STDERR

description: Although Liquibase supports most standard SQL statements with its Change Types, there are times when you need the generated SQL to be different. The following examples show how to change data types or add additional vendor-specific clauses such as ENGINE INNODB to CREATE TABLE statements. Since 1.9

description: Specifies the list of Contexts in which to run the SQL modification. If you do not specify any context, every changeset will be applied. Since 2.0

description: Defines whether the SQL modification should be applied to rollback statements. The default value is false. Since 2.0

description: Adds SQL to the beginning of the statement.

description: Adds SQL to the end of the statement.

description: Replaces all instances of the text specified.

description: Replaces all instances of the regular expression specified.

description: The root of all Liquibase changes is the changelog file. Liquibase uses a changelog to sequentially list all changes made to your database. Think of it as a ledger. It is a file that contains a record of all your database changes (changesets). Liquibase uses this changelog record to audit your database and execute any changes that are not yet applied to your database.

description: Overrides the file name and path when creating the unique identifier of changesets. It is required when you want to move or rename changelogs.

description:
Controls how object names are quoted in the generated SQL or used in calls to the database. The names of objects are used differently in databases. For example, Oracle converts everything to uppercase (unless quoted). There are three possible values. The default value is LEGACY.
LEGACY - the same behavior as in Liquibase 2.0
QUOTE_ALL_OBJECTS - every object gets quoted. For example: person becomes "person".
QUOTE_ONLY_RESERVED_WORDS - reserved keywords and invalid column names are quoted.

description: Liquibase allows a dynamic substitution of properties in your changelog. The tokens to replace in your changelog are described using the ${property-name} syntax.

description: The name of the file from which the properties should be loaded. It will create a property for all properties in the file. The content of the file must follow the java properties file format.

description: The name of the parameter. Required if file is not set

description: The value of the property. Required if file is not set

description: Contexts in which the property is valid. Expected as a comma-separated list.

description: Boolean. Defines whether the property is global or limited to the actual DATABASECHANGELOG. It is given as true or false.

description:
The changeset tag is a unit of change that Liquibase executes on a database and which is used to group database Change Types together. A list of changes created by multiple changesets are tracked in a changelog.

A changeset is uniquely tagged by both an author and an id attributes (author:id), as well as the changelog file path. The id tag is only used as an identifier, it does not direct the order that changes are run and does not have to be an integer. If you do not know or do not want to save the actual author, use a placeholder value such as UNKNOWN. To execute the changeset, you must include both author and id.

description: Specifies an alpha-numeric identifier. Required

description: Specifies the creator of the changeset. Required

description: Controls whether a changeset is executed depending on runtime settings. Any string can be used for the context name and they are checked case-insensitively.

description: Controls whether a changeset is executed depending on runtime settings. Any string can be used for the label name and they are checked case-insensitively.

description: Executes the changeset the first time and each time the changeset has been changed.

description: Executes the changeset on every run, even if it has been run before.

description: Defines whether the migration will fail if an error occurs while executing the changeset. Default value is true.

description: Specifies whether the changeset can be ran as a single transaction (if possible). Default value is true.

description: Overrides the file name and path when creating the unique identifier of changesets. Required when moving or renaming changelog.

description:
Controls how object names are quoted in the generated SQL or used in calls to the database. Different databases do different things to the names of objects. For example, Oracle converts everything to uppercase (unless quoted). There are three possible values. The default value is LEGACY.
LEGACY - the same behavior as in Liquibase 2.0
QUOTE_ALL_OBJECTS - every object gets quoted. For example: person becomes "person".
QUOTE_ONLY_RESERVED_WORDS - reserved keywords and invalid column names are quoted.

description: Stores dates, versions, or any other string of value without using remarks (comments) attributes. Since 3.5

description: Overrides the order in the changelog from where the changeset with the runOrder="first|last" will be run. It is typically used when you want a changeset to be always executed after everything else but don't want to keep moving it to the end of the changelog. Setting the runOrder to last will automatically move it in the final changeset order.Since 3.5

description: Ignores the changeset from the execution. Since 3.6

description: Adds a checksum that is considered valid for this changeset, regardless of what is stored in the database. It is primarily used when you need to change a changeset and don't want errors thrown on databases on which it has already been run (not a recommended procedure). Special value "1:any" will match to any checksum and will not execute the changeset on ANY change. Since 1.7

description: Specifies the description of the changeset. XML comments will provide the same benefit. Future releases of Liquibase may be able to make use of <comment> tag comments to generate documentation.

description: If you do not want to undo a change in a rollback mode, you can use an empty rollback tag.

description: The <include> tag is used within your master changelog to reference other changelogs.

description: Name of the file you want to import required.

description: File path relative to the changelog file containing the element rather than to the classpath. Default: false

description: Appends a context (using an AND statement) to all contained changesets.

description: Appends a label to all contained changesets.

description: The <includeAll> tag allows you to specify a directory that contains multiple changelog files. It is used within your master changelog file to call on the directory and include all .xml files as changelog files, and all .sql files as individual changes.

description: Name of the path you want to reference.

description: Controls what happens if the path listed does not exist or is an empty directory. Default: false. If set to true, the update will fail.

description: File path relative to the changelog file containing the element rather than to the classpath. Default: false.

description: A string containing the name of the class you want to use for sorting.

description: A class name that allows you to create custom filters.

description: Appends a context (using an AND statement) to all contained changesets.


resources.json

title: Resource Configuration

description: The resource configurations mapped to tenant id

$ref: #/definitions/resourceTypeConfiguration

description: The configuration of a resource type

description: Configuration for the resource type for read models

description: Configuration for the resource type for the event store

required: readModels eventStore


title: Jdownloader2 Crawler Rule definition (multi-rule file)

description:
An array of crawler rules.
 - Anything prefixed as "HTML RegEx" will do Java-flavored pattern-matching on the page's raw (unmodified by javascript) HTML.

required: enabled name rule pattern

title: ENABLED flag

description:
- Type: Boolean
- Applies to rule: ALL
- Purpose: Enables or disables this rule

title: Cookie list for the site

description:
- Type: Array of length-2 Arrays
- Applies to rule: DIRECTHTTP, DEEPDECRYPT, SUBMITFORM or FOLLOWREDIRECT
- Purpose: A list of length-2 arrays in the form [["cookieName", "cookieValue"],[..., ...]...]. Here you can put in your personal cookies e.g. login cookies of websites which JD otherwise fails to parse.Also if "updateCookies" is enabled, JD will update these with all cookies it receives from the website(s) that match the "pattern" property.

examples: cookieName cookieValue

title: Updates site cookies

description:
- Type: Boolean
- Applies to rule: DIRECTHTTP, DEEPDECRYPT, SUBMITFORM or FOLLOWREDIRECT
- Purpose: If the target websites returns new cookies, save these inside this rule and update this rule.

title: Enable logging

description:
- Type: Boolean
- Applies to rule: ALL
- Purpose: Enable this for support purposes. Logs of your LinkCrawler Rules can be found in your JD install dir/logs/: LinkCrawlerRule.<RuleID>.log.0 and /LinkCrawlerDeep.*

title: Limits crawling depth

description:
- Type: Integer
- Applies to rule: ALL
- Purpose: How many layers deep do should your rule crawl (e.g. rule returns URLs matching the same rule again recursively - how often is this chain allowed to happen?)

title: Rule ID

description:
- Type: Integer
- Applies to rule: ALL
- Purpose: Auto generated ID of the rule. Normally leave this blank and JD2 will autoinsert.

title: Name of the rule

description:
- Type: String
- Applies to rule: ALL
- Purpose: name of the rule.

title: This rule will be used for all URLs matching this pattern

description:
- Type: RegEx
- Applies to rule: ALL
- Purpose: defines on which URLs will this rule apply by matching it to the pattern

format: regex

title: Type of the rule

enum: DEEPDECRYPT REWRITE DIRECTHTTP FOLLOWREDIRECT SUBMITFORM

title: Define package name and group al crawled urls for the current job under it

description:
- Type: HTML RegEx
- Applies to rule: DEEPDECRYPT
- Purpose: All URLs crawled by this rule will be grouped into the same package that is the HTML RegEx's first capture

title: Pattern to find extraction passwords for downloaded archives

description:
- Type: HTML RegEx or null
- Applies to rule: DEEPDECRYPT
- Purpose: Matches against archive extraction password that may be found as text inside the page's (unmodified by javascript) HTML code. First returned capture must be the password.

title: Find (and submit) HTML Form

title: URLs to look for inside the page.

description:
- Type: HTML RegEx or null
- Applies to rule: DEEPDECRYPT
- Purpose: Which URLs should this rule look for inside the page's (unmodified by javascript) HTML code. null (or blank) = auto scan and return all supported URLs found in HTML code.
Keep in mind that, if the url's found in the html are relative (e.g. starting with a slash / character instead of a protocol like http or a domain (website root) name) you WILL have to enclose the entire expression in quotes (outside of the parentheses that do capturing) like \"(...)\" AND enclose the part that would match the missing part of the url (i.e. from the protocol to the slash-or-other-character it begins with) in an 'OPTIONAL, NON CAPTURING' group (?:...)?. Resulting in the following pattern for pretty much every case \"((?:missing part of full url)?rest of url that is in the html)\"

title: Pattern for new URL

description:
- Type: String
- Applies to rule: REWRITE
- Purpose:Pattern for new URL, can use captures from "pattern" in the $1 form

$comment: Check if rule is not DEEPDECRYPT and disallow deepPattern. packageNamePattern and passwordPattern being non-null

const: DEEPDECRYPT

$comment: Check if rule is not REWRITE and disallow rewriteReplaceWith being non-null

const: REWRITE

$comment: Check if rule is not DIRECTHTTP, DEEPDECRYPT, SUBMITFORM or FOLLOWREDIRECT and disallow updateCookies being non-null

const: DIRECTHTTP

const: SUBMITFORM

const: FOLLOWREDIRECT


title: Roadrunner config file schema version 3

description: Roadrunner config file schema version 3

description: configuration version

description: Centrifugo server plugin. Docs: https://centrifugal.dev/

description: Centrifugo server proxy address (docs: https://centrifugal.dev/docs/server/proxy#grpc-proxy)

description: gRPC server API address (docs: https://centrifugal.dev/docs/server/server_api#grpc-api)

description: Use gRPC gzip compressor

description: Your application version

description: Your application name

default: roadrunner

description: Workers pool settings

$ref: #/definitions/WorkersPool

description: TLS settings

description: Path to the cert file

description: Path to the cert key file

description: TCP address:port for listening

description: Execute command or script after RR allocated a pool of workers. Command executed on the every pool allocation. For example, if you have 2 plugins: `http` and `grpc`, the `after_init` command would be fired twice.

description: Command to execute. It can be script or binary

examples:
php not-worker.php
sh script.sh
start script.bat

description: Script execute timeout

$ref: #/definitions/Duration

description: Environment variables for the worker processes

description: Execute command or script before RR starts allocating workers

description: Script execute timeout

description: Worker starting command, with any required arguments

description: User name (not UID) for the worker processes. An empty value means to use the RR process user

description: Group name (not GID) for the worker processes. An empty value means to use the RR process user

description: Worker relay can be: 'pipes', TCP (eg.: tcp://127.0.0.1:6002), or socket (eg.: unix:///var/run/rr.sock)

default: pipes

description: Timeout for relay connection establishing (only for socket and TCP port relay)

$ref: #/definitions/LogMode

default: development

$ref: #/definitions/LogLevel

default: debug

$ref: #/definitions/LogEncoding

default: console

description: Output

description: Errors only output

$ref: #/definitions/LogOutput

default: stderr

description: You can configure each plugin log messages individually

description: file logger options

description: path to the file

description: maximum file size in MB

description: The maximum number of days to retain old log files based on the timestamp encoded in their filename

description: The maximum number of old log files to retain

description: compress files to save a disk space

description: Workflow and activity mesh service, https://docs.temporal.io/docs/php/introduction/

description: Address of temporal server

description: Sticky cache size. Sticky workflow execution is the affinity between workflow tasks of a specific workflow execution to a specific worker. The benefit of sticky execution is that the workflow does not have to reconstruct state by replaying history from the beginning. The cache is shared between workers running within same process. This must be called before any worker is started. If not called, the default size of 10K (which may change) will be used

description: Namespace name for this client to work with

default: default

description: Temporal metrics

description: Metrics driver to use

enum: prometheus statsd

default: prometheus

description: Server metrics address

description: Metrics type

examples: summary histogram

description: Temporal metrics prefix

description: The host and port of the statsd server

description: The prefix to use in reporting to statsd

description: FlushInterval is the maximum interval for sending packets

description: FlushBytes specifies the maximum udp packet size you wish to send. If FlushBytes is unspecified, it defaults  to 1432 bytes, which is considered safe for local traffic.

description: Hashmap with tag:value values

$ref: #/definitions/Hashmap

description: Prefix for the tag

description: TagSeparator allows tags to be appended with a separator. If not specified tag keys and values are embedded to the stat name directly.

description: Activities pool settings

description: Temporal TLS configuration

description: Path to the key file

description: Path to the certificate

description: Path to the CA certificate

description: Client auth type

description: ServerName is used to verify the hostname on the returned certificates unless InsecureSkipVerify is given. It is also included in the client's handshake to support virtual hosting unless it is an IP address.

description: Key value storages plugin

description: boltdb driver

description: Driver which should be used for the storage

$ref: #/definitions/BoltDB

$ref: #/definitions/Memcached

$ref: #/definitions/Redis

$ref: #/definitions/Memory

description: Service plugin settings

description: User defined services

description: OpenTelemetry configuration

description: Use insecure endpoint

description: Use gzip compressor

description: Provides functionality to emit telemetry to consumers

enum: zipkin stdout stderr otlp jaeger jaeger_agent

description: Used for the http client to override the default URL

description: Consumer's endpoint

description: Client to send the spans

description: User's service name

description: User's service version

description: User defined headers

description: Host and port to listen on

description: Maximal incoming request size in megabytes. Zero means no limit

description: Send raw body (unescaped) to the PHP worker for the application/x-www-form-urlencoded content type

description: HTTP access logs

description: Middleware for the http plugin, order is important

enum: headers gzip static sendfile http_metrics cache proxy_ip_parser otel

description: Allow incoming requests only from the following subnets

description: RFC 7234 Souin cache: https://github.com/darkweak/souin/tree/master/plugins/roadrunner

description: The cache-handler API cache management

description: Default route basepath for every additional APIs to avoid conflicts with existing routes

description: Prometheus exposed metrics

description: Souin listing keys and cache management

description: cache keys configuration

description: If Souin is set after a CDN fill these information

description: Your provider API key if mandatory

description: The provider placed before Souin (e.g. fastly, cloudflare, akamai, varnish)

description: The strategy to purge the CDN cache based on tags (e.g. soft, hard)

description: If true, you'll be able to add custom keys than the ones defined under the surrogate_keys key

description: Override the cache name to use in the Cache-Status header

description: Use Olric or Etcd distributed storage

description: Default headers concatenated in stored keys

description: If distributed is set to true, you'll have to define either the etcd or olric section

description: Configure directly the Etcd client

description: Define multiple endpoints

description: Olric server

description: Regex to exclude from cache

description: Stale duration

description: Timeout configuration

description: Backend timeout before returning an HTTP unavailable response

description: Cache provider (badger, etcd, nutsdb, olric, depending the configuration you set) timeout before returning a miss

description: Default TTL

description: Set default value for Cache-Control response header if not set by upstream

description: Logs verbosity

enum: DEBUG INFO WARN DPANIC PANIC ERROR FATAL

description: Directory for file uploads. Empty value means to use $TEMP based on your OS

description: Deny files with the following extensions to upload

description: Allow files with the following extensions to upload

description: HTTP headers map

description: Allows to control CORS headers

description: Controls 'Access-Control-Allow-Origin' header value

description: Controls 'Access-Control-Allow-Headers' header value

description: Controls 'Access-Control-Allow-Methods' header value

description: Controls 'Access-Control-Allow-Credentials' header value

description: Controls 'Access-Control-Expose-Headers' header value

description: Controls 'Access-Control-Max-Age' header value (in seconds)

description: Automatically add headers to every request passed to PHP

description: Automatically add headers to every response

description: Static assets serving settings

description: Path to the directory with static assets

description: File extensions that should not be served

description: File extensions which should be served

description: Turn on etag computation for the static file

description: Use a weak generator (/W), it uses only filename to generate a CRC32 sum

description: Custom headers for the static files

description: Workers pool settings

description: SSL (Secure Sockets Layer) settings

description: Host and port to listen on

description: ACME certificates provider (Let's encrypt)

description: Directory to use as a certificate/pk, account info storage

description: User email, used to create LE account

description: Alternate port for the http challenge. Challenge traffic should be redirected to this port if overridden.

description: Alternate port for the tls-alpn-01 challenge. Challenge traffic should be redirected to this port if overridden.

description: Challenge types

description: Use production or staging endpoint. NOTE, try to use staging endpoint to make sure, that everything works correctly.

description: List of your domains to obtain certificates

description: Automatic redirect from http to https schema

description: Path to the cert file

description: Path to the cert key file

description: Path to the root certificate authority file

description: Client auth type

description: FastCGI frontend support

description: FastCGI connection DSN. Supported TCP and Unix sockets. An empty value disables this

description: HTTP/2 settings

description: HTTP/2 over non-encrypted TCP connection using H2C

description: Maximal concurrent streams count

description: Redis section.

description: Application metrics in Prometheus format (docs: https://roadrunner.dev/docs/beep-beep-metrics)

description: Prometheus client address (path /metrics added automatically).

description: Application-specific metrics (published using an RPC connection to the server)

description: Help message

description: Metrics labels

title: map[float]float

description: Health check endpoint (docs: https://roadrunner.dev/docs/beep-beep-health). If response code is 200 - it means at least one worker ready to serve requests. 500 - there are no workers ready to service requests.

description: Host and port to listen on (eg.: `127.0.0.1:2114`). Use the following URL: http://127.0.0.1:2114/health?plugin=http. Multiple plugins must be separated using & - http://127.0.0.1:2114/health?plugin=http&plugin=rpc where http and rpc are active (connected) plugins.

description: Response status code if a requested plugin not ready to handle requests. Valid for both /health and /ready endpoints

description: Automatically detect PHP file changes and reload connected services

description: Sync interval

description: Global patterns to sync

description: List of included for sync services (this is a map, where key name is a plugin name)

description: Directories to sync. If recursive is set to true, recursive sync will be applied only to the directories in 'dirs' section. Dot (.) means 'current working directory'

description: Recursive search for file patterns to add

description: Ignored folders

description: Service specific file pattens to sync

description: AMQP jobs driver

description: AMQP Uri to connect to the rabbitmq server https://www.rabbitmq.com/uri-spec.html

description: Path to the key file

description: Path to the cert file

description: Path to the CA certificate, defines the set of root certificate authorities that servers use if required to verify a client certificate. Used with the `client_auth_type` option.

description: Beanstalk jobs driver

description: Beanstalk server address

description: Beanstalk connect timeout

description: SQS jobs driver (https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html)

description: AccessKey ID

description: Secret Access key

description: AWS Region

description: AWS Session token

description: AWS SQS endpoint to connect

description: JOBS plugin

description: Number of threads which will try to obtain the job from the priority queue. Default is the number of workers+1

description: JOBS Push operation timeout in seconds

description: Size of the internal priority queue, if the internal PQ reach the max number of elements, the Push operation will be blocked

description: list of pipelines to be consumed by the server automatically at the start, keep empty if you want to start consuming manually

description: JOBS workers pool

description: List of broker pipelines associated with the drivers. This option is not required since you can declare pipelines in the runtime. Pipeline driver should exist.

description: JOBS plugin driver

enum: amqp sqs beanstalk boltdb memory nats kafka

description: driver configurations

description: Pipeline priority. If the job pushed to the pipeline has priority set to 0, it will inherit the pipeline's priority

description: Number of job to prefetch from the driver

description: Permissions for the boltdb database file

description: BoldDB file to create or DB to use

description: Consume all payloads, even not Job structured

description: Queue name

description: Exchange name

description: Redial timeout (in seconds). How long to try to reconnect to the AMQP server

description: Durable exchange (rabbitmq option: https://www.rabbitmq.com/tutorials/amqp-concepts.html#exchanges)

description: The consumer_id is identified by a string that is unique and scoped for all consumers on this channel

description: Auto-delete (exchange is deleted when last queue is unbound from it): https://www.rabbitmq.com/tutorials/amqp-concepts.html#exchanges

description: Auto-delete (queue that has had at least one consumer is deleted when last consumer unsubscribes)

description: Exchange type

description: Routing key for the queue

description: Declare a queue exclusive at the exchange

description: When multiple is true, this delivery and all prior unacknowledged deliveries on the same channel will be acknowledged. This is useful for batch processing of deliveries

description: Use rabbitmq mechanism to requeue the job on fail

description: Queue declare args, associated array (hashmap, key:val)

description: Auto create topic for the consumer/producer

description: Kafka producer options

description: Disable_idempotent disables idempotent produce requests, opting out of Kafka server-side deduplication in the face of reissued requests due to transient network problems. Idempotent production is strictly a win, but does require the IDEMPOTENT_WRITE permission on CLUSTER (pre Kafka 3.0), and not all clients can have that permission.

description: Sets the required acks for produced records

description: The maximum duration in seconds the broker will wait the receipt of the number of required_acks.

description: The level of compression to use on messages.

description: If enabled, the producer will ensure that exactly one copy of each message is written.

description: group_options sets the consumer group for the client to join and consume in. This option is required if using any other group options.

description: Kafka group ID

description: Switches the client to block rebalances whenever you poll

description: Kafka consumer options

description: List of the topics to consume. Regex also supported

description: consume_regexp sets the client to parse all topics passed to `topics` as regular expressions. When consuming via regex, every metadata request loads *all* topics, so that all topics can be passed to any regular expressions. Every topic is evaluated only once ever across all regular expressions; either it permanently is known to match, or is permanently known to not match.

description: consumer_offset sets the offset to start consuming from, or if OffsetOutOfRange is seen while fetching, to restart consuming from.

description: Partition offset type

enum: AtEnd At AfterMilli AtStart Relative WithEpoch

description: Value for the: At, AfterMilli, Relative and WithEpoch offsets

description: Topic to consume

description: Partition number

description: Partition offset type

description: Number of job to prefetch from the driver until ACK/NACK

description: Beanstalk internal tube priority

description: Tube name

description: If no job is available before this timeout has passed, Reserve returns a ConnError recording ErrTimeout

description: Get queue URL instead of declaring it

description: The duration (in seconds) for which the call waits for a message to arrive in the queue before returning. If a message is available, the call returns sooner than WaitTimeSeconds. If no messages are available and the wait time expires, the call returns successfully with an empty list of messages.

description: Queue name

title: map[string]number

title: map[string]string

description: NATS subject

description: NATS stream

description: The consumer will only start receiving messages that were created after the consumer was created

description: Consumer rate-limiter in bytes https://docs.nats.io/jetstream/concepts/consumers#ratelimit

description: Delete the stream when after pipeline was stopped

description: Delete message from the stream after successful acknowledge

description: Plugin to handle RAW TCP packets, available since RR 2.6.0

description: TCP servers to allocate

description: User defined TCP servers

description: PHP static workers pool

description: GRPC plugin

description: GRPC address to listen

description: Proto file to use, multiply files supported [SINCE 2.6]. As of [v2023.1.4], wilcards are allowed in the proto field

description: GRPC TLS configuration

description: Path to the key file

description: Path to the certificate

description: Path to the CA certificate

description: Client auth type

description: Maximum send message size

description: Maximum receive message size

description: MaxConnectionIdle is a duration for the amount of time after which an idle connection would be closed by sending a GoAway. Idleness duration is defined since the most recent time the number of outstanding RPCs became zero or the connection establishment

description: MaxConnectionAge is a duration for the maximum amount of time a connection may exist before it will be closed by sending a GoAway. A random jitter of +/-10% will be added to MaxConnectionAge to spread out connection storms

description: MaxConnectionAgeGrace is an additive period after MaxConnectionAge after which the connection will be forcibly closed

description: After a duration of this time if the server doesn't see any activity it pings the client to see if the transport is still alive. If set below 1s, a minimum value of 1s will be used instead

description: After having pinged for keepalive check, the server waits for a duration of Timeout and if no activity is seen even after that the connection is closed

description: GRPC workers pool

description: [SINCE 2.6] File server to serve static files

description: HTTP prefix

description: Directory to serve

description: When set to true, the server tries minimizing CPU usage by caching compressed files

description: Expiration duration for inactive file handlers. Units: seconds. Use negative number to disable

description: The value for the Cache-Control HTTP-header. Units: seconds

description: Enable range requests: https://developer.mozilla.org/en-US/docs/Web/HTTP/Range_requests

description: BoltDB config section

description: file name for the db

description: Access permission for the DB file.

description: TTL keys check interval in seconds. It's safe to use 1 second here, but can be a little costly to performance

description: In-memory config section

description: Address of the memcached node

description: Redis config section

description: Redis server addresses

description: Redis db number

description: dial timeout

description: In-memory config section

description: User defined service

description: Command to execute. Can be any command here which can be executed.

description: Environment variables for the process

description: Timeout for the process stop operation

description: Number of copies (processes) to start per command

description: Allowed time before stop

description: Remain process after exit. In other words, restart process after exit with any exit code

description: Number of seconds to wait before process restart

description: Static pool with PHP workers

description: Pool debug mode. Worker will be created right before RR passes request to it

description: Command to use for the pool. Will override the server's command

description: How many worker processes will be started. Zero (or nothing) means the number of logical CPUs

description: Maximal count of worker executions. Zero (or nothing) means no limit

description: Timeout for worker allocation. Zero means the default limit - 60s

description: Timeout for the pool.Reset operation (./rr reset). Zero means the default limit - 60s

description: Timeout for worker destroying before process killing. Zero means the default limit - 60s

description: Supervisor is used to control http workers

description: How often to check the state of the workers

description: Maximum time worker is allowed to live (soft limit). Zero means no limit

description: How long worker can spend in IDLE mode after first using (soft limit). Zero means no limit

description: Maximal worker memory usage in megabytes (soft limit). Zero means no limit

description: Maximal job lifetime (hard limit). Zero means no limit

description: TCP server

description: Address to listen

description: Data packets delimiter. Every send should end either with EOF or with the delimiter

description: Chunks that RR uses to read the data. In MB. If you expect big payloads on a TCP server, to reduce `read` syscalls, would be a good practice to use a fairly big enough buffer

description: Time duration

description: Host and port with tcp:// prefix

description: Host and port

description: Logging mode

description: Logging level

description: Encoding format

description: Hashmap

description: Hashmap with floats

description: NATS jobs driver

description: NATS server address

description: Kafka jobs driver

description: Kafka broker addresses

description: Mechanism used for the authentication

description: Kafka brokers

description: Username for authentication

description: Password for authentication

description: Optional for the SHA auth types. Empty by default

description: If true, suffixes the tokenauth=true extra attribute to the initial authentication message. Set this to true if the user and pass are from a delegation token. Optional for the SHA auth types. Empty by default

description: Zid is an optional authorization ID to use in authenticating

description: AWS Access key ID

description: AWS Secret Access key ID

description: SessionToken, if non-empty, is a session / security token to use for authentication. See the following link for more details: https://docs.aws.amazon.com/STS/latest/APIReference/welcome.html

description: UserAgent is the user agent to for the client to use when connecting to Kafka, overriding the default franz-go/<runtime.Version()>/<hostname>. Setting a UserAgent allows authorizing based on the aws:UserAgent condition key; see the following link for more details: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-useragent

description: Boltdb jobs driver


bitrise.json

$ref: #/definitions/BitriseDataModel

$ref: #/definitions/AppModel

$ref: #/definitions/TriggerMapItemModel

$ref: #/definitions/PipelineModel

$ref: #/definitions/StageModel

$ref: #/definitions/WorkflowModel

$ref: #/definitions/BrewDepModel

$ref: #/definitions/AptGetDepModel

$ref: #/definitions/CheckOnlyDepModel

$ref: #/definitions/WorkflowStageConfigModel

format: date-time

$ref: #/definitions/StepSourceModel

$ref: #/definitions/StepToolkitModel

$ref: #/definitions/DepsModel

$ref: #/definitions/BashStepToolkitModel

$ref: #/definitions/GoStepToolkitModel


meta.json

const: AIX

title: Name

default: all

title: AIXPlatformModel

const: Alpine

title: Name

title: AlpinePlatformModel

const: Amazon Linux

title: Name

title: Amazon Linux 2PlatformModel

const: Amazon

title: Name

title: AmazonPlatformModel

const: ArchLinux

title: Name

title: ArchLinuxPlatformModel

const: ClearLinux

title: Name

title: ClearLinuxPlatformModel

const: Cumulus

title: Name

title: CumulusPlatformModel

const: Debian

title: Name

enum: bookworm bullseye buster etch jessie lenny sid squeeze stretch wheezy all

title: DebianPlatformModel

const: DellOS

title: Name

title: DellOSPlatformModel

markdownDescription:
See https://docs.ansible.com/ansible/latest/playbook_guide/playbooks_reuse_roles.html#role-dependencies and https://github.com/ansible/ansible/blob/devel/lib/ansible/playbook/role/metadata.py#L79

Other keys are treated as role [parameters](https://docs.ansible.com/ansible/latest/user_guide/playbooks_reuse_roles.html#passing-different-parameters).

title: Become

title: Name

title: Role

enum: hg git

title: Scm

title: Src

title: Tags

type: array string

title: Vars

title: Version

title: When

title: Dependency entry

const: Devuan

title: Name

enum: ascii beowulf ceres jessie all

title: DevuanPlatformModel

const: DragonFlyBSD

title: Name

title: DragonFlyBSDPlatformModel

const: EL

title: Name

title: ELPlatformModel

const: Fedora

title: Name

title: FedoraPlatformModel

const: FreeBSD

title: Name

title: FreeBSDPlatformModel

$comment: Standalone role, so we require several fields.

required: author description license min_ansible_version

$comment: Collection roles do not use most galaxy fields.

$comment: If standalone is false, then we have a collection role and only description is required

title: Author

markdownDescription: Only valid for old standalone roles.

title: Company

title: Description

title: Galaxy Tags

markdownDescription: Optionally specify the branch Galaxy will use when accessing the GitHub repo for this role

title: GitHub Branch

title: Issue Tracker Url

title: License

title: Min Ansible Container Version

title: Min Ansible Version

markdownDescription: Used by molecule and ansible-lint to compute FQRN for roles outside collections

title: Namespace Name

title: Role Name

description: Set to true for old standalone roles, or false for new collection roles.

title: Standalone

title: GalaxyInfoModel

title: Name

title: GenericBSDPlatformModel

title: Name

title: GenericLinuxPlatformModel

title: Name

title: GenericUNIXPlatformModel

title: Name

title: GentooPlatformModel

title: Name

title: HardenedBSDPlatformModel

title: Name

title: IOSPlatformModel

title: Name

title: JunosPlatformModel

title: Name

title: KaliPlatformModel

title: Name

title: MacOSXPlatformModel

title: Name

title: MageiaPlatformModel

title: Name

title: NXOSPlatformModel

title: Name

title: NetBSDPlatformModel

title: Name

title: OpenBSDPlatformModel

title: Name

title: OpenWrtPlatformModel

title: Name

title: OracleLinuxPlatformModel

title: Name

title: PAN-OSPlatformModel

title: Name

title: SLESPlatformModel

title: Name

title: SmartOSPlatformModel

title: Name

title: SolarisPlatformModel

title: Name

title: SynologyPlatformModel

title: Name

title: TMOSPlatformModel

title: Name

enum: artful bionic cosmic cuttlefish disco eoan focal groovy hirsute impish jammy lucid maverick natty oneiric precise quantal raring saucy trusty utopic vivid wily xenial yakkety zesty all

title: UbuntuPlatformModel

title: Name

title: Void LinuxPlatformModel

title: Name

title: WindowsPlatformModel

title: Name

title: aosPlatformModel

markdownDescription: See [Using collections in roles](https://docs.ansible.com/ansible/latest/user_guide/collections_using.html#using-collections-in-roles) and [collection naming conventions](https://docs.ansible.com/ansible/latest/dev_guide/developing_modules_in_groups.html#naming-conventions)

title: Collections

title: Name

title: eosPlatformModel

title: Name

enum: Big-Sur Catalina High-Sierra Mojave Monterey Sierra all

title: macOSPlatformModel

title: Name

title: opensusePlatformModel

title: Name

title: os10PlatformModel

title: Platforms

title: Name

title: vCenterPlatformModel

title: Name

title: vSpherePlatformModel

title: Allow Duplicates

title: Dependencies

title: Ansible Meta Schema v1/v2


vtestunit-schema.json

title: Json schema for test unit configuration files

title: Version

description: Json schema version for the test unit configuration file. Acceptance criteria: equal major version, less/equal minor and patch version.

title: Include files

description: Include a different file (similar to #include of the c preprocessor). The order of includes does not matter. Circular / multiple includes are resolved correctly.

title: Test Unit Information

description: Miscellaneous test unit information can be defined. After the execution they are available in the test report.

description: Caption of the test unit.

description: Description of the test unit.

description: Version of the test unit.

description: Information on the test developer(s). A sequence of key-value pairs that can be freely selected.

prename: Max

surname: S.

department: Department A

prename: Linda

department: Department B

description: Additional key-value pairs. One key 'name' is required, the other keys can be freely selected.

SUT

customerName: Customer A

caption: This is a caption

description: This is a description

Software Under Test

CustomerName: My customer

title: Test Unit Implementation

description: Source artifacts of the test unit. Absolute and relative paths are allowed. Relative path specifications are resolved relative to the vtestunit.yaml file.

title: Source File Path

description: Path to a source file (.can/.canencr/.vtesttree.yaml).

title: CAPL Library Path

description: Path to a CAPL library file (.dll).

title: Modeling Library Path

description: Path to a modeling library file (.vmodule).


jx-schema.json

$ref: #/definitions/ProjectConfig

$ref: #/definitions/LocalObjectReference

$ref: #/definitions/KeyToPath

$ref: #/definitions/DownwardAPIVolumeFile

$ref: #/definitions/ObjectFieldSelector

$ref: #/definitions/ResourceFieldSelector

$ref: #/definitions/Quantity

$ref: #/definitions/EnvVarSource

$ref: #/definitions/ConfigMapKeySelector

$ref: #/definitions/SecretKeySelector


drupal-links-contextual.json

title: The static title for the local action

title: The translation context for the title value.

title: The route name used to generate a link

title: Route parameters for generating a link

title: The contextual links group

title: The weight of the local action

title: Array of link options

title: Class for local action implementations

title: Deriver class

title: Cache tags

title: JSON schema for Drupal contextual links file


description: Schema to validate Windows CE JSON files given as input to DL-Config to generate Scan2Deploy barcodes

$id: #/properties/layout

title: Layout Schema

title: Description Schema

$id: #/properties/global

title: Global-Section Schema

description: Section used to configure application scoped settings

title: Target-Path Schema

description: Base destination folder where archive/folder will be inflated

default: \FlashDisk

$id: #/properties/global/properties/action

enum: stay close warm-boot cold-boot clean-boot

title: Action Schema

description: Specifies final action performed by the application at the end of the staging process

default: cold-boot

title: Ping-Timeout Schema

description: The timeout value used when attempting to reach the host server

$id: #/properties/settings

title: Settings-Section Schema

description: Section used to configure inner device settings

enum: active-sync-usb active-sync-com usblan mass-storage

title: USB-Function Schema

description: USB communication function to use

default: active-sync-usb

$id: #/properties/network

title: Network-Section Schema

description: Section used to configure device Wi-Fi network

$id: #/properties/network/properties/profile

title: Profile Schema

description: "Friendly" name to associate with the network connection

default: datalogic

$id: #/properties/network/properties/essid

title: Essid Schema

description: Wireless network ESSID

default: tsunami

$id: #/properties/network/properties/mode

title: Mode Schema

description: Wireless connection mode

default: open

title: Mode-Key Schema

description: Wireless network key for 'wep-40', 'wep-104', 'wpa-psk', and 'wpa2-psk' networks

$id: #/properties/network/properties/index

title: Index Schema

description: Wireless network key index for 'wep-40' and 'wep-104' networks

enum: none peap tls ttls fast leap

title: Eap-Method Schema

description: Configures the EAP authentication method

title: Eap-Username Schema

description: Username for the EAP method

title: Eap-Password Schema

description: Password for EAP method

enum: password token certificate unknown

title: Credentials-Type Schema

description: Indicates the EAP credentials type

default: password

enum: user logon profile auto unknown

title: Credentials-Source Schema

description: Indicates the EAP credentials source

default: user

title: Validate-Server Schema

description: Indicates if the server certificate should be validated

title: Connect-To-Server Schema

description: Indicates if only the servers listed in the 'connect-to-server-names' list should be connected to

title: Connect-To-Server-Names Schema

description: Semi-colon separated list of servers that are valid to connect to during server certificate validation

title: Server-Cert-Name Schema

description: "Friendly" name of the server digital certificate that should be validated

title: Outer-Identity Schema

description: The outer-identity of the EAP method

title: Fast-Reconnect Schema

description: Indicate if fast reconnect should be enabled

enum: eap-tls eap-MsChapV2 eap-gtc

title: Inner-Method Schema

description: Inner EAP authentication method to use

default: eap-tls

title: Auto-Pac Schema

description: Indicates if automatic PAC provisioning is used for an EAP-FAST network

title: Pac-File-Path Schema

description: Full path to the PAC file for manual PAC provisioning

title: Pac-Aid-Info Schema

description: PAC authority identity (AID) information used to select PAC from a list of PACs on the device

$id: #/properties/deployment

title: Deployment-Section Schema

description: Section used to download a ZIP archive from a server and inflate it to the 'target-path' folder

enum: http https

title: Scheme Schema

description: Deployment download scheme to use

default: http

$id: #/properties/deployment/properties/host

title: Host Schema

description: Host name or internet protocol address of the server from which the resource is to be fetched

$id: #/properties/deployment/properties/port

title: Port Schema

description: TCP/IP port to be used to contact the server

$id: #/properties/deployment/properties/path

title: Path Schema

description: Path to server resource to download, complete with query string if needed

$id: #/properties/shell

title: Shell-Section Schema

description: Section for executable shell commands to be performed in the final staging phase

$id: #/properties/shell/properties/cmds

title: Cmds Schema

description: Each object in 'cmds' is a shell command to execute in the final phase of staging

title: Items Schema

title: App-Name Schema

description: Full path to the application to be executed

title: Args Schema

description: Command line arguments

title: CE-Scan2Deploy Schema


title: Jdownloader2 Crawler Rule definition (single-rule file)

description:
A crawler rule.
 - Anything prefixed as "HTML RegEx" will do Java-flavored pattern-matching on the page's raw (unmodified by javascript) HTML.

title: ENABLED flag

description:
- Type: Boolean
- Applies to rule: ALL
- Purpose: Enables or disables this rule

title: Cookie list for the site

description:
- Type: Array of length-2 Arrays
- Applies to rule: DIRECTHTTP, DEEPDECRYPT, SUBMITFORM or FOLLOWREDIRECT
- Purpose: A list of length-2 arrays in the form [["cookieName", "cookieValue"],[..., ...]...]. Here you can put in your personal cookies e.g. login cookies of websites which JD otherwise fails to parse.Also if "updateCookies" is enabled, JD will update these with all cookies it receives from the website(s) that match the "pattern" property.

title: Updates site cookies

description:
- Type: Boolean
- Applies to rule: DIRECTHTTP, DEEPDECRYPT, SUBMITFORM or FOLLOWREDIRECT
- Purpose: If the target websites returns new cookies, save these inside this rule and update this rule.

title: Enable logging

description:
- Type: Boolean
- Applies to rule: ALL
- Purpose: Enable this for support purposes. Logs of your LinkCrawler Rules can be found in your JD install dir/logs/: LinkCrawlerRule.<RuleID>.log.0 and /LinkCrawlerDeep.*

title: Limits crawling depth

description:
- Type: Integer
- Applies to rule: ALL
- Purpose: How many layers deep do should your rule crawl (e.g. rule returns URLs matching the same rule again recursively - how often is this chain allowed to happen?)

title: Rule ID

description:
- Type: Integer
- Applies to rule: ALL
- Purpose: Auto generated ID of the rule. Normally leave this blank and JD2 will autoinsert.

title: Name of the rule

description:
- Type: String
- Applies to rule: ALL
- Purpose: name of the rule.

description:
- Type: RegEx
- Applies to rule: ALL
- Purpose: defines on which URLs will this rule apply by matching it to the pattern

title: Type of the rule

enum: DEEPDECRYPT REWRITE DIRECTHTTP FOLLOWREDIRECT SUBMITFORM

description:
- Type: HTML RegEx
- Applies to rule: DEEPDECRYPT
- Purpose: All URLs crawled by this rule will be grouped into the same package that is the HTML RegEx's first capture

description:
- Type: HTML RegEx or null
- Applies to rule: DEEPDECRYPT
- Purpose: Matches against archive extraction password that may be found as text inside the page's (unmodified by javascript) HTML code. First returned capture must be the password.

title: Find (and submit) HTML Form

title: URLs to look for inside the page.

description:
- Type: HTML RegEx or null
- Applies to rule: DEEPDECRYPT
- Purpose: Which URLs should this rule look for inside the page's (unmodified by javascript) HTML code. null (or blank) = auto scan and return all supported URLs found in HTML code.
Keep in mind that, if the url's found in the html are relative (e.g. starting with a slash / character instead of a protocol like http or a domain (website root) name) you WILL have to enclose the entire expression in quotes (outside of the parentheses that do capturing) like \"(...)\" AND enclose the part that would match the missing part of the url (i.e. from the protocol to the slash-or-other-character it begins with) in an 'OPTIONAL, NON CAPTURING' group (?:...)?. Resulting in the following pattern for pretty much every case \"((?:missing part of full url)?rest of url that is in the html)\"

title: Pattern for new URL

description:
- Type: String
- Applies to rule: REWRITE
- Purpose:Pattern for new URL, can use captures from "pattern" in the $1 form

const: DEEPDECRYPT

const: REWRITE

const: DIRECTHTTP