An open API service indexing awesome lists of open source software.

https://github.com/yedajiang44/gatewaybranch

a lightweight gateway forwarding tool developed based on DotNetty
https://github.com/yedajiang44/gatewaybranch

branch docker gateway socket tcp

Last synced: about 1 year ago
JSON representation

a lightweight gateway forwarding tool developed based on DotNetty

Awesome Lists containing this project

README

          

# GatewayBranch

## [中文文档](README.ZH-CN.MD)

GatewayBranch is a lightweight gateway forwarding tool developed based on DotNet

![workflow](./imgs/workflow.png)

# How to use

import package

```c#
using GatewayBranch.Core;
```

add service

```c#
services.AddGatewayBranch(hostContext.Configuration);
```

config appsettings.json

```json
"Gateway": {
"TcpPort": [2012,2013], // listener ports list
"BrabchServer": [
{
"Ip": "127.0.0.1", // branch server ip or domain
"Port": 808, // branch server port
"NeedReply": true // if `true` branch port downstream data,else do nothing
},
{
"Ip": "127.0.0.1",
"Port": 809,
"NeedReply": true
}
]
}
```

# Run in docker

the docker image [yedajiang44/gatewaybranch](https://hub.docker.com/r/yedajiang44/gatewaybranch)

- download `docker-compose.yml`
- exec `docker-compose up -d`

## note

> If you need to map configuration file, you need to create the corresponding file

- `appsettings.json` content see [appsettings.json](./src/GatewayBranch.Application/appsettings.json) , see [GatewayConfiguration](./src/GatewayBranch.Core/Server/GatewayConfiguration.cs) for specific gateway configuration items
- ~~`nlog.config` content see [nlog.config](./src/GatewayBranch.Application/nlog.config)~~

# Roadmap

- add udp
- add session mananger webapi