Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
zhangxu19830126 committed Sep 12, 2019
1 parent d1927f3 commit f45696c
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 25 deletions.
22 changes: 9 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,11 +78,6 @@ Running parameters can be set by the following environment varaibles. Configurat
All options in `etcd --help` are supported.

### Available Docker Images

* `fagongzi/gateway`

A quick start image, consisting of three components: etcd, proxy, apiserver, `Only intended for quick start experience. Do not use in production.`

* `fagongzi/proxy`

proxy component, `production ready`
Expand All @@ -91,6 +86,15 @@ Running parameters can be set by the following environment varaibles. Configurat

apiserver component, `production ready`

### Quick start with docker-compose
```bash
docker-compose up -d
```

Use `http://127.0.0.1:9093/ui/index.html` to access `apiserver`

Use `http://127.0.0.1` to access to your API

## Architecture
![](./images/arch.png)

Expand Down Expand Up @@ -134,13 +138,5 @@ Routing is a route strategy. Cookie, Querystring, Header and Path in HTTP Reques
## WeChat
![](./images/qr.jpg)

## Sponsor
Open source is not easy. If this project is helpful to you, you can buy me a drink, thank you!
### Wechat
![](/images/wechat.png)

### Alipay
![](/images/alipay.jpg)

[1]: https://docs.docker.com/ "Docker Documentation"
[2]: https://github.com/yeasy/docker_practice "docker_practice"
21 changes: 9 additions & 12 deletions README_CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,10 +70,6 @@ Gateway 是一个基于HTTP协议的restful的API网关。可以作为统一的A

### 可用的docker镜像

* `fagongzi/gateway`

镜像是一个quickstart镜像,包含了3个组件:etcd,proxy,apiserver, `仅限于快速体验,不能使用在生产`

* `fagongzi/proxy`

proxy组件,`生产可用`
Expand All @@ -82,6 +78,15 @@ Gateway 是一个基于HTTP协议的restful的API网关。可以作为统一的A

apiserver组件,`生产可用`

### Quick start with docker-compose
```bash
docker-compose up -d
```

使用 `http://127.0.0.1:9093/ui/index.html` 访问 `apiserver`

使用 `http://127.0.0.1` 访问你的API

## 架构
![](./images/arch.png)

Expand Down Expand Up @@ -119,13 +124,5 @@ Routing是一个路由策略,根据HTTP Request中的Cookie,Querystring、He
## 交流方式-微信
![](./images/qr.jpg)

## 赞助
开源不易,如果这个项目对你有帮助,你可以请我喝一杯,谢谢!
### 微信
![](/images/wechat.png)

### 支付宝
![](/images/alipay.jpg)

[1]: https://docs.docker.com/ "Docker Documentation"
[2]: https://github.com/yeasy/docker_practice "docker_practice"

0 comments on commit f45696c

Please sign in to comment.