# GatewayBranch

**Repository Path**: DysonSphere/GatewayBranch

## Basic Information

- **Project Name**: GatewayBranch
- **Description**: 一个基于 DotNetty 的轻量级跨平台TCP网关的Socket转发工具，支持docker容器化部署
- **Primary Language**: C#
- **License**: MIT
- **Default Branch**: main
- **Homepage**: http://yedajiang44.com
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 29
- **Created**: 2023-03-30
- **Last Updated**: 2023-03-30

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## 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