cookbook 'nginx-proxy', '= 0.3.0'
nginx-proxy (5) Versions 0.3.0 Follow11
Nginx Proxy
cookbook 'nginx-proxy', '= 0.3.0', :supermarket
knife supermarket install nginx-proxy
knife supermarket download nginx-proxy
nginx-proxy cookbook
Automatically set up Nginx as a proxy to backend application servers
or Apache. Provides a definition to use in recipes, and automatically
configures proxies based on attributes.
This cookbook's home is at https://github.com/3ofcoins/chef-cookbook-nginx-proxy/
Requirements
- nginx
- apache2 (included only if apache backend is used)
Usage
This cookbook provides an nginx_proxy
definition that can be used
directly in recipes, and uses it to automatically configure proxies
based on attributes.
To use the definition, include the cookbook in your cookbook's
depends
, optionally add recipe[nginx-proxy::setup]
to the run
list, and use nginx_proxy
in your recipes.
nginx_proxy
definition
Parameters:
-
name
- name of the file insites-available/
; default value forserver_name
-
server_name
- server name for nginx -
ssl_key
- basename of SSL key -
ssl_key_path
- full path to SSL private key, defaults to"#{ssl_key}.key"
innode['nginx_proxy']['ssl_key_dir']
-
ssl_certificate_path
- full path to SSL certificate (full PEM file including intermediate certificates). Defaults to"#{ssl_key}.pem"
innode['nginx_proxy']['ssl_certificate_dir]
-
port
- port on localhost for the backend -
apache
(value optional) - if provided and true, configure Apache to listen onnode['nginx_proxy']['apache_port']
and use it as a backend -
url
- full URL to backend, can be used instead ofport
orapache
-
redirect
- if true, redirect to theurl
rather than proxy its content -
aka
- can be set to one or more aliases that will redirect to the proxy. Last parameter may be a hash specifying parameters fornginx_proxy
calls for the aliases (e.g. SSL keys) -
custom_config
- string, or a list of strings (lines), to include verbatim in the configuration. -
location_config
- string, or a list of strings (lines), to include verbatim in the location configuration. -
allow_origin
- regular expression of origins to enable CORS for. Note:*
is not supported in this mechanism, for open CORS use acustom_config
snippet. If this is set, following parameters can be used to further customize the configuration:-
access_control_allow_credentials
if set totrue
, theAccess-Control-Allow-Credentials
will be set -
access_control_allow_headers
can be set to list of allowed headers -
access_control_allow_methods
can be set to list of allowed methods (defaults to['GET', 'OPTIONS']
;OPTIONS
is always added and doesn't need to be specified) -
access_control_max_age
can be set to configure validity of preflight response
-
Examples
nginx_proxy 'icinga.example.com' do apache ssl_key 'star.example.com' end
nginx_proxy 'nagios.example.com' do url 'https://icinga.example.com' redirect true end
nginx_proxy 'new.example.com' do apache ssl_key 'star.example.com' aka 'old.example.com', 'yet-older.example.com', ssl_key: 'star.example.com' end
nginx_proxy 'example.info' do url 'http://example.com/' end
nginx_proxy 'site.example.com' do port 4000 end
Data-driven recipe
If you include nginx-proxy
in your run list, it will process the
node['nginx_proxy']['proxies']
attribute hash to call the nginx_proxy
definition: each key will be passed as a name, and values are
interpreted in the following way:
- if value is
'apache'
or:apache
, thenapache
parameter is set - if value is a number or a string that is a number, then
port
parameter is set to the provided value - if value is a string that's not a number, then
url
parameter is set to the value - if value is a dictionary, it's applied as parameters
Example
node['nginx_proxy']['proxies']['nagios.example.com'] = :apache node['nginx_proxy']['proxies']['site.example.com'] = 4000 node['nginx_proxy']['proxies']['example.info'] = 'http://example.com' node['nginx_proxy']['proxies']['new.example.com']['apache'] = true node['nginx_proxy']['proxies']['new.example.com']['ssl_key'] = 'star.example.com' node['nginx_proxy']['proxies']['new.example.com']['aka'] = [ 'old.example.com', 'yet-older.example.com', ssl_key: 'star.example.com' ] node['nginx_proxy']['proxies']['new.example.com']['location_config'] = [ "proxy_http_version 1.1;", "proxy_set_header Upgrade $http_upgrade;", "proxy_set_header Connection "upgrade";"]
Attributes
-
node['nginx_proxy']['proxies']['...']
-- proxies for data-driven recipe (see above) -
node['nginx_proxy']['apache_port']
(default: 81) -- port to have Apache listen on when used as a backend -
node['nginx_proxy']['ssl_key_dir']
(default:/etc/ssl/private
) -- directory holding private SSL keys -
node['nginx_proxy']['ssl_certificate_dir']
(default:/etc/ssl/certificates
) -- directory holding public SSL certificates -
node['nginx_proxy']['nginx_recipe']
(default:nginx
) -- recipe to include for base nginx setup
Author
Author:: Maciej Pasternacki maciej@3ofcoins.net
Change History
0.3.0
- Add
location_config
property (#4) - Add
nginx_proxy.nginx_recipe
attribute - CORS support
0.2.1
- Fix template cookbook bug
0.2.0
- Compatibility with nginx cookbook 2.5.0
- Add
custom_config
property - Basic test-kitchen smoke test
0.1.0
- Initial release
Collaborator Number Metric
0.3.0 failed this metric
Failure: Cookbook has 1 collaborators. A cookbook must have at least 2 collaborators to pass this metric.
Contributing File Metric
0.3.0 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a CONTRIBUTING.md file
Foodcritic Metric
0.3.0 passed this metric
No Binaries Metric
0.3.0 passed this metric
Testing File Metric
0.3.0 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a TESTING.md file
Version Tag Metric
0.3.0 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must include a tag that matches this cookbook version number
0.3.0 failed this metric
0.3.0 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a CONTRIBUTING.md file
Foodcritic Metric
0.3.0 passed this metric
No Binaries Metric
0.3.0 passed this metric
Testing File Metric
0.3.0 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a TESTING.md file
Version Tag Metric
0.3.0 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must include a tag that matches this cookbook version number
0.3.0 passed this metric
0.3.0 passed this metric
Testing File Metric
0.3.0 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a TESTING.md file
Version Tag Metric
0.3.0 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must include a tag that matches this cookbook version number
0.3.0 failed this metric
0.3.0 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must include a tag that matches this cookbook version number