diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..aaac265 --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2021-2022 Alireza Josheghani and others + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.md b/README.md new file mode 100644 index 0000000..d8b45ea --- /dev/null +++ b/README.md @@ -0,0 +1,37 @@ + + +
+ __ ______ ____ ___ ____ ____ ______ + / / / / __ \/ __ \__ \ ____ / __ \/ __ \/ ____/ + / / / / / / / /_/ /_/ // __ \/ /_/ / /_/ / / +/ /_/ / /_/ / ____/ __// /_/ / _, _/ ____/ /___ +\____/_____/_/ /____/\__, /_/ |_/_/ \____/ + /____/ ++ +## ⚠️ This project is still in early development. ⚠️ + +## UDP2gRPC +A Tunnel which Turns UDP Traffic into Encrypted gRPC/TCP Traffic,helps you Bypass UDP FireWalls(or Unstable UDP Environment) + +## Getting Started +### Installing +Download binary release from https://github.com/mrjosh/udp2grpc/releases + +### Running +Assume your UDP is blocked or being QOS-ed or just poorly supported. +Assume your server ip is 44.55.66.77, you have a service listening on udp port 51820. + +```bash +# Run at server side: +utg server -r127.0.0.1:51820 --tls-cert-file cert/server.crt --tls-key-file cert/server.key + +# Run at client side: +utg client -rdomain.tld --tls-cert-file cert/server.crt -l0.0.0.0 -P51820 +``` + +## Contributing +Thank you for considering contributing to UDP2gRPC project! + +## License +The UDP2gRPC is open-source software licensed under the MIT license.