https://github.com/ehco1996/v2scar

sidecar for V2ray
https://github.com/ehco1996/v2scar

sidecar sspanel v2ray

Last synced: about 1 month ago
JSON representation

sidecar for V2ray

• Host: GitHub
• URL: https://github.com/ehco1996/v2scar
• Owner: Ehco1996
• License: gpl-3.0
• Created: 2019-08-22T13:28:20.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2022-10-09T01:21:28.000Z (about 2 years ago)
• Last Synced: 2024-08-03T17:12:26.483Z (4 months ago)
• Topics: sidecar, sspanel, v2ray
• Language: Go
• Homepage:
• Size: 57.6 KB
• Stars: 121
• Watchers: 5
• Forks: 88
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-network-stuff - **19**星

README

        
# v2scar

Sidecar For V2ray

![go-releaser](https://github.com/Ehco1996/v2scar/workflows/go-releaser/badge.svg)

## 视频安装教程

* 面板视频安装教程: [地址](https://youtu.be/BRHcdGeufvY)

* 后端对接视频教程: [地址](https://youtu.be/QNbnya1HHU0)

* 隧道对接视频教程: [地址](https://youtu.be/R4U0NZaMUeY)

## 原理介绍

该项目需要以 `sidecar` 的形式和 `v2ray` 部署在一台机器上

他通过grpc接口动态添加/删除V2ray的 `Vmess/Trojan` 用户, 并统计流量

通过接入 `django-sspanel` 的api，可以动态调节v2ray的Vmess/Trojan用户

目前实现了以下几个接口：

* AddInboundUser

* RemoveInboundUser

* GetAndResetUserTraffic

## 使用说明

* 可以直接以cli的形式运行:

 `./v2scar --api-endpoint="xxx" --grpc-endpoint="127.0.0.1:8080" --sync-time=60`

* 或者通过配置环境变量来运行:

``` bash

export V2SCAR_SYNC_TIME=60 # 和django-sspanel同步的时间间隔

export V2SCAR_API_ENDPOINT="xxxx" # 这个是django-sspanel的sync api 地址

export V2SCAR_GRPC_ENDPOINT="127.0.0.1:8080" # 这个是机器上v2ray开放的grpc地址

```

## 配置V2ray:

> 这只是一份参考的配置，

> 关键的部分在于 `stats/api/policy/routing`

> 另外如果需要对接 django-sspanel的话，配置里的inbound的 `port/tag/level` 必须和面板后台里的配置相同

``` json

{

    "stats": {},

    "api": {

        "tag": "api",

        "services": [

            "HandlerService",

            "StatsService"

        ]

    },

    "log": {

        "loglevel": "warning"

    },

    "policy": {

        "levels": {

            "0": {

                "statsUserUplink": true,

                "statsUserDownlink": true

            }

        },

        "system": {

            "statsInboundUplink": true,

            "statsInboundDownlink": true

        }

    },

    "inbounds": [

        {

            "tag": "proxy",

            "port": 10086,

            "protocol": "vmess",

            "settings": {

                "clients": []

            }

        },

        {

            "listen": "127.0.0.1",

            "port": 8080,

            "protocol": "dokodemo-door",

            "settings": {

                "address": "127.0.0.1"

            },

            "tag": "api"

        }

    ],

    "outbounds": [

        {

            "protocol": "freedom",

            "settings": {}

        }

    ],

    "routing": {

        "settings": {

            "rules": [

                {

                    "inboundTag": [

                        "api"

                    ],

                    "outboundTag": "api",

                    "type": "field"

                }

            ]

        },

        "strategy": "rules"

    }

}

```

## dev

go get v2ray的时候需要 `export GONOSUMDB=v2ray.com/core,github.com/v2fly/v2ray-core`