Manifest settings for web components
Overview
This reference doc details all the Manifest settings for webserver, proxy and framework components. If you’re unfamiliar with Manifest files and how they work, please follow our getting started guide and detailed how-to guide.
If you’re looking for the Manifest settings for data, caching & storage components or load balancers, please see our respective reference documents for those components.
Key to table headings
- Option - the name of the setting as used in the YAML of your Manifest file
- Applied on - the type of deployment required to update this setting. In many cases settings only apply when an application is first built, or when new servers are created or it is cloned. Hover over the names of each condition to see more info.
- Clouds - the cloud providers on which a setting can be used.
Gateway
Note
The gateway should be defined and open before you can use it in manifest.
The following settings are available via the Manifest file:
| Option | Applied on | Description | Clouds |
|---|---|---|---|
name |
Redeploy ⓘChanges to this setting will be applied when you next deploy your application |
Specify the name of gateway you want to use for your application. | All |
username |
Redeploy ⓘChanges to this setting will be applied when you next deploy your application |
Specify the username which should be used to connect to Bastion server. | All |
Example YAML for gateway
gateway:
name: aws_bastion
username: ec2-user
Nginx
Nginx is the default webserver & reverse proxy for applications managed by Cloud 66.
The following settings are available via the Manifest file:
| Option | Applied on | Description | Clouds |
|---|---|---|---|
cors |
Redeploy ⓘChanges to this setting will be applied when you next deploy your application |
Enable Cross Origin Resource Sharing | All |
nginx/precompiled_url |
Build-only ⓘThis setting only applies when the app is first built (or cloned) or when new servers are added. |
A URL pointing to a file in tar.gz format that contains a custom version of Nginx that will be used with your application. This Nginx package MUST be compiled using our Cloud 66 compiler. Please read the docs on the Github page for more details. |
All |
perfect_forward_secrecy (deprecated) |
Redeploy ⓘChanges to this setting will be applied when you next deploy your application |
Enable Perfect Forward Secrecy | All |
Example YAML for Nginx
rails:
configuration:
nginx:
perfect_forward_secrecy: true # deprecated
CORS configuration
If required, you can also specify the allowed origin (as ‘*’ or a single origin) and methods. You can also specify a comma-separated list of origins, headers, and whether to allow credentials for CORS.
rails:
configuration:
nginx:
cors:
origin: '*'
methods: 'GET, OPTIONS'
headers: 'Custom-Header, Another-Header'
credentials: true
Post-deployment health checks
You can configure your application to automatically run health checks against an HTTP endpoint each time it is deployed. Results of these checks are available on your Cloud 66 dashboard under ActiveProtect.
Note that all of the Health Check settings must be nested under the configuration → activeprotect → health_check sub-node.
The following settings are available via the Manifest file:
| Option | Applied on | Description | Clouds |
|---|---|---|---|
endpoint |
Redeploy ⓘChanges to this setting will be applied when you next deploy your application |
The endpoint to that will be queried during the check | All |
accept |
Redeploy ⓘChanges to this setting will be applied when you next deploy your application |
The set of HTTP codes we will accept as valid from the endpoint (as an array) | All |
timeout |
Redeploy ⓘChanges to this setting will be applied when you next deploy your application |
The timeout limit in seconds of the endpoint (limit: 10) |
All |
max_redirects |
Redeploy ⓘChanges to this setting will be applied when you next deploy your application |
The number of acceptable HTTP redirects (limit: 10) |
All |
cooldown |
Redeploy ⓘChanges to this setting will be applied when you next deploy your application |
The delay between the end of the deployment process and the start of the test, in seconds. (limit: 1800) |
All |
Example YAML for post-deployment health check
rails:
configuration:
activeprotect:
health_check:
endpoint: '/' # Default is root '/'
accept: ["200", "300-399"] # Default is 200
timeout: 2 # Default is 5
max_redirects: 5 # Default is 3
cooldown: 120 # Default is 0
