• File Configuration Reference

    File Configuration Reference

    Dynamic configuration with files

    1. [http]
    2.   [http.routers]
    3.     [http.routers.Router0]
    4.       entryPoints = ["foobar", "foobar"]
    5.       middlewares = ["foobar", "foobar"]
    6.       service = "foobar"
    7.       rule = "foobar"
    8.       priority = 42
    9.       [http.routers.Router0.tls]
    10.         options = "foobar"
    11.         certResolver = "foobar"
    13.         [[http.routers.Router0.tls.domains]]
    14.           main = "foobar"
    15.           sans = ["foobar", "foobar"]
    17.         [[http.routers.Router0.tls.domains]]
    18.           main = "foobar"
    19.           sans = ["foobar", "foobar"]
    20.     [http.routers.Router1]
    21.       entryPoints = ["foobar", "foobar"]
    22.       middlewares = ["foobar", "foobar"]
    23.       service = "foobar"
    24.       rule = "foobar"
    25.       priority = 42
    26.       [http.routers.Router1.tls]
    27.         options = "foobar"
    28.         certResolver = "foobar"
    30.         [[http.routers.Router1.tls.domains]]
    31.           main = "foobar"
    32.           sans = ["foobar", "foobar"]
    34.         [[http.routers.Router1.tls.domains]]
    35.           main = "foobar"
    36.           sans = ["foobar", "foobar"]
    37.   [http.services]
    38.     [http.services.Service01]
    39.       [http.services.Service01.loadBalancer]
    40.         passHostHeader = true
    41.         [http.services.Service01.loadBalancer.sticky]
    42.           [http.services.Service01.loadBalancer.sticky.cookie]
    43.             name = "foobar"
    44.             secure = true
    45.             httpOnly = true
    47.         [[http.services.Service01.loadBalancer.servers]]
    48.           url = "foobar"
    50.         [[http.services.Service01.loadBalancer.servers]]
    51.           url = "foobar"
    52.         [http.services.Service01.loadBalancer.healthCheck]
    53.           scheme = "foobar"
    54.           path = "foobar"
    55.           port = 42
    56.           interval = "foobar"
    57.           timeout = "foobar"
    58.           hostname = "foobar"
    59.           [http.services.Service01.loadBalancer.healthCheck.headers]
    60.             name0 = "foobar"
    61.             name1 = "foobar"
    62.         [http.services.Service01.loadBalancer.responseForwarding]
    63.           flushInterval = "foobar"
    64.     [http.services.Service02]
    65.       [http.services.Service02.mirroring]
    66.         service = "foobar"
    68.         [[http.services.Service02.mirroring.mirrors]]
    69.           name = "foobar"
    70.           percent = 42
    72.         [[http.services.Service02.mirroring.mirrors]]
    73.           name = "foobar"
    74.           percent = 42
    75.     [http.services.Service03]
    76.       [http.services.Service03.weighted]
    78.         [[http.services.Service03.weighted.services]]
    79.           name = "foobar"
    80.           weight = 42
    82.         [[http.services.Service03.weighted.services]]
    83.           name = "foobar"
    84.           weight = 42
    85.         [http.services.Service03.weighted.sticky]
    86.           [http.services.Service03.weighted.sticky.cookie]
    87.             name = "foobar"
    88.             secure = true
    89.             httpOnly = true
    90.   [http.middlewares]
    91.     [http.middlewares.Middleware00]
    92.       [http.middlewares.Middleware00.addPrefix]
    93.         prefix = "foobar"
    94.     [http.middlewares.Middleware01]
    95.       [http.middlewares.Middleware01.basicAuth]
    96.         users = ["foobar", "foobar"]
    97.         usersFile = "foobar"
    98.         realm = "foobar"
    99.         removeHeader = true
    100.         headerField = "foobar"
    101.     [http.middlewares.Middleware02]
    102.       [http.middlewares.Middleware02.buffering]
    103.         maxRequestBodyBytes = 42
    104.         memRequestBodyBytes = 42
    105.         maxResponseBodyBytes = 42
    106.         memResponseBodyBytes = 42
    107.         retryExpression = "foobar"
    108.     [http.middlewares.Middleware03]
    109.       [http.middlewares.Middleware03.chain]
    110.         middlewares = ["foobar", "foobar"]
    111.     [http.middlewares.Middleware04]
    112.       [http.middlewares.Middleware04.circuitBreaker]
    113.         expression = "foobar"
    114.     [http.middlewares.Middleware05]
    115.       [http.middlewares.Middleware05.compress]
    116.     [http.middlewares.Middleware06]
    117.       [http.middlewares.Middleware06.digestAuth]
    118.         users = ["foobar", "foobar"]
    119.         usersFile = "foobar"
    120.         removeHeader = true
    121.         realm = "foobar"
    122.         headerField = "foobar"
    123.     [http.middlewares.Middleware07]
    124.       [http.middlewares.Middleware07.errors]
    125.         status = ["foobar", "foobar"]
    126.         service = "foobar"
    127.         query = "foobar"
    128.     [http.middlewares.Middleware08]
    129.       [http.middlewares.Middleware08.forwardAuth]
    130.         address = "foobar"
    131.         trustForwardHeader = true
    132.         authResponseHeaders = ["foobar", "foobar"]
    133.         [http.middlewares.Middleware08.forwardAuth.tls]
    134.           ca = "foobar"
    135.           caOptional = true
    136.           cert = "foobar"
    137.           key = "foobar"
    138.           insecureSkipVerify = true
    139.     [http.middlewares.Middleware09]
    140.       [http.middlewares.Middleware09.headers]
    141.         accessControlAllowCredentials = true
    142.         accessControlAllowHeaders = ["foobar", "foobar"]
    143.         accessControlAllowMethods = ["foobar", "foobar"]
    144.         accessControlAllowOrigin = "foobar"
    145.         accessControlExposeHeaders = ["foobar", "foobar"]
    146.         accessControlMaxAge = 42
    147.         addVaryHeader = true
    148.         allowedHosts = ["foobar", "foobar"]
    149.         hostsProxyHeaders = ["foobar", "foobar"]
    150.         sslRedirect = true
    151.         sslTemporaryRedirect = true
    152.         sslHost = "foobar"
    153.         sslForceHost = true
    154.         stsSeconds = 42
    155.         stsIncludeSubdomains = true
    156.         stsPreload = true
    157.         forceSTSHeader = true
    158.         frameDeny = true
    159.         customFrameOptionsValue = "foobar"
    160.         contentTypeNosniff = true
    161.         browserXssFilter = true
    162.         customBrowserXSSValue = "foobar"
    163.         contentSecurityPolicy = "foobar"
    164.         publicKey = "foobar"
    165.         referrerPolicy = "foobar"
    166.         featurePolicy = "foobar"
    167.         isDevelopment = true
    168.         [http.middlewares.Middleware09.headers.customRequestHeaders]
    169.           name0 = "foobar"
    170.           name1 = "foobar"
    171.         [http.middlewares.Middleware09.headers.customResponseHeaders]
    172.           name0 = "foobar"
    173.           name1 = "foobar"
    174.         [http.middlewares.Middleware09.headers.sslProxyHeaders]
    175.           name0 = "foobar"
    176.           name1 = "foobar"
    177.     [http.middlewares.Middleware10]
    178.       [http.middlewares.Middleware10.ipWhiteList]
    179.         sourceRange = ["foobar", "foobar"]
    180.         [http.middlewares.Middleware10.ipWhiteList.ipStrategy]
    181.           depth = 42
    182.           excludedIPs = ["foobar", "foobar"]
    183.     [http.middlewares.Middleware11]
    184.       [http.middlewares.Middleware11.inFlightReq]
    185.         amount = 42
    186.         [http.middlewares.Middleware11.inFlightReq.sourceCriterion]
    187.           requestHeaderName = "foobar"
    188.           requestHost = true
    189.           [http.middlewares.Middleware11.inFlightReq.sourceCriterion.ipStrategy]
    190.             depth = 42
    191.             excludedIPs = ["foobar", "foobar"]
    192.     [http.middlewares.Middleware12]
    193.       [http.middlewares.Middleware12.passTLSClientCert]
    194.         pem = true
    195.         [http.middlewares.Middleware12.passTLSClientCert.info]
    196.           notAfter = true
    197.           notBefore = true
    198.           sans = true
    199.           [http.middlewares.Middleware12.passTLSClientCert.info.subject]
    200.             country = true
    201.             province = true
    202.             locality = true
    203.             organization = true
    204.             commonName = true
    205.             serialNumber = true
    206.             domainComponent = true
    207.           [http.middlewares.Middleware12.passTLSClientCert.info.issuer]
    208.             country = true
    209.             province = true
    210.             locality = true
    211.             organization = true
    212.             commonName = true
    213.             serialNumber = true
    214.             domainComponent = true
    215.     [http.middlewares.Middleware13]
    216.       [http.middlewares.Middleware13.rateLimit]
    217.         average = 42
    218.         burst = 42
    219.         [http.middlewares.Middleware13.rateLimit.sourceCriterion]
    220.           requestHeaderName = "foobar"
    221.           requestHost = true
    222.           [http.middlewares.Middleware13.rateLimit.sourceCriterion.ipStrategy]
    223.             depth = 42
    224.             excludedIPs = ["foobar", "foobar"]
    225.     [http.middlewares.Middleware14]
    226.       [http.middlewares.Middleware14.redirectRegex]
    227.         regex = "foobar"
    228.         replacement = "foobar"
    229.         permanent = true
    230.     [http.middlewares.Middleware15]
    231.       [http.middlewares.Middleware15.redirectScheme]
    232.         scheme = "foobar"
    233.         port = "foobar"
    234.         permanent = true
    235.     [http.middlewares.Middleware16]
    236.       [http.middlewares.Middleware16.replacePath]
    237.         path = "foobar"
    238.     [http.middlewares.Middleware17]
    239.       [http.middlewares.Middleware17.replacePathRegex]
    240.         regex = "foobar"
    241.         replacement = "foobar"
    242.     [http.middlewares.Middleware18]
    243.       [http.middlewares.Middleware18.retry]
    244.         attempts = 42
    245.     [http.middlewares.Middleware19]
    246.       [http.middlewares.Middleware19.stripPrefix]
    247.         prefixes = ["foobar", "foobar"]
    248.     [http.middlewares.Middleware20]
    249.       [http.middlewares.Middleware20.stripPrefixRegex]
    250.         regex = ["foobar", "foobar"]
    252. [tcp]
    253.   [tcp.routers]
    254.     [tcp.routers.TCPRouter0]
    255.       entryPoints = ["foobar", "foobar"]
    256.       service = "foobar"
    257.       rule = "foobar"
    258.       [tcp.routers.TCPRouter0.tls]
    259.         passthrough = true
    260.         options = "foobar"
    261.         certResolver = "foobar"
    263.         [[tcp.routers.TCPRouter0.tls.domains]]
    264.           main = "foobar"
    265.           sans = ["foobar", "foobar"]
    267.         [[tcp.routers.TCPRouter0.tls.domains]]
    268.           main = "foobar"
    269.           sans = ["foobar", "foobar"]
    270.     [tcp.routers.TCPRouter1]
    271.       entryPoints = ["foobar", "foobar"]
    272.       service = "foobar"
    273.       rule = "foobar"
    274.       [tcp.routers.TCPRouter1.tls]
    275.         passthrough = true
    276.         options = "foobar"
    277.         certResolver = "foobar"
    279.         [[tcp.routers.TCPRouter1.tls.domains]]
    280.           main = "foobar"
    281.           sans = ["foobar", "foobar"]
    283.         [[tcp.routers.TCPRouter1.tls.domains]]
    284.           main = "foobar"
    285.           sans = ["foobar", "foobar"]
    286.   [tcp.services]
    287.     [tcp.services.TCPService0]
    288.       [tcp.services.TCPService0.loadBalancer]
    289.         terminationDelay = 100
    291.         [[tcp.services.TCPService0.loadBalancer.servers]]
    292.           address = "foobar"
    294.         [[tcp.services.TCPService0.loadBalancer.servers]]
    295.           address = "foobar"
    297.     [tcp.services.TCPService1]
    298.       [tcp.services.TCPService1.loadBalancer]
    299.         terminationDelay = 100
    301.         [[tcp.services.TCPService1.loadBalancer.servers]]
    302.           address = "foobar"
    304.         [[tcp.services.TCPService1.loadBalancer.servers]]
    305.           address = "foobar"
    307. [tls]
    309.   [[tls.certificates]]
    310.     certFile = "foobar"
    311.     keyFile = "foobar"
    312.     stores = ["foobar", "foobar"]
    314.   [[tls.certificates]]
    315.     certFile = "foobar"
    316.     keyFile = "foobar"
    317.     stores = ["foobar", "foobar"]
    318.   [tls.options]
    319.     [tls.options.Options0]
    320.       minVersion = "foobar"
    321.       cipherSuites = ["foobar", "foobar"]
    322.       sniStrict = true
    323.       [tls.options.Options0.clientAuth]
    324.         caFiles = ["foobar", "foobar"]
    325.         clientAuthType = "foobar"
    326.     [tls.options.Options1]
    327.       minVersion = "foobar"
    328.       cipherSuites = ["foobar", "foobar"]
    329.       sniStrict = true
    330.       [tls.options.Options1.clientAuth]
    331.         caFiles = ["foobar", "foobar"]
    332.         clientAuthType = "foobar"
    333.   [tls.stores]
    334.     [tls.stores.Store0]
    335.       [tls.stores.Store0.defaultCertificate]
    336.         certFile = "foobar"
    337.         keyFile = "foobar"
    338.     [tls.stores.Store1]
    339.       [tls.stores.Store1.defaultCertificate]
    340.         certFile = "foobar"
    341.         keyFile = "foobar"
    1. http:
    2.   routers:
    3.     Router0:
    4.       entryPoints:
    5.       - foobar
    6.       - foobar
    7.       middlewares:
    8.       - foobar
    9.       - foobar
    10.       service: foobar
    11.       rule: foobar
    12.       priority: 42
    13.       tls:
    14.         options: foobar
    15.         certResolver: foobar
    16.         domains:
    17.         - main: foobar
    18.           sans:
    19.           - foobar
    20.           - foobar
    21.         - main: foobar
    22.           sans:
    23.           - foobar
    24.           - foobar
    25.     Router1:
    26.       entryPoints:
    27.       - foobar
    28.       - foobar
    29.       middlewares:
    30.       - foobar
    31.       - foobar
    32.       service: foobar
    33.       rule: foobar
    34.       priority: 42
    35.       tls:
    36.         options: foobar
    37.         certResolver: foobar
    38.         domains:
    39.         - main: foobar
    40.           sans:
    41.           - foobar
    42.           - foobar
    43.         - main: foobar
    44.           sans:
    45.           - foobar
    46.           - foobar
    47.   services:
    48.     Service01:
    49.       loadBalancer:
    50.         sticky:
    51.           cookie:
    52.             name: foobar
    53.             secure: true
    54.             httpOnly: true
    55.         servers:
    56.         - url: foobar
    57.         - url: foobar
    58.         healthCheck:
    59.           scheme: foobar
    60.           path: foobar
    61.           port: 42
    62.           interval: foobar
    63.           timeout: foobar
    64.           hostname: foobar
    65.           headers:
    66.             name0: foobar
    67.             name1: foobar
    68.         passHostHeader: true
    69.         responseForwarding:
    70.           flushInterval: foobar
    71.     Service02:
    72.       mirroring:
    73.         service: foobar
    74.         mirrors:
    75.         - name: foobar
    76.           percent: 42
    77.         - name: foobar
    78.           percent: 42
    79.     Service03:
    80.       weighted:
    81.         services:
    82.         - name: foobar
    83.           weight: 42
    84.         - name: foobar
    85.           weight: 42
    86.         sticky:
    87.           cookie:
    88.             name: foobar
    89.             secure: true
    90.             httpOnly: true
    91.   middlewares:
    92.     Middleware00:
    93.       addPrefix:
    94.         prefix: foobar
    95.     Middleware01:
    96.       basicAuth:
    97.         users:
    98.         - foobar
    99.         - foobar
    100.         usersFile: foobar
    101.         realm: foobar
    102.         removeHeader: true
    103.         headerField: foobar
    104.     Middleware02:
    105.       buffering:
    106.         maxRequestBodyBytes: 42
    107.         memRequestBodyBytes: 42
    108.         maxResponseBodyBytes: 42
    109.         memResponseBodyBytes: 42
    110.         retryExpression: foobar
    111.     Middleware03:
    112.       chain:
    113.         middlewares:
    114.         - foobar
    115.         - foobar
    116.     Middleware04:
    117.       circuitBreaker:
    118.         expression: foobar
    119.     Middleware05:
    120.       compress: {}
    121.     Middleware06:
    122.       digestAuth:
    123.         users:
    124.         - foobar
    125.         - foobar
    126.         usersFile: foobar
    127.         removeHeader: true
    128.         realm: foobar
    129.         headerField: foobar
    130.     Middleware07:
    131.       errors:
    132.         status:
    133.         - foobar
    134.         - foobar
    135.         service: foobar
    136.         query: foobar
    137.     Middleware08:
    138.       forwardAuth:
    139.         address: foobar
    140.         tls:
    141.           ca: foobar
    142.           caOptional: true
    143.           cert: foobar
    144.           key: foobar
    145.           insecureSkipVerify: true
    146.         trustForwardHeader: true
    147.         authResponseHeaders:
    148.         - foobar
    149.         - foobar
    150.     Middleware09:
    151.       headers:
    152.         customRequestHeaders:
    153.           name0: foobar
    154.           name1: foobar
    155.         customResponseHeaders:
    156.           name0: foobar
    157.           name1: foobar
    158.         accessControlAllowCredentials: true
    159.         accessControlAllowHeaders:
    160.         - foobar
    161.         - foobar
    162.         accessControlAllowMethods:
    163.         - foobar
    164.         - foobar
    165.         accessControlAllowOrigin: foobar
    166.         accessControlExposeHeaders:
    167.         - foobar
    168.         - foobar
    169.         accessControlMaxAge: 42
    170.         addVaryHeader: true
    171.         allowedHosts:
    172.         - foobar
    173.         - foobar
    174.         hostsProxyHeaders:
    175.         - foobar
    176.         - foobar
    177.         sslRedirect: true
    178.         sslTemporaryRedirect: true
    179.         sslHost: foobar
    180.         sslProxyHeaders:
    181.           name0: foobar
    182.           name1: foobar
    183.         sslForceHost: true
    184.         stsSeconds: 42
    185.         stsIncludeSubdomains: true
    186.         stsPreload: true
    187.         forceSTSHeader: true
    188.         frameDeny: true
    189.         customFrameOptionsValue: foobar
    190.         contentTypeNosniff: true
    191.         browserXssFilter: true
    192.         customBrowserXSSValue: foobar
    193.         contentSecurityPolicy: foobar
    194.         publicKey: foobar
    195.         referrerPolicy: foobar
    196.         featurePolicy: foobar
    197.         isDevelopment: true
    198.     Middleware10:
    199.       ipWhiteList:
    200.         sourceRange:
    201.         - foobar
    202.         - foobar
    203.         ipStrategy:
    204.           depth: 42
    205.           excludedIPs:
    206.           - foobar
    207.           - foobar
    208.     Middleware11:
    209.       inFlightReq:
    210.         amount: 42
    211.         sourceCriterion:
    212.           ipstrategy:
    213.             depth: 42
    214.             excludedIPs:
    215.             - foobar
    216.             - foobar
    217.           requestHeaderName: foobar
    218.           requestHost: true
    219.     Middleware12:
    220.       passTLSClientCert:
    221.         pem: true
    222.         info:
    223.           notAfter: true
    224.           notBefore: true
    225.           sans: true
    226.           subject:
    227.             country: true
    228.             province: true
    229.             locality: true
    230.             organization: true
    231.             commonName: true
    232.             serialNumber: true
    233.             domainComponent: true
    234.           issuer:
    235.             country: true
    236.             province: true
    237.             locality: true
    238.             organization: true
    239.             commonName: true
    240.             serialNumber: true
    241.             domainComponent: true
    242.     Middleware13:
    243.       rateLimit:
    244.         average: 42
    245.         burst: 42
    246.         sourceCriterion:
    247.           ipstrategy:
    248.             depth: 42
    249.             excludedIPs:
    250.             - foobar
    251.             - foobar
    252.           requestHeaderName: foobar
    253.           requestHost: true
    254.     Middleware14:
    255.       redirectRegex:
    256.         regex: foobar
    257.         replacement: foobar
    258.         permanent: true
    259.     Middleware15:
    260.       redirectScheme:
    261.         scheme: foobar
    262.         port: foobar
    263.         permanent: true
    264.     Middleware16:
    265.       replacePath:
    266.         path: foobar
    267.     Middleware17:
    268.       replacePathRegex:
    269.         regex: foobar
    270.         replacement: foobar
    271.     Middleware18:
    272.       retry:
    273.         attempts: 42
    274.     Middleware19:
    275.       stripPrefix:
    276.         prefixes:
    277.         - foobar
    278.         - foobar
    279.     Middleware20:
    280.       stripPrefixRegex:
    281.         regex:
    282.         - foobar
    283.         - foobar
    284. tcp:
    285.   routers:
    286.     TCPRouter0:
    287.       entryPoints:
    288.       - foobar
    289.       - foobar
    290.       service: foobar
    291.       rule: foobar
    292.       tls:
    293.         passthrough: true
    294.         options: foobar
    295.         certResolver: foobar
    296.         domains:
    297.         - main: foobar
    298.           sans:
    299.           - foobar
    300.           - foobar
    301.         - main: foobar
    302.           sans:
    303.           - foobar
    304.           - foobar
    305.     TCPRouter1:
    306.       entryPoints:
    307.       - foobar
    308.       - foobar
    309.       service: foobar
    310.       rule: foobar
    311.       tls:
    312.         passthrough: true
    313.         options: foobar
    314.         certResolver: foobar
    315.         domains:
    316.         - main: foobar
    317.           sans:
    318.           - foobar
    319.           - foobar
    320.         - main: foobar
    321.           sans:
    322.           - foobar
    323.           - foobar
    324.   services:
    325.     TCPService0:
    326.       loadBalancer:
    327.         terminationDelay: 100
    328.         servers:
    329.         - address: foobar
    330.         - address: foobar
    331.     TCPService1:
    332.       loadBalancer:
    333.         terminationDelay: 100
    334.         servers:
    335.         - address: foobar
    336.         - address: foobar
    337. tls:
    338.   certificates:
    339.   - certFile: foobar
    340.     keyFile: foobar
    341.     stores:
    342.     - foobar
    343.     - foobar
    344.   - certFile: foobar
    345.     keyFile: foobar
    346.     stores:
    347.     - foobar
    348.     - foobar
    349.   options:
    350.     Options0:
    351.       minVersion: foobar
    352.       cipherSuites:
    353.       - foobar
    354.       - foobar
    355.       clientAuth:
    356.         caFiles:
    357.         - foobar
    358.         - foobar
    359.         clientAuthType: foobar
    360.       sniStrict: true
    361.     Options1:
    362.       minVersion: foobar
    363.       cipherSuites:
    364.       - foobar
    365.       - foobar
    366.       clientAuth:
    367.         caFiles:
    368.         - foobar
    369.         - foobar
    370.         clientAuthType: foobar
    371.       sniStrict: true
    372.   stores:
    373.     Store0:
    374.       defaultCertificate:
    375.         certFile: foobar
    376.         keyFile: foobar
    377.     Store1:
    378.       defaultCertificate:
    379.         certFile: foobar
    380.         keyFile: foobar