Type Alias RawNginxBlock

Type declaration

• { children: NginxBlockTypesWithContext<"main">[]; context: []; type: "main" }

  • children: NginxBlockTypesWithContext<"main">[]

  • context: []

  • type: "main"

    The top level nginx.conf file.
• { context: ["server"]; type: "listen"; values: string[] }

  • context: ["server"]

  • type: "listen"

    See

    https://nginx.org/en/docs/http/ngx_http_core_module.html#listen

  • values: string[]

• {
      children: NginxBlockTypesWithContext<"server">[];
      context: ["http"];
      type: "server";
  }

  • children: NginxBlockTypesWithContext<"server">[]

  • context: ["http"]

  • type: "server"

    See

    https://nginx.org/en/docs/http/ngx_http_core_module.html#server

• {
      context: ["http", "server", "location", "limit_except"];
      type: "auth_basic";
      value: string;
  }

  • context: ["http", "server", "location", "limit_except"]

  • type: "auth_basic"

    See

    https://nginx.org/en/docs/http/ngx_http_auth_basic_module.html#auth_basic

  • value: string

    Expected: string | 'off'
• {
      context: ["http", "server", "location", "limit_except"];
      file: string;
      type: "auth_basic_user_file";
  }

  • context: ["http", "server", "location", "limit_except"]

  • file: string

  • type: "auth_basic_user_file"

    See

    https://nginx.org/en/docs/http/ngx_http_auth_basic_module.html#auth_basic_user_file

• { file: string; type: "include" }

  • file: string

  • type: "include"

    See

    https://nginx.org/en/docs/ngx_core_module.html#include

• { context: ["main"]; file: string; type: "load_module" }

  • context: ["main"]

  • file: string

  • type: "load_module"

    See

    https://nginx.org/en/docs/ngx_core_module.html#load_module

• {
      context: ["http", "server"];
      protocols: (
          "SSLv2"
          | "SSLv3"
          | "TLSv1"
          | "TLSv1.1"
          | "TLSv1.2"
          | "TLSv1.3"
      )[];
      type: "ssl_protocols";
  }

  • context: ["http", "server"]

  • protocols: ("SSLv2" | "SSLv3" | "TLSv1" | "TLSv1.1" | "TLSv1.2" | "TLSv1.3")[]

  • type: "ssl_protocols"

    See

    https://nginx.org/en/docs/http/ngx_http_ssl_module.html#ssl_protocols

• {
      context: ["http", "server"];
      enabled: boolean;
      type: "ssl_prefer_server_ciphers";
  }

  • context: ["http", "server"]

  • enabled: boolean

  • type: "ssl_prefer_server_ciphers"

    See

    https://nginx.org/en/docs/http/ngx_http_ssl_module.html#ssl_prefer_server_ciphers

• {
      context: ["http", "server", "location", "location.if"];
      enabled: boolean;
      type: "gzip";
  }

  • context: ["http", "server", "location", "location.if"]

  • enabled: boolean

  • type: "gzip"

    See

    https://nginx.org/en/docs/http/ngx_http_gzip_module.html#gzip

• {
      context: ["http", "server", "location", "location.if", "limit_except"];
      type: "access_log";
      values: string[];
  }

  • context: ["http", "server", "location", "location.if", "limit_except"]

  • type: "access_log"

    See

    https://nginx.org/en/docs/http/ngx_http_log_module.html#access_log

  • values: string[]

• {
      context: ["main", "http", "mail", "stream", "server", "location"];
      file: string;
      level?:
          | "debug"
          | "info"
          | "notice"
          | "warn"
          | "error"
          | "crit"
          | "alert"
          | "emerg";
      type: "error_log";
  }

  • context: ["main", "http", "mail", "stream", "server", "location"]

  • file: string

  • Optionallevel?: "debug" | "info" | "notice" | "warn" | "error" | "crit" | "alert" | "emerg"

  • type: "error_log"

    See

    https://nginx.org/en/docs/ngx_core_module.html#error_log

• { context: ["http", "server"]; time: string; type: "ssl_session_timeout" }

  • context: ["http", "server"]

  • time: string

    Example

    '5m'
    Copy

  • type: "ssl_session_timeout"

    See

    https://nginx.org/en/docs/http/ngx_http_ssl_module.html#ssl_session_timeout

• { context: ["http", "server"]; type: "ssl_session_cache"; values: string[] }

  • context: ["http", "server"]

  • type: "ssl_session_cache"

    See

    https://nginx.org/en/docs/http/ngx_http_ssl_module.html#ssl_session_cache

  • values: string[]

    'off' | 'none' | [builtin[:size]] [shared:name:size]

    These values will be joined with spaces.
• { context: ["http", "server"]; enabled: boolean; type: "ssl_session_tickets" }

  • context: ["http", "server"]

  • enabled: boolean

  • type: "ssl_session_tickets"

    See

    https://nginx.org/en/docs/http/ngx_http_ssl_module.html#ssl_session_tickets

• { context: ["http", "server"]; enabled: boolean; type: "ssl_stapling" }

  • context: ["http", "server"]

  • enabled: boolean

  • type: "ssl_stapling"

    See

    https://nginx.org/en/docs/http/ngx_http_ssl_module.html#ssl_stapling

• { context: ["http", "server"]; enabled: boolean; type: "ssl_stapling_verify" }

  • context: ["http", "server"]

  • enabled: boolean

  • type: "ssl_stapling_verify"

    See

    https://nginx.org/en/docs/http/ngx_http_ssl_module.html#ssl_stapling_verify

• { ciphers: string[]; context: ["http", "server"]; type: "ssl_ciphers" }

  • ciphers: string[]

    These ciphers will be joined with ':'.

  • context: ["http", "server"]

  • type: "ssl_ciphers"

    See

    https://nginx.org/en/docs/http/ngx_http_ssl_module.html#ssl_ciphers

