• Getting Started
  • Install
  • Building the Application
  • Usage
• Node
• License
• Contributing
• Preface

Getting Started

Install

go get -u install github.com/GuoYuefei/bard

Building the Application

Now that you have do something it's time to build your application:

cd bard
git submodule init
git submodule update
go build -o proxyserver ./server/server.go
go build -o proxyclient ./client/client.go

Then you can see two executable file named proxyserver and proxyclient in your current folder.

Usage

The config.yml file in the ./debug/config folder. Configure the file based on the comment information in the file.

The path name of the configuration file relative to the execution file is ./server/debug/config/config.yml and ./client/debug/config/config.yml.

At this time you can execute the program you just compiled.

./proxyserver 
./proxyclient

The plugin system allows you to place the plugins you need to open in the server/debug/plugin/ and client/debug/plugin/ directory.
If you don't want to write the plugin yourself, I will provide a few plugins available. As for the documentation needed to write the plugin, it will be released after I release the v1.0.0 version.

Node

1. You can get the installation script on the release page of this project
2. Windows is different from other Unix-like systems in the way it is built. You can refer to the construction script of Windows client in the publishing page.

License

GNU AFFERO GENERAL PUBLIC LICENSE (AGPLv3.0)

Contributing

See the file named CONTRIBUTING.md

Preface

Write a proxy software based on the socks5 protocol. Functional implementations are expected to have basic functionality including, but not limited to, support for udp and ipv6 proxy functions, as well as some special features including but not limited to encryption, etc.