Skip to content
This repository has been archived by the owner on Dec 29, 2023. It is now read-only.

Latest commit

 

History

History
43 lines (31 loc) · 1.14 KB

README.md

File metadata and controls

43 lines (31 loc) · 1.14 KB
Raw

wsadnlroxy

WebSockets <-> TCP(ADNL) Proxy

fast setup with ssl (ubuntu linux)

Prerequisites

GNU bash 5.1 or newer
GNU make 3.81 or newer
docker 20.10.17 or newer
docker-compose 1.29.2 or newer
  1. create an A record for your domain
example.com. IN A xxx.xxx.xxx.xxx
  1. create a .env file similar to .env.example
  2. pass your domain into .env
  3. run make setup-wtih-ssl

how to upgrade

  1. run git pull
  2. remove all containers make docker-rm-all
  3. run make setup-wtih-ssl or make setup-no-ssl

connection string

wss://host:port/?ip={}&port={}&pubkey={}
  • ip – liteserver signed integer IP
  • port – liteserver unsigned integer TCP port
  • pubkey – liteserver base64 public key (percent-encoding)

note: public key information is used to check the connection to the liteserver. The proxy works transparently, all cryptography, which is associated with ADNL, must be on the client.

License

The main license of this repository is GNU GENERAL PUBLIC LICENSE Version 3, but the repository contains an init-ssl.sh file its license is MIT.