Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sous-chefs/nginx_simplecgi
Development repository for the nginx_simplecgi cookbook
https://github.com/sous-chefs/nginx_simplecgi
chef chef-cookbook chef-resource hacktoberfest managed-by-terraform nginx-simplecgi
Last synced: about 1 month ago
JSON representation
Development repository for the nginx_simplecgi cookbook
- Host: GitHub
- URL: https://github.com/sous-chefs/nginx_simplecgi
- Owner: sous-chefs
- License: apache-2.0
- Created: 2012-04-16T15:25:10.000Z (over 12 years ago)
- Default Branch: main
- Last Pushed: 2024-02-01T01:36:15.000Z (11 months ago)
- Last Synced: 2024-04-14T06:09:21.837Z (8 months ago)
- Topics: chef, chef-cookbook, chef-resource, hacktoberfest, managed-by-terraform, nginx-simplecgi
- Language: Ruby
- Homepage: https://supermarket.chef.io/cookbooks/nginx_simplecgi
- Size: 125 KB
- Stars: 8
- Watchers: 23
- Forks: 18
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# nginx_simplecgi cookbook
[](https://supermarket.chef.io/cookbooks/nginx_simplecgi)
[](https://circleci.com/gh/sous-chefs/nginx_simplecgi)
[](#backers)
[](#sponsors)
[](https://opensource.org/licenses/Apache-2.0)
This cookbook provides CGI support for NGINX via SimpleCGI.
## Maintainers
This cookbook is maintained by the Sous Chefs. The Sous Chefs are a community of Chef cookbook maintainers working together to maintain important cookbooks. If you’d like to know more please visit [sous-chefs.org](https://sous-chefs.org/) or come chat with us on the Chef Community Slack in [#sous-chefs](https://chefcommunity.slack.com/messages/C2V7B88SF).
## Requirements
### Platforms
- Debian/ Ubuntu
- RHEL based platforms (CentOS, Redhat, etc)
### Chef
- Chef 12.19+
### Cookbooks
- nginx
- perl
- runit
- yum-epel
## Usage
### Attributes
- `node['nginx_simplecgi']['cgi'] -> Enable CGI dispatch`
- `node['nginx_simplecgi']['php'] -> Enable PHP dispatch`
- `node['nginx_simplecgi']['php_cgi_bin'] -> PHP executable path for CGI`
- `node['nginx_simplecgi']['init_type'] -> Init style for dispatchers`
- `node['nginx_simplecgi']['dispatcher_directory'] -> Directory to contain socket and pid files`
- `node['nginx_simplecgi']['dispatcher_processes'] -> Number of dispatcher processes for handling requests`
### Template Helper
A template method helper, `dispatch` is provided to add the require location block into your nginx configuration files:
```ruby
<%= nginx_dispatch(:cgi) %>
```
The default call will output:
```toml
location ~ ^/cgi-bin/.*\.cgi$ {
gzip off;
fastcgi_pass unix:/var/run/nginx/cgiwrap-dispatch.sock;
fastcgi_index index.cgi;
fastcgi_param SCRIPT_FILENAME /usr/lib$fastcgi_script_name;
fastcgi_param QUERY_STRING $query_string;
fastcgi_param REQUEST_METHOD $request_method;
fastcgi_param CONTENT_TYPE $content_type;
fastcgi_param CONTENT_LENGTH $content_length;
fastcgi_param GATEWAY_INTERFACE CGI/1.1;
fastcgi_param SERVER_SOFTWARE nginx;
fastcgi_param SCRIPT_NAME $fastcgi_script_name;
fastcgi_param REQUEST_URI $request_uri;
fastcgi_param DOCUMENT_URI $document_uri;
fastcgi_param DOCUMENT_ROOT $document_root;
fastcgi_param SERVER_PROTOCOL $server_protocol;
fastcgi_param REMOTE_ADDR $remote_addr;
fastcgi_param REMOTE_PORT $remote_port;
fastcgi_param SERVER_ADDR $server_addr;
fastcgi_param SERVER_PORT $server_port;
fastcgi_param SERVER_NAME $server_name;
}
```
Available options:
- `:pattern -> change the pattern nginx matches`
- `:cgi_bin_dir -> change the prefix directory of the local cgi-bin`
- `:dispatcher -> use a custom dispatcher (socket or tcp based)`
- `:custom -> string to be appended within the location block`
The method will also accept a block that will be eval'd and the result appended within the location block.
## Contributors
This project exists thanks to all the people who [contribute.](https://opencollective.com/sous-chefs/contributors.svg?width=890&button=false)
### Backers
Thank you to all our backers!
### Sponsors
Support this project by becoming a sponsor. Your logo will show up here with a link to your website.