• { context: ["http", "server"]; curves: string[]; type: "ssl_ecdh_curve" }
• { context: ["http", "server"]; file: string; type: "ssl_dhparam" }

  • context: ["http", "server"]

  • file: string

  • type: "ssl_dhparam"

    See

    https://nginx.org/en/docs/http/ngx_http_ssl_module.html#ssl_dhparam

• {
      always?: boolean;
      context: ["http", "server", "location", "location.if"];
      name: string;
      type: "add_header";
      value: string;
  }

  • Optionalalways?: boolean

  • context: ["http", "server", "location", "location.if"]

  • name: string

    The name of the header.

  • type: "add_header"

    See

    https://nginx.org/en/docs/http/ngx_http_headers_module.html#add_header

  • value: string

• {
      children: NginxBlockTypesWithContext<"http">[];
      context: ["main"];
      type: "http";
  }

  • children: NginxBlockTypesWithContext<"http">[]

  • context: ["main"]

  • type: "http"

    See

    https://nginx.org/en/docs/http/ngx_http_core_module.html#http

• {
      context: ["http", "server", "location", "location.if"];
      enabled: boolean;
      type: "sendfile";
  }

  • context: ["http", "server", "location", "location.if"]

  • enabled: boolean

  • type: "sendfile"

    See

    https://nginx.org/en/docs/http/ngx_http_core_module.html#sendfile

• {
      context: ["http", "server", "location"];
      enabled: boolean;
      type: "tcp_nopush";
  }

  • context: ["http", "server", "location"]

  • enabled: boolean

  • type: "tcp_nopush"

    See

    https://nginx.org/en/docs/http/ngx_http_core_module.html#tcp_nopush

• {
      context: ["http", "server", "location"];
      mimeType: string;
      type: "default_type";
  }

  • context: ["http", "server", "location"]

  • mimeType: string

  • type: "default_type"

    See

    https://nginx.org/en/docs/http/ngx_http_core_module.html#default_type

• {
      context: ["http", "server", "location"];
      size: number;
      type: "types_hash_max_size";
  }

  • context: ["http", "server", "location"]

  • size: number

  • type: "types_hash_max_size"

    See

    https://nginx.org/en/docs/http/ngx_http_core_module.html#types_hash_max_size

• { context: ["main"]; count: number | "auto"; type: "worker_processes" }

  • context: ["main"]

  • count: number | "auto"

  • type: "worker_processes"

    See

    https://nginx.org/en/docs/ngx_core_module.html#worker_processes

• { context: ["main"]; group?: string; type: "user"; user: string }

  • context: ["main"]

  • Optionalgroup?: string

  • type: "user"

    See

    https://nginx.org/en/docs/ngx_core_module.html#user

  • user: string

• { context: ["main"]; file: string; type: "pid" }

  • context: ["main"]

  • file: string

  • type: "pid"

    Defines a file that will store the process ID of the main process.

    See

    https://nginx.org/en/docs/ngx_core_module.html#pid

• { context: ["events"]; count: number; type: "worker_connections" }

  • context: ["events"]

  • count: number

  • type: "worker_connections"

    See

    https://nginx.org/en/docs/ngx_core_module.html#worker_connections

• {
      children: NginxBlockTypesWithContext<"events">[];
      context: ["main"];
      type: "events";
  }

  • children: NginxBlockTypesWithContext<"events">[]

  • context: ["main"]

  • type: "events"

    See

    https://nginx.org/en/docs/ngx_core_module.html#events

• {
      code?: HttpStatus;
      context: ["server", "location", "if"];
      type: "return";
      url: string;
  }

  • Optionalcode?: HttpStatus

  • context: ["server", "location", "if"]

  • type: "return"

    See

    https://nginx.org/en/docs/http/ngx_http_rewrite_module.html#return

  • url: string

• {
      code: HttpStatus;
      context: ["server", "location", "if"];
      text: string;
      type: "return";
  }

  • code: HttpStatus

  • context: ["server", "location", "if"]

  • text: string

  • type: "return"

    See

    https://nginx.org/en/docs/http/ngx_http_rewrite_module.html#return

• {
      children: NginxBlockTypesWithContext<"location">[];
      context: ["server", "location"];
      matcher?: "=" | "~" | "~*" | "^~";
      type: "location";
      uri: string;
  }

  • children: NginxBlockTypesWithContext<"location">[]

  • context: ["server", "location"]

  • Optionalmatcher?: "=" | "~" | "~*" | "^~"

  • type: "location"

    See

    https://nginx.org/en/docs/http/ngx_http_core_module.html#location

  • uri: string

• { context: ["http", "server"]; file: string; type: "ssl_certificate" }

  • context: ["http", "server"]

  • file: string

  • type: "ssl_certificate"

    See

    https://nginx.org/en/docs/http/ngx_http_ssl_module.html#ssl_certificate

• { context: ["http", "server"]; file: string; type: "ssl_certificate_key" }

  • context: ["http", "server"]

  • file: string

  • type: "ssl_certificate_key"

    See

    https://nginx.org/en/docs/http/ngx_http_ssl_module.html#ssl_certificate_key

• {
      context: ["http", "server", "location"];
      name: string;
      type: "proxy_set_header";
      value: string;
  }

  • context: ["http", "server", "location"]

  • name: string

    The name of the header.

  • type: "proxy_set_header"

    See

    https://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_set_header

  • value: string

• {
      context: ["location", "location.if", "limit_except"];
      type: "proxy_pass";
      url: string;
  }

  • context: ["location", "location.if", "limit_except"]

  • type: "proxy_pass"

    See

    https://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_pass

  • url: string