feat: 添加文档

Author: xuexb

.editorconfig

@@ -0,0 +1,15 @@
+root = true
+
+[*]
+charset = utf-8
+indent_style = space
+indent_size = 2
+end_of_line = lf
+trim_trailing_whitespace = true
+
+[*.{js,vue,scss}]
+insert_final_newline = true
+
+[*.md]
+trim_trailing_whitespace = false
+indent_size = 4

README.md

@@ -0,0 +1,19 @@
+# Nginx 入门教程
+
+学习 Nginx 配置, 包括: 编译安装、反向代理、重定向、重写、缓存、跨域配置等。
+
+## 起因
+
+起源是我的博客，博客从 IIS 伪静态起，我就一直需要接触一些配置，后来遇到了 Nginx ，被她『美丽动人的简约』打动，至些博客开始了各种折腾之路，比如：负载均衡、反向代理、前置缓存等，我把这些操作都记录到了 GitHub ，只是闲时写点笔记，也不成体系。
+
+直到 [VuePress](https://vuepress.vuejs.org) 这么简约的文档起步，我意识到可以重新构建下站点了，起名叫：Nginx 入门教程。
+
+基于 VuePress 构建在 GitHub Pages 中，PR 时基于 [Netlify](https://www.netlify.com) 自动部署预览测试环境方便回归。
+
+## 欢迎你的加入
+
+但我的个人能力有限，水平也有限，只能大概的构建出我的思路，希望有想法的朋友提交代码，一起完善她！
+
+## LICENSE
+
+MIT

docs/.vuepress/config.js

@@ -0,0 +1,76 @@
+module.exports = {
+    dest: 'dist',
+    base: '/learn-nginx/',
+    locales: {
+      '/': {
+        lang: 'zh-CN',
+        title: 'Nginx 入门教程',
+        description: '学习 Nginx 配置, 包括: 编译安装、反向代理、重定向、重写、缓存、跨域配置等',
+      },
+    },
+    head: [
+      ['link', { rel: 'icon', href: `/logo.jpg` }],
+    ],
+    themeConfig: {
+      repo: 'xuexb/learn-nginx',
+      editLinks: true,
+      docsDir: 'docs',
+      locales: {
+        '/': {
+          label: '中文',
+          selectText: '语言',
+          editLinkText: '编译该页面',
+          lastUpdated: '最后更新',
+          nav: [
+            {
+              text: '入门',
+              link: '/guide/',
+            },
+            {
+              text: '变量',
+              link: '/variable/',
+            },
+            {
+              text: '示例',
+              link: '/example/',
+            },
+          ],
+          sidebar: {
+            '/guide/': genSidebarConfigGuide('入门'),
+            '/variable/': genSidebarConfigVariable('变量'),
+          }
+        },
+      }
+    }
+  }
+
+  function genSidebarConfigGuide (title) {
+    return [
+      {
+        title,
+        collapsable: false,
+        children: [
+          '',
+          'dir',
+          'linux-install',
+          'nginx-configure-descriptions',
+          'error',
+        ]
+      }
+    ]
+  }
+
+  function genSidebarConfigVariable (title) {
+    return [
+      {
+        title,
+        collapsable: false,
+        children: [
+          '',
+          'server',
+          'client',
+          'url',
+        ]
+      }
+    ]
+  }

docs/.vuepress/override.styl

@@ -0,0 +1,3 @@
+.theme-container.page-main-max
+  .content
+    max-width 80%

docs/.vuepress/public/logo.jpg

@@ -0,0 +1,14 @@
+---
+home: true
+heroImage: /logo.jpg
+actionText: 快速上手 →
+actionLink: /guide/
+features:
+- title: 0️⃣ 从零开始
+  details: 记录了从不会 Nginx 到可以写一些常用的配置过程
+- title: 🔥 丰富示例
+  details: 结合使用场景，涵盖 WEB 开发中常用的示例，以及对应的说明
+- title: 🌐 开源
+  details: 代码完全开源在 GitHub ，希望大家一起共建
+footer: MIT Licensed | Copyright © 2018-present @xuexb
+---

docs/README.md

@@ -0,0 +1 @@
+# 配置

docs/config/README.md

@@ -0,0 +1 @@
+# 示例

docs/example/README.md

@@ -0,0 +1,37 @@
+# Nginx 简介
+
+Nginx（发音同engine x）是一个异步框架的 Web 服务器，也可以用作反向代理，负载平衡器 和 HTTP 缓存。该软件由 [Igor Sysoev](https://zh.wikipedia.org/wiki/%E4%BC%8A%E6%88%88%E7%88%BE%C2%B7%E8%B3%BD%E7%B4%A2%E8%80%B6%E5%A4%AB) 创建，并于2004年首次公开发布。同名公司成立于2011年，以提供支持。Nginx 是一款免费的开源软件，根据类 BSD 许可证的条款发布。一大部分Web服务器使用 Nginx ，通常作为负载均衡器。<sup>[[1]][wiki]</sup>
+
+## Nginx的特点 <sup>[[2]][jianshu]</sup>
+
+- 更快：
+    - 单次请求会得到更快的响应。
+    - 在高并发环境下，Nginx 比其他 WEB 服务器有更快的响应。
+- 高扩展性：
+    - Nginx 是基于模块化设计，由多个耦合度极低的模块组成，因此具有很高的扩展性。许多高流量的网站都倾向于开发符合自己业务特性的定制模块。
+- 高可靠性：
+    - Nginx 的可靠性来自于其核心框架代码的优秀设计，模块设计的简单性。另外，官方提供的常用模块都非常稳定，每个 worker 进程相对独立，master 进程在一个 worker 进程出错时可以快速拉起新的 worker 子进程提供服务。
+- 低内存消耗：
+    - 一般情况下，10000个非活跃的 `HTTP Keep-Alive` 连接在 Nginx 中仅消耗 `2.5MB` 的内存，这是 Nginx 支持高并发连接的基础。
+    - 单机支持10万以上的并发连接：**理论上，Nginx 支持的并发连接上限取决于内存，10万远未封顶。**
+- 热部署:
+    - master 进程与 worker 进程的分离设计，使得 Nginx 能够提供热部署功能，即在 7x24 小时不间断服务的前提下，升级 Nginx 的可执行文件。当然，它也支持不停止服务就更新配置项，更换日志文件等功能。
+- 最自由的 BSD 许可协议:
+    - 这是 Nginx 可以快速发展的强大动力。BSD 许可协议不只是允许用户免费使用 Nginx ，它还允许用户在自己的项目中直接使用或修改 Nginx 源码，然后发布。
+
+[wiki]:https://zh.wikipedia.org/wiki/Nginx "wiki"
+[jianshu]:https://www.jianshu.com/p/99d50fcc5cd6 "简书"
+
+## 你可能需要掌握的
+
+- Linux 服务器和一些常用的操作命令
+- 域名，当然如果是本地玩玩也可以是 Hosts
+- 基本的正则表达式
+
+## 声明
+
+本项目部分内容是来自网络资源，如有侵权请联系 `[email protected]` 。
+
+## 相关链接
+
+- [Nginx 官网](http://nginx.org/)

docs/guide/README.md

@@ -0,0 +1,38 @@
+# Nginx 目录建议
+
+[安装 Nginx](./linux-make.md) 时可以选择配置文件的路径，由于 Nginx 程序后续可能会升级版本，但配置基本上就是一份，那么推荐使用配置和程序分离的方式，遵循：
+
+1. 配置文件独立管理, 不存放在nginx程序目录内
+1. 每个站点独立一个配置文件
+2. 每个站点独立的日志文件
+3. 提取公用的配置文件
+
+如:
+
+```
+$dir/wwwroot/                           - 网站根目录，以域名为文件夹名称
+    ./xuexb.com/
+    ./static.xuexb.com/
+
+$dir/src/                               - 安装源包
+
+$dir/local/nginx/                       - nginx相关根目录
+    ./conf/                             - 配置文件
+        ./nginx.conf                    - 配置主入口
+        ./inc                           - 通用配置
+        ./vhost/                        - 各站点的配置，以 `域名.conf` 命名
+            ./xuexb.com.conf
+            ./static.xuexb.com.conf
+
+    ./1.11.1/                           - 各个版本的nginx
+    ./1.11.2/
+
+$dir/logs/                              - 日志相关目录，内以 `域名.type.log` 命名
+        ./last/                         - 最新的日志
+            ./xuexb.com.error.log
+            ./xuexb.com.access.log
+        ./back/                         - 天级备份日志
+            ./20170908/
+```
+
+这样分离之后不管是 Nginx 主程序版本升级，还是修改某个站点配置，还是快速查找某个站点日志都是得心应手~

docs/guide/dir.md

@@ -0,0 +1,35 @@
+# 常见错误
+
+### nginx: [emerg] getpwnam("nginx") failed
+
+表示该用户 `nginx` 不存在， 解决方法:
+
+1. 在 `nginx.conf` 里添加 `user nobody;`
+2. 创建用户和用户对应的分组
+
+### nginx: [emerg] getgrnam("xiaowu") failed
+
+表示用户分组不存在，解决方法:
+
+1. 在 `nginx.conf` 里添加 `user nobody;`
+2. 创建用户对应的分组
+
+### nginx: [alert] could not open error log file: open() "/logs/error.log" failed (13: Permission denied)
+
+启动 Nginx 的用户权限不够导致无法写入日志文件，常见于非 `root` 用户启动报错。
+
+### nginx: [emerg] bind() to 0.0.0.0:80 failed (48: Address already in use)
+
+80端口被占用启动失败，修改端口或者杀死占用者再启动即可。
+
+### nginx: [error] open() "nginx.pid" failed (2: No such file or directory)
+
+pid 进程 id 文件不存在，可能文件被删除或者已经停止，在停止 Nginx 时会使用该进程id，如果不存在将失败，可以手动 kill 掉。
+
+### nginx: [emerg] unknown "realpath_roots_xxx" variable
+
+变量 `$realpath_roots_xxx` 不存在
+
+### nginx: [emerg] "add_header" directive is not allowed here in xx
+
+`add_header` 指令不能直接在 `if` 判断内，可以在 `http`、`server`、`server.location`、`server.location.if` 下。

docs/guide/error.md

@@ -0,0 +1,134 @@
+# Linux 中编译安装和配置 Nginx
+
+> 注意：本示例在 Centos 6.5 、Centos 7.3 中运行。
+
+## 下载安装包并解压
+
+```bash
+# 进入约定的安装包目录
+cd /约定目录/src/
+
+# 下载nginx安装文件，这里以 nginx-1.11.1 为例，其他的nginx包可以去官网查找
+wget http://nginx.org/download/nginx-1.11.1.tar.gz
+
+# 把安装包解压，会自动解压到 /约定目/src/nginx-1.11.1/ 文件夹里
+tar xzf nginx-1.11.1.tar.gz
+```
+
+## nginx的配置文件
+
+其实完全可以使用 Nginx 的默认配置文件，默认配置文件编译后的地址在 `程序目录/conf/nginx.conf` ，但如果你会频繁的更新 Nginx 版本的话配置文件最后"分离"，类似前后端分离一样，这样可以少"吵架"(解耦合)，我们单独的把 Nginx 的所有配置，包括所有站点的配置、SSL 证书都放在 `/约定目录/nginx-conf/` 目录里，如：
+
+```
+/约定目录/nginx-conf/
+
+    # nginx配置文件
+    ./nginx.conf
+
+    # nginx的其他配置
+    ./mime.types
+
+    # 站点配置
+    ./conf/
+        # 各个子站点目录
+        ./www.xxoo.com.conf
+        ./www.a.com.conf
+        ...
+```
+
+`/约定目录/nginx-conf/conf/` 目录里存放以网站为单位的配置文件，文件名以网站域名命名，这样可以配置分离，互不影响，而且好定位问题。
+
+## 配置nginx安装参数
+
+```shell
+# 创建对应版本的程序目录，这个目录用来存放编译后的文件
+mkdir -p /约定目录/local/nginx-1.11.1/
+
+# 进入安装包解压后的目录
+cd /约定目录/src/nginx-1.11.1/
+
+# 开始配置
+./configure --prefix=/home/local/nginx-1.11.1 --conf-path=/home/local/nginx-conf/vhost/nginx.conf --with-http_ssl_module --with-http_realip_module --with-http_dav_module --with-http_gzip_static_module --with-http_v2_module
+```
+
+其他的安装编译配置可点击：[Nginx 编译参数](http://www.ttlsa.com/nginx/nginx-configure-descriptions/) 
+
+### 编译nginx
+
+```
+# 开始编译并安装，可能需要sudo权限
+make
+[sudo] make install
+```
+
+## 验证是否安装成功
+
+```
+# 进入nginx执行目录
+cd /约定目录/local/nginx-1.11.1/sbin/
+```
+
+运行 `./nginx -v` 查看版本，结果如：
+
+```
+nginx version: nginx/1.11.1
+```
+
+如果你有开启 `http_ssl_module` ，可运行：`./nginx  -V` 查看是否支持，结果如：
+
+```
+nginx version: nginx/1.11.1
+built by gcc 4.4.7 20120313 (Red Hat 4.4.7-16) (GCC)
+built with OpenSSL 1.0.1e-fips 11 Feb 2013
+TLS SNI support enabled
+...
+```
+
+## 重新编译安装
+
+是指已经安装成功, 但想对 Nginx 添加个模块或者修改配置时需要重新编译。
+
+### 1. 下载对应版本 (如果不想更新版本可以忽略)
+
+可以使用 `nginx -V` 查看当前程序的编译参数
+
+```bash
+# 下载
+
+wget http://nginx.org/download/nginx-1.11.13.tar.gz
+
+# 解压
+tar xzf nginx-1.11.13.tar.gz
+```
+
+### 2. 重新编译
+
+```bash
+# 配置
+./configure --prefix=xxx 你的新参数
+
+# 编译
+[sudo] make
+这时侯切记不要make install, 因为make install就会把文件复制到安装目录
+```
+
+### 3. 复制程序
+
+```bash
+# 新复制老版本, 以防出错
+cp /path/nginx /path/nginx.back
+
+# 停止服务
+/path/nginx -s stop
+
+# 复制新版本到安装目录
+cp objs/nginx /path/nginx
+
+# 查看新版本
+/path/nginx -t
+
+# 启动新版本
+/path/nginx
+```
+
+注意：如果在运行中直接覆盖 Nginx 会报： `cp: 无法创建普通文件"nginx": 文本文件忙` 。