Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
Fix broken Markdown headings
  • Loading branch information
bryant1410 committed Apr 17, 2017
1 parent e18c875 commit 5f48ec5
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 22 deletions.
24 changes: 12 additions & 12 deletions readme.md
Expand Up @@ -3,11 +3,11 @@ VeryNginx is a very powerful and friendly nginx .

[中文文档](https://github.com/alexazhou/VeryNginx/blob/master/readme_zh.md)

###Notice
### Notice
After v0.2 , The entry uri of control panel was moved to `/verynginx/index.html`


##Description
## Description

VeryNginx is based on `lua_nginx_module(openrestry)`. It implements advanced firewall(waf), access statistics and some other features. It strengthens the Nginx's functions, and provides a friendly Web interface.

Expand All @@ -17,7 +17,7 @@ User / Password: **verynginx / verynginx**

The full version of config guide can be found on: [VeryNginx Wiki](https://github.com/alexazhou/VeryNginx/wiki) .

###Nginx run status analyzing
### Nginx run status analyzing

* Request per second
* Response time
Expand All @@ -27,15 +27,15 @@ The full version of config guide can be found on: [VeryNginx Wiki](https://githu
![Nginx status](http://ww2.sinaimg.cn/mw690/3fcd0ed3jw1f17en7oc1yj20z00ol0wl.jpg)


###Custom Action
### Custom Action

VeryNginx supports custom actions, which can do a lot of things.

Custom action consists of two parts, `Matcher` and `Action` . `Matcher` is used to test whether a request meets the rule, `Action` is the logic you want to run.

>The advantage of this design is that the `Matcher` includes all select rule, and can be reused, making use of rules to describe a very complex logic possible.
####Matcher
#### Matcher

A `Matcher` is used to select a part of all requests, a `Matcher` may contain one or more condition. The following conditions are currently supported:

Expand All @@ -48,7 +48,7 @@ A `Matcher` is used to select a part of all requests, a `Matcher` may contain on

When a request does not conflict with any of the conditions of the Matcher, the request will be selected by the `Matcher`

####Action
#### Action

Every `Action` refers to a `Matcher` , and will run on the requests selected by the `Matcher`

Expand All @@ -69,7 +69,7 @@ VeryNginx presets some simple filter rules, which can prevent simple SQL injecti

![VeryNginx filter](http://ww3.sinaimg.cn/mw690/3fcd0ed3jw1f17en9lrarj20zw0piq77.jpg)

####Backend
#### Backend

Every `Backend` refers to a `Matcher`,and will handle the requests selected by the `Matcher`

Expand All @@ -78,7 +78,7 @@ Now we have these `Backend`
* **Proxy Pass** Proxy the request to other server
* **Static File** Use local file to handle the request file

###Request statistics
### Request statistics

VeryNginx can record the request of URI, include these data of every URI:

Expand All @@ -93,7 +93,7 @@ VeryNginx can record the request of URI, include these data of every URI:
![request statistics](http://ww1.sinaimg.cn/mw690/3fcd0ed3jw1f17ena2ipyj20zw0piqag.jpg)


##Installation
## Installation

### Install Nginx / OpenResty

Expand All @@ -106,7 +106,7 @@ python install.py install

Just run this command, openresty and verynginx will be installed automatically.

####Want using custom nginx?
#### Want using custom nginx?

VeryNginx can install openresty automatically so that you **needn't install nginx(openresty) manually**.

Expand Down Expand Up @@ -170,7 +170,7 @@ If you have any problems during **installation** / **configuration** / **use** ,

* If you lock yourself out of VeryNginx by doing something stupid, you can always delete `config.json` to revert VeryNginx to its default.

###Update VeryNginx / OpenResty
### Update VeryNginx / OpenResty

Over time, VeryNginx own will evolve, and can also support newer version of OpenResty. New version of VeryNginx might support some new features or fix some old bugs. If you want to update locally installed VeryNginx, you just need pull the latest code from github to local, and run the following commands:

Expand Down Expand Up @@ -219,7 +219,7 @@ Scan the QRcode to support VeryNginx.
[VeryNginx thanks for the help](https://github.com/alexazhou/VeryNginx/wiki/Thanks)


###Enjoy~
### Enjoy~

[^openresty]: [OpenResty](https://github.com/openresty/openresty) Openresty is a enhanced nginx,bundle standard nginx core and lots of 3rd-party nginx module.

20 changes: 10 additions & 10 deletions readme_zh.md
@@ -1,10 +1,10 @@
# VeryNginx
VeryNginx 是一个功能强大而对人类友好的 Nginx 扩展程序.

###提示
### 提示
`v0.2` 版本之后,控制台入口被移动到了 `/verynginx/index.html`

##介绍
## 介绍

VeryNginx 基于 `lua_nginx_module(openrestry)` 开发,实现了高级的防火墙、访问统计和其他的一些功能。 集成在 Nginx 中运行,扩展了 Nginx 本身的功能,并提供了友好的 Web 交互界面。

Expand All @@ -14,7 +14,7 @@ VeryNginx 基于 `lua_nginx_module(openrestry)` 开发,实现了高级的防

详细配置说明见:[VeryNginx Github WiKi](https://github.com/alexazhou/VeryNginx/wiki/目录)

###Nginx 运行状态分析
### Nginx 运行状态分析

* 每秒请求数
* 响应时间
Expand All @@ -24,15 +24,15 @@ VeryNginx 基于 `lua_nginx_module(openrestry)` 开发,实现了高级的防
![Nginx 运行状态](http://ww2.sinaimg.cn/mw690/3fcd0ed3jw1f17en7oc1yj20z00ol0wl.jpg)


###自定义行为
### 自定义行为

VeryNginx 包含强大的自定义功能,可以做很多事情

自定义行为包含两部分, Matcher 和 Action 。 Matcher 用来对请求进行匹配, Action 为要执行的动作

这样的优势在于把所有的前置判断整合在Matcher里一起来实现了,使复杂(组合)规则的实现变成了可能

####Matcher
#### Matcher

一个 Matcher 用来判断一个 Http 请求是否符合指定的条件, 一个 Matcher 可以包含一个或者多个约束条件,目前支持以下几种约束:

Expand All @@ -45,7 +45,7 @@ VeryNginx 包含强大的自定义功能,可以做很多事情

当一个请求没有违反 Matcher 中包含的全部条件时,即命中了这个 Matcher

####Action
#### Action

每个 Action 会引用一个 Matcher ,当 Matcher 命中时, Action 会被执行

Expand All @@ -66,7 +66,7 @@ VeryNginx 预置了常用的过滤规则,可以在一定程度上阻止常见

![VeryNginx filter](http://ww3.sinaimg.cn/mw690/3fcd0ed3jw1f17en9lrarj20zw0piq77.jpg)

####Backend
#### Backend

每个 Backend 会引用一个 Matcher ,当 Matcher 命中时, 请求会通过 Backend 进行处理

Expand All @@ -75,7 +75,7 @@ VeryNginx 预置了常用的过滤规则,可以在一定程度上阻止常见
* **Proxy Pass** 将请求反向代理到其它服务器
* **Static File** 使用本地文件处理请求

###访问统计
### 访问统计

VeryNginx 可以统计网站每个URI的访问情况,包括每个URI的:

Expand All @@ -90,7 +90,7 @@ VeryNginx 可以统计网站每个URI的访问情况,包括每个URI的:

![Nginx 运行状态](http://ww1.sinaimg.cn/mw690/3fcd0ed3jw1f17ena2ipyj20zw0piqag.jpg)

##安装和使用说明
## 安装和使用说明

VeryNginx 基于 OpenResty[^openresty],所以安装 VeryNginx 需要先安装好 OpenResty。不过并不用担心安装过程中可能的麻烦,VeryNginx 自身提供了脚本来进行安装工作。

Expand Down Expand Up @@ -139,7 +139,7 @@ VeryNginx 的配置文件位置为 **/opt/verynginx/openresty/nginx/conf/nginx.c
```


###通过web面板对 VeryNginx 进行配置
### 通过web面板对 VeryNginx 进行配置

VeryNginx 启动后,可以通过浏览器访问管理面板来查看状态以及进行配置。

Expand Down

0 comments on commit 5f48ec5

Please sign in to comment.