typo3.json

the Typo3 CMS

Type object
File match **/sites/*/config.yaml **/sites/*/config.yml
Schema URL https://catalog.lintel.tools/schemas/schemastore/typo3-json/latest.json
Source https://www.schemastore.org/typo3.json

Validate with Lintel

npx @lintel/lintel check
Type: object

Properties

base string required

Base URL. This is the URL under which this site is available

rootPageId integer required

ID of the page where this site begins

languages language[] required
baseVariants baseVariants[]
errorHandling errorHandling[]
websiteTitle string

Default website title

routeEnhancers Record<string, object>

routeEnhancers transform arguments into nice urls. Docs can be found at https://docs.typo3.org/m/typo3/reference-coreapi/master/en-us/ApiOverview/Routing/Index.html

settings object
1 nested properties
redirects object
4 nested properties
autoUpdateSlugs boolean

Automatically update slugs of all sub pages. Default: true

autoCreateRedirects boolean

Automatically create redirects for pages with a new slug (works only in LIVE workspace). Default: true

redirectTTL integer

Time To Live in days for redirect records to be created - 0 disables TTL, no expiration. Default: 0

httpStatusCode integer

HTTP status code for the redirect, see https://developer.mozilla.org/en-US/docs/Web/HTTP/Redirections#Temporary_redirections. Default: 307

Any of: integer integer
sitePackage string

Extension key for site setup (used by EXT:bolt)

solr_core_read string

EXT:solr default core for read

solr_enabled_read boolean

EXT:solr enable default solr read

solr_host_read string

EXT:solr default host for read

solr_password_read string

EXT:solr password for read

solr_username_read string

EXT:solr username for read

solr_port_read string

EXT:solr port for read

solr_scheme_read string

EXT:solr scheme for read

Any of: string string
solr_use_write_connection boolean

EXT:solr use write connection

Definitions

enhancerRoute object
routePath string required
_controller string required
pattern=^([a-zA-Z0-9]{1,30})::([a-zA-Z0-9]{1,30})$
_arguments Record<string, string>
baseVariants object
base string required
condition string required
redirects object
autoUpdateSlugs boolean

Automatically update slugs of all sub pages. Default: true

autoCreateRedirects boolean

Automatically create redirects for pages with a new slug (works only in LIVE workspace). Default: true

redirectTTL integer

Time To Live in days for redirect records to be created - 0 disables TTL, no expiration. Default: 0

httpStatusCode integer

HTTP status code for the redirect, see https://developer.mozilla.org/en-US/docs/Web/HTTP/Redirections#Temporary_redirections. Default: 307

Any of: integer integer
errorHandling object
errorCode integer | integer

Make sure to have at least 0 (not defined otherwise) configured in order to serve helpful error messages to your visitors.

errorHandler string

How to handle Errors

Default: "Page"
Values: "Page" "Fluid" "PHP"
staticRoutes object
route string required

Static Route Name

type string required

Route Type

Values: "uri" "staticText"
localeMap object
locale string
value string
language object
title string required

Title

enabled boolean required

Visible in Frontend

languageId integer required

ID of the related sys_language record

Examples: 1
base string required

Use a full qualified domain "https://www.mydomain.fr/" or "/fr/". Use "/" to keep the main URL for the default language. Add language specific suffixes to use those, or configure complete URLs for independent domains.

Default: "/"
locale string required

Used for localized date and currency formats. E.g. "de_DE" or "en_US.UTF-8".

baseVariants baseVariants[]
typo3Language string | string

Select the language to be used from translation files. Keep default if no translation files are available. Deprecated with TYPO3 12.3

iso-639-1 string

ISO 639-1 code of the Language

Values: "ab" "aa" "af" "ak" "sq" "am" "ar" "an" "hy" "as" "av" "ae" "ay" "az" "bm" "ba" "eu" "be" "bn" "bh" "bi" "bs" "br" "bg" "my" "ca" "ch" "ce" "ny" "zh" "cv" "kw" "co" "cr" "hr" "cs" "da" "dv" "nl" "dz" "en" "eo" "et" "ee" "fo" "fj" "fi" "fr" "ff" "gl" "ka" "de" "el" "gn" "gu" "ht" "ha" "he" "hz" "hi" "ho" "hu" "ia" "id" "ie" "ga" "ig" "ik" "io" "is" "it" "iu" "ja" "jv" "kl" "kn" "kr" "ks" "kk" "km" "ki" "rw" "ky" "kv" "kg" "ko" "ku" "kj" "la" "lb" "lg" "li" "ln" "lo" "lt" "lu" "lv" "gv" "mk" "mg" "ms" "ml" "mt" "mi" "mr" "mh" "mn" "na" "nv" "nd" "ne" "ng" "nb" "nn" "no" "ii" "nr" "oc" "oj" "cu" "om" "or" "os" "pa" "pi" "fa" "pl" "ps" "pt" "qu" "rm" "rn" "ro" "ru" "sa" "sc" "sd" "se" "sm" "sg" "sr" "gd" "sn" "si" "sk" "sl" "so" "st" "es" "su" "sw" "ss" "sv" "ta" "te" "tg" "th" "ti" "bo" "tk" "tl" "tn" "to" "tr" "ts" "tt" "tw" "ty" "ug" "uk" "ur" "uz" "ve" "vi" "vo" "wa" "cy" "wo" "fy" "xh" "yi" "yo" "za" "zu"
navigationTitle string

Used within language-related menus

hreflang string

Used within for "lang" and "hreflang" attributes

direction string

Language direction for "dir" attribute

Values: "" "ltr" "rtl"
flag string
Values: "global" "ad" "ae" "af" "ag" "ai" "al" "am" "an" "ao" "aq" "ar" "as" "at" "au" "aw" "ax" "az" "ba" "bb" "bd" "be" "bf" "bg" "bh" "bi" "bj" "bl" "bm" "bn" "bo" "bq" "br" "bs" "bt" "bv" "bw" "by" "bz" "ca" "catalonia" "cc" "cd" "cf" "cg" "ch" "ci" "ck" "cl" "cm" "cn" "co" "cr" "cs" "cu" "cv" "cw" "cx" "cy" "cz" "de" "dj" "dk" "dm" "do" "dz" "ec" "ee" "eg" "eh" "en-us-gb" "gb-eng" "er" "es" "et" "eu" "fi" "fj" "fk" "fm" "fo" "fr" "ga" "gb" "gd" "ge" "gf" "gg" "gh" "gi" "gl" "gm" "gn" "gp" "gq" "gr" "gs" "gt" "gu" "gw" "gy" "hk" "hm" "hn" "hr" "ht" "hu" "id" "ie" "il" "im" "in" "io" "iq" "ir" "is" "it" "jm" "jo" "jp" "ke" "kg" "kh" "ki" "kl" "km" "kn" "kp" "kr" "kw" "ky" "kz" "la" "lb" "lc" "li" "lk" "lr" "ls" "lt" "lu" "lv" "ly" "ma" "mc" "md" "me" "mf" "mg" "mh" "mi" "mk" "ml" "mm" "mn" "mo" "mp" "mq" "mr" "ms" "mt" "mu" "mv" "mw" "mx" "my" "mz" "na" "nc" "ne" "nf" "ng" "ni" "gb-nir" "nl" "no" "np" "nr" "nu" "nz" "om" "pa" "pe" "pf" "pg" "ph" "pk" "pl" "pm" "pn" "pr" "ps" "pt" "pw" "py" "qa" "qc" "re" "ro" "rs" "ru" "rw" "sa" "sb" "sc" "gb-sct" "sd" "se" "sg" "sh" "si" "sj" "sk" "sl" "sm" "sn" "so" "sr" "ss" "st" "sv" "sx" "sy" "sz" "tc" "td" "tf" "tg" "th" "tj" "tk" "tl" "tm" "tn" "to" "tr" "tt" "tv" "tw" "tz" "ua" "ug" "um" "us" "uy" "uz" "va" "vc" "ve" "vg" "vi" "vn" "vu" "gb-wls" "wf" "ws" "ye" "yt" "za" "zm" "zw"
websiteTitle string

With this language based Website title, you can override the Website title for this language

fallbackType string

Fallback Type

Default: "strict"
Values: "strict" "fallback" "free"
fallbacks string

Fallback to other Language(s) - order is important! Comma separated list