# gateway_ui

**Repository Path**: cqyhm/gateway_ui

## Basic Information

- **Project Name**: gateway_ui
- **Description**: gateway_ui（仅适配2.x）
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2024-08-20
- **Last Updated**: 2024-08-20

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# API网关图形配置工具

[网关项目][1]

基于ruby on rails进行开发，通过restful进行配置管理。

## 安装

```shell
# Docker required
git clone https://github.com/archfish/gateway_ui.git
cd gateway_ui
make
```

## 启动

```shell
docker run -d --restart always -p 3000:3000 \
        --name gateway_ui \
        -u 1001:1001 \
        -h gateway.ui.production \
        -l SERVICE_80_NAME=gatewayui \
        -e RAILS_ENV=production \
        -e GATEWAY_BACKEND=gateway_container_service:port \
        gateway_ui:[your tag]
```

- `SERVICE_80_NAME`用于consul服务发现的服务名，可忽略；
- `RAILS_ENV`配置rails运行的环境，必须为production；
- `GATEWAY_BACKEND`网关restful API的服务地址+端口号；
- `RAILS_LOG_TO_STDOUT`是否输出到/dev/stdout，可以通过docker logs查看日志，如果设置为false，则日志输出到`log/production.log`;
- 打包出来的images的tag自动以`%Y%m%d%H%M`格式保存；

## 网易镜像仓库

```shell
docker pull hub.c.163.com/weihailang/gateway_ui:latest
```

## 配置思路

- 配置Server。即真实服务列表，真正处理请求业务的地方
- 配置Cluster，关联Server。一个Cluster下的Server支持负载均衡
- 配置API，并在`Nodes`节点下关联Cluster

更多详情请查看网关[相关文档][2]。

## 注意

项目没有做权限管理，同时也不打算做这个功能，安全性上只能通过网络限制实现，请不要将服务运行在开放的外网环境中。

推荐通过Nginx进行基础验证，[配置方法][3]。

## 参与开发

```shell
# required ruby installed!

git clone https://github.com/archfish/gateway_ui.git && cd gateway_ui
bundle install
bundle exec rails s -p 3100
```

[1]: https://github.com/fagongzi/gateway "Gateway"
[2]: https://github.com/fagongzi/gateway/tree/master/docs "Gateway docs"
[3]: https://docs.nginx.com/nginx/admin-guide/security-controls/configuring-http-basic-authentication "configuring http basic authentication"