opuppet/module-nginx
5
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

Add a link to the QuickStart guide

Browse source
This commit is contained in:
Chad Thompson 2015-10-10 14:29:32 -05:00
parent f743ef65af
commit 70091da1f5
2 changed files with 17 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
README.markdown
View file

@ -15,21 +15,24 @@ Forge](http://img.shields.io/puppetforge/v/jfryman/nginx.svg)](https://forge.pup
This module manages NGINX configuration. This module manages NGINX configuration.
## Quick Start
### Requirements ### Requirements
* Puppet-2.7.0 or later * Puppet-2.7.0 or later
* Facter 1.7.0 or later * Facter 1.7.0 or later
* Ruby-1.9.3 or later (Support for Ruby-1.8.7 is not guaranteed. YMMV). * Ruby-1.9.3 or later (Support for Ruby-1.8.7 is not guaranteed. YMMV).
### Additional Documentation
* [A Quickstart Guide to the NGINX Puppet Module]['/docs/quickstart.md']
### Install and bootstrap an NGINX instance ### Install and bootstrap an NGINX instance
```puppet ```puppet
class { 'nginx': } class { 'nginx': }
``` ```
### Setup a new virtual host ### Creating a new virtual host
```puppet ```puppet
nginx::resource::vhost { 'www.puppetlabs.com': nginx::resource::vhost { 'www.puppetlabs.com':
@ -53,6 +56,9 @@ nginx::resource::vhost { 'rack.puppetlabs.com':
} }
``` ```
### Add a smtp proxy ### Add a smtp proxy
```puppet ```puppet

10
docs/quickstart.md
View file

@ -89,14 +89,20 @@ Combining our configurations above into a single manifest, our code block looks
} }
``` ```
This puppet code block will: In summary, this puppet code block will:
* Install the latest version of nginx from the 'mainline' nginx distributino. * Install the latest version of nginx from the 'mainline' nginx distributino.
* Define a virtual host `www.myhost.com` for our website. * Define a virtual host `www.myhost.com` for our website.
* Define an *upstream* service that consists of a single external IP address. * Define an *upstream* service that consists of a single external IP address.
* Define a URL that will proxy to the upstream resource. In this case, `http://www.myhost.com/blog` will proxy to an external resource hosted at `http://192.168.99.1`. * Define a URL that will proxy to the upstream resource. In this case, `http://www.myhost.com/blog` will proxy to an external resource hosted at `http://192.168.99.1`.
## References
There are a number of resources available for learning how to use NGINX effectively. Here are a few that you may find useful:
[nginx.org][nginx]: The NGNIX homepage.
[NGINX Documentation][ngixdocs]: Open Source NGINX Documentation
[NGINX vs. Apache][nginxvsapache]: A good article from [DigitalOcean][] describing the key differences between the use and architecture of NGINX vs. the Apache HTTPD server. This is a good article if you are new to NGINX or want a simple overview of the NGINX event driven architecture.
[nginx]: http://ngnix.org
[phpfpm]: http://php-fpm.org [phpfpm]: http://php-fpm.org
[nginxpackages]: http://nginx.org/packages/mainline
[nginxdocs]: http://nginx.org/en/docs/ [nginxdocs]: http://nginx.org/en/docs/
[puppetlabsapache]: https://forge.puppetlabs.com/puppetlabs/apache [puppetlabsapache]: https://forge.puppetlabs.com/puppetlabs/apache
[digitalocean]: https://www.digitalocean.com [digitalocean]: https://www.digitalocean.com