dogu.json

{
  "Name": "official/nginx",
  "Version": "1.30.0-1",
  "DisplayName": "Nginx",
  "Description": "Nginx WebServer.",
  "Logo": "https://cloudogu.com/images/dogus/nginx.png",
  "Category": "Base",
  "Tags": [
    "webserver",
    "proxy",
    "reverse-proxy"
  ],
  "Url": "http://nginx.org/",
  "Image": "registry.cloudogu.com/official/nginx",
  "Dependencies": [
    {
      "type": "dogu",
      "name": "registrator",
      "version": ">=0.10.0-1"
    }
  ],
  "Configuration": [
    {
      "Name": "logging/root",
      "Description": "Set the root log level to one of ERROR, WARN, INFO, DEBUG.",
      "Optional": true,
      "Default": "WARN",
      "Validation": {
        "Type": "ONE_OF",
        "Values": [
          "WARN",
          "DEBUG",
          "INFO",
          "ERROR"
        ]
      }
    },
    {
      "Name": "disable_access_log",
      "Description": "Disable logging of incoming requests",
      "Optional": true
    },
    {
      "Name": "google_tracking_id",
      "Description": "Google Analytics Tracking ID",
      "Optional": true
    },
    {
      "Name": "html_content_url",
      "Description": "URL path to reach all custom html content pages. Default value when unset: static",
      "Optional": true
    },
    {
      "Name": "ignore_service_health",
      "Description": "Option to ignore the health status of all dogus. Makes it possible to access dogus even if they are unhealthy",
      "Default": "false",
      "Optional": true
    },
    {
      "Name": "container_config/cpu_core_limit",
      "Description": "Limits the container's CPU core usage. Use a positive floating value describing a fraction of 1 CPU core. When you define a value of '0.5', you are requesting half as much CPU time compared to if you asked for '1.0' CPU.",
      "Optional": true
    },
    {
      "Name": "container_config/cpu_core_request",
      "Description": "Requests the container's minimal CPU core requirement. Use a positive floating value describing a fraction of 1 CPU core. When you define a value of '0.5', you are requesting half as much CPU time compared to if you asked for '1.0' CPU.",
      "Optional": true
    },
    {
      "Name": "container_config/memory_limit",
      "Description": "Limits the container's memory usage. Use a positive integer value followed by one of these units [b,k,m,g] (byte, kibibyte, mebibyte, gibibyte).",
      "Optional": true,
      "Validation": {
        "Type": "BINARY_MEASUREMENT"
      }
    },
    {
      "Name": "container_config/memory_request",
      "Description": "Requests the container's minimal memory requirement. Use a positive integer value followed by one of these units [b,k,m,g] (byte, kibibyte, mebibyte, gibibyte).",
      "Optional": true,
      "Validation": {
        "Type": "BINARY_MEASUREMENT"
      }
    },
    {
      "Name": "container_config/storage_limit",
      "Description": "Limits the container's ephemeral storage usage. Use a positive integer value followed by one of these units [b,k,m,g] (byte, kibibyte, mebibyte, gibibyte).",
      "Optional": true,
      "Validation": {
        "Type": "BINARY_MEASUREMENT"
      }
    },
    {
      "Name": "container_config/storage_request",
      "Description": "Requests the container's minimal ephemeral storage requirement. Use a positive integer value followed by one of these units [b,k,m,g] (byte, kibibyte, mebibyte, gibibyte).",
      "Optional": true,
      "Validation": {
        "Type": "BINARY_MEASUREMENT"
      }
    },
    {
      "Name": "container_config/swap_limit",
      "Description": "Limits the container's swap memory usage. Use zero or a positive integer value followed by one of these units [b,k,m,g] (byte, kibibyte, mebibyte, gibibyte). 0 will disable swapping.",
      "Optional": true,
      "Validation": {
        "Type": "BINARY_MEASUREMENT"
      }
    },
    {
      "Name": "buffer/proxy_buffer_size",
      "Description": "Sets the size of the buffer used for reading the first part of the response received from the proxied server. The default value is 4k or 8k, depending on the platform. Format: '{size as number}k' ",
      "Optional": true
    },
    {
      "Name": "buffer/proxy_buffers",
      "Description": "Sets the number and size of the buffers used for reading a response from the proxied server, for a single connection. The default value is 8 4k/8k (depending on the platform). Format: '{amount of buffers} {buffer size}k' ",
      "Optional": true
    },
    {
      "Name": "buffer/proxy_busy_buffers_size",
      "Description": "When buffering of responses from the proxied server is enabled, limits the total size of buffers that can be busy sending a response to the client while the response is not yet fully read. In the meantime, the rest of the buffers can be used for reading the response and, if needed, buffering part of the response to a temporary file. By default, size is limited by the size of two buffers set by the proxy_buffer_size and proxy_buffers directives. The default value is 8k/16k (depending on the platform). Format: '{buffer size}k' ",
      "Optional": true
    },
    {
      "Name": "mutual_tls/enabled",
      "Description": "Enables mutual TLS. If enabled, the certificate of the client must be provided in the request to the server. Format: 'true' or 'false'. Ensure the CA certificate used to sign client certificates is stored in the global configuration at 'certificate/client-ca.crt'",
      "Default": "false",
      "Validation": {
        "Type": "ONE_OF",
        "Values": [
          "true",
          "false"
        ]
      },
      "Optional": true
    }
  ],
  "Volumes": [
    {
      "Name": "customhtml",
      "Path": "/var/www/customhtml",
      "Owner": "1000",
      "Group": "1000",
      "NeedsBackup": true
    },
    {
      "Name": "app.conf.d",
      "Path": "/etc/nginx/app.conf.d",
      "Owner": "1000",
      "Group": "1000",
      "NeedsBackup": true
    },
    {
      "Name": "appconf",
      "Path": "/var/nginx/conf.d/",
      "Owner": "0",
      "Group": "0",
      "NeedsBackup": true
    }
  ],
  "ExposedPorts": [
    {
      "Type": "tcp",
      "Host": 80,
      "Container": 80
    },
    {
      "Type": "tcp",
      "Host": 443,
      "Container": 443
    }
  ],
  "HealthChecks": [
    {
      "Type": "tcp",
      "Port": 80
    },
    {
      "Type": "tcp",
      "Port": 443
    }
  ],
  "Properties": {
    "stopAtBackup": "false"
  }
}