Initial commit

CONTRIBUTING.md

@@ -0,0 +1,141 @@
+# Contributing to Nginx Server Configs
+
+Please take a moment to review this document in order to make the contribution
+process easy and effective for everyone involved.
+
+Following these guidelines helps to communicate that you respect the time
+of the developers managing and developing this open source project. In return,
+they should reciprocate that respect in addressing your issue or assessing
+patches and features.
+
+
+## Using the issue tracker
+
+The [issue tracker](https://github.com/h5bp/server-configs-nginx/issues) is
+the preferred channel for [bug reports](#bugs), [features requests](#features)
+and [submitting pull requests](#pull-requests), but please respect the following
+restrictions:
+
+* Please **do not** use the issue tracker for personal support requests (use
+  [Stack Overflow](http://stackoverflow.com) or IRC).
+
+* Please **do not** derail or troll issues. Keep the discussion on topic and
+  respect the opinions of others.
+
+
+<a name="bugs"></a>
+## Bug reports
+
+A bug is a _demonstrable problem_ that is caused by the code in the repository.
+Good bug reports are extremely helpful - thank you!
+
+Guidelines for bug reports:
+
+1. **Use the GitHub issue search** &mdash; check if the issue has already been
+   reported.
+
+2. **Check if the issue has been fixed** &mdash; try to reproduce it using the
+   latest `master` or development branch in the repository.
+
+3. **Isolate the problem** &mdash; ideally create a [reduced test
+   case](http://css-tricks.com/6263-reduced-test-cases/) and a live example.
+
+A good bug report shouldn't leave others needing to chase you up for more
+information. Please try to be as detailed as possible in your report. What is
+your environment? What steps will reproduce the issue? What version of Nginx
+experiences the problem? What would you expect to be the outcome? All these
+details will help people to fix any potential bugs.
+
+Example:
+
+> Short and descriptive example bug report title
+>
+> A summary of the issue and server version / OS / browser environment in which
+> it occurs. If suitable, include the steps required to reproduce the bug.
+>
+> 1. This is the first step
+> 2. This is the second step
+> 3. Further steps, etc.
+>
+> `<url>` - a link to the reduced test case
+>
+> Any other information you want to share that is relevant to the issue being
+> reported. This might include the lines of code that you have identified as
+> causing the bug, and potential solutions (and your opinions on their merits).
+
+
+<a name="features"></a>
+## Feature requests
+
+Feature requests are welcome. But take a moment to find out whether your idea
+fits with the scope and aims of the project. It's up to *you* to make a strong
+case to convince the project's developers of the merits of this feature. Please
+provide as much detail and context as possible.
+
+
+<a name="pull-requests"></a>
+## Pull requests
+
+Good pull requests - patches, improvements, new features - are a fantastic help.
+They should remain focused in scope and avoid containing unrelated commits.
+
+**Please ask first** before embarking on any significant pull request (e.g.
+implementing features, refactoring code), otherwise you risk spending a lot of
+time working on something that the project's developers might not want to merge
+into the project.
+
+Please adhere to the coding conventions used throughout a project (indentation,
+accurate comments, etc.) and any other requirements (such as test coverage).
+
+Adhering to the following this process is the best way to get your work
+included in the project:
+
+1. [Fork](http://help.github.com/fork-a-repo/) the project, clone your fork,
+   and configure the remotes:
+
+   ```bash
+   # Clone your fork of the repo into the current directory
+   git clone https://github.com/<your-username>/server-configs-nginx.git
+   # Navigate to the newly cloned directory
+   cd server-configs-nginx
+   # Assign the original repo to a remote called "upstream"
+   git remote add upstream https://github.com/h5bp/server-configs-nginx
+   ```
+
+2. If you cloned a while ago, get the latest changes from upstream:
+
+   ```bash
+   git checkout master
+   git pull upstream master
+   ```
+
+3. Create a new topic branch (off the main project development branch) to
+   contain your feature, change, or fix:
+
+   ```bash
+   git checkout -b <topic-branch-name>
+   ```
+
+4. Commit your changes in logical chunks. Please adhere to these [git commit
+   message guidelines](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html)
+   or your code is unlikely be merged into the main project. Use Git's
+   [interactive rebase](https://help.github.com/articles/interactive-rebase)
+   feature to tidy up your commits before making them public.
+
+5. Locally merge (or rebase) the upstream development branch into your topic branch:
+
+   ```bash
+   git pull [--rebase] upstream master
+   ```
+
+6. Push your topic branch up to your fork:
+
+   ```bash
+   git push origin <topic-branch-name>
+   ```
+
+7. [Open a Pull Request](https://help.github.com/articles/using-pull-requests/)
+    with a clear title and description.
+
+**IMPORTANT**: By submitting a patch, you agree to allow the project owner to
+license your work under the same license as that used by the project.

LICENSE.txt

@@ -0,0 +1,19 @@
+Copyright (c) Nginx Server Configs
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+of the Software, and to permit persons to whom the Software is furnished to do
+so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,41 @@
+# [Nginx Server Configs](https://github.com/h5bp/server-configs-nginx)
+
+**Nginx Server Configs** is a collection of configuration snippets that can help
+your server improve the web site's performance and security, while also
+ensuring that resources are served with the correct content-type and are
+accessible, if needed, even cross-domain.
+
+
+## Documentation
+
+The [documentation](doc/TOC.md) is bundled with
+the project, which makes it readily available for offline reading and provides a
+useful starting point for any documentation you want to write about your project.
+
+
+## Contributing to this project
+
+Anyone and everyone is welcome to contribute, but please take a moment to review
+the [contributing guidelines](CONTRIBUTING.md).
+
+* [Bug reports](CONTRIBUTING.md#bugs)
+* [Feature requests](CONTRIBUTING.md#features)
+* [Pull requests](CONTRIBUTING.md#pull-requests)
+
+
+## Acknowledgements
+
+Nginx Server Configs is only possible thanks to all the awesome
+[contributors](https://github.com/h5bp/server-configs-nginx/graphs/contributors)!
+
+
+This project is currently maintained by:
+
+| [![@AD7six](http://s.gravatar.com/avatar/876a61b58a729fcf71048529885d64dc?s=90)](https://twitter.com/AD7six "Follow @AD7six on Twitter") |
+|---|
+| [Andy Dawson](http://ad7six.com/) |
+
+
+## License
+
+The code is available under the [MIT license](LICENSE.txt).

bin/inline.sh

@@ -0,0 +1,96 @@
+#!/bin/bash
+################################################################################
+#
+# A utility script to write (nested) include statements
+# into the equivalent single config file.
+#
+################################################################################
+
+PROGNAME=${0##*/}
+PROGDIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
+VERSION="0.1"
+FILES=()
+
+error_exit() {
+  echo -e "${PROGNAME}: ${1:-"Unknown Error"}" >&2
+  exit 1
+}
+
+graceful_exit() {
+    exit
+}
+
+usage() {
+    echo -e "Usage: $PROGNAME [-h|--help] file.conf"
+}
+
+help_message() {
+  cat <<- _EOF_
+  $PROGNAME ver. $VERSION
+  Replace include statements with the included files
+
+  The primary use of this script is for debugging nginx
+  config files, or to provide a single config file for
+  distribution/deployment.
+
+  $(usage)
+
+  Example:
+    cd /etc/nginx
+    $PROGNAME h5bp/basic.conf
+    ### h5bp/basic.conf START
+
+    ### h5bp/directive-only/x-ua-compatible.conf START
+    add_header "X-UA-Compatible" "IE=Edge";
+    ....
+
+  Options:
+  -h, --help  Display this help message and exit.
+
+_EOF_
+  return
+}
+
+function main {
+    echo "### $1 START"
+    while read line
+    do
+        if [[ $line =~ "#" ]];
+        then
+            # skip comments
+            continue
+        elif [[ $line =~ "^ *$" ]];
+        then
+            # skip blank lines
+            continue
+        elif [[ $line =~ ^(\s*)include\s*(.*)\; ]];
+        then
+            main ${BASH_REMATCH[2]}
+        else
+            echo "$line"
+        fi
+    done < $1
+    echo "### $1 END"
+}
+
+# Parse command-line
+while [[ -n $1 ]]; do
+  case $1 in
+    -h | --help)
+      help_message; graceful_exit ;;
+    -* | --*)
+      usage
+      error_exit "Unknown option $1" ;;
+    *)
+      FILES+=($1);;
+  esac
+  shift
+done
+
+if [ ${#FILES[@]} -eq 0 ];
+then
+      usage;
+      graceful_exit;
+fi
+
+main $FILES

doc/TOC.md

@@ -0,0 +1,22 @@
+[Nginx Server Configs homepage](https://github.com/h5bp/server-configs-nginx)
+
+# Nginx Server Configs documentation:
+
+## Getting started
+
+* [Usage](usage.md) — Overview of the project contents.
+* [Nginx.conf](nginx-conf.md) — General introduction to the main config file.
+* [How Nginx works](how-nginx-works.md) — Understanding nginx, and how it differs from other webservers.
+* [Common problems](common-problems.md) — Dealing with commonly-encountered errors.
+
+## Example tasks
+
+* [Hotlink protection](examples/hotlink-protection.md)
+
+## Related projects
+
+* [HTML5 Boilerplate](http://html5boilerplate.com) — professional front-end
+  template.
+* [Server configs](https://github.com/h5bp/server-configs) — Configs for
+  other web servers.
+* [Mozilla SSL Configuration Generator](https://mozilla.github.io/server-side-tls/ssl-config-generator/) — generate Mozilla Security recommended web server configs.