README.md revision 199c01ab
1[](https://travis-ci.org/litespeedtech/lsquic-client) 2[](https://cirrus-ci.com/github/litespeedtech/lsquic-client) 3[](https://ci.appveyor.com/project/litespeedtech/lsquic-client) 4 5LiteSpeed QUIC (LSQUIC) Client Library README 6============================================= 7 8Description 9----------- 10 11LiteSpeed QUIC (LSQUIC) Client Library is an open-source implementation 12of QUIC functionality for clients. It is released in the hope to speed 13the adoption of QUIC. Most of the code in this distribution is used in 14our own products: LiteSpeed Web Server and ADC. We think it is free of 15major problems. Nevertheless, do not hesitate to report bugs back to us. 16Even better, send us fixes and improvements! 17 18Currently supported QUIC versions are Q035, Q039, Q043, and Q044. Support 19for newer versions will be added soon after they are released. The 20version(s) specified by IETF QUIC WG are being developed on 21[one or more branches](https://github.com/litespeedtech/lsquic-client/branches). 22When deemed stable, the IETF QUIC support will be added to the master branch. 23 24Documentation 25------------- 26 27The documentation for this module is admittedly sparse. The API is 28documented in include/lsquic.h. If you have doxygen, you can run 29`doxygen dox.cfg` or `make docs`. The example program is 30test/http_client.c: a bare-bones, but working, QUIC client. Have a look 31in EXAMPLES.txt to see how it can be used. 32 33Requirements 34------------ 35 36To build LSQUIC, you need CMake, zlib, and BoringSSL. The example program 37uses libevent to provide the event loop. 38 39Building BoringSSL 40------------------ 41 42BoringSSL is not packaged; you have to build it yourself. The process is 43straightforward. You will need `go` installed. 44 451. Clone BoringSSL by issuing the following command: 46 47``` 48git clone https://boringssl.googlesource.com/boringssl 49cd boringssl 50``` 51 522. Check out stable branch: 53 54``` 55git checkout chromium-stable 56``` 57 583. Compile the library 59 60``` 61cmake . && make 62``` 63 64Remember where BoringSSL sources are: 65``` 66BORINGSSL=$PWD 67``` 68 69If you want to turn on optimizations, do 70 71``` 72cmake -DCMAKE_BUILD_TYPE=Release . && make 73``` 74 75Building LSQUIC Client Library 76------------------------------ 77 78LSQUIC's `http_client` and the tests link BoringSSL libraries statically. 79Following previous section, you can build LSQUIC as follows: 80 811. Get the source code 82 83``` 84git clone https://github.com/litespeedtech/lsquic-client.git 85cd lsquic-client 86``` 87 882. Compile the library 89 90 91``` 92# $BORINGSSL is the top-level BoringSSL directory from the previous step 93cmake -DBORINGSSL_DIR=$BORINGSSL . 94make 95``` 96 973. Run tests 98 99``` 100make test 101``` 102 103Building with Docker 104--------- 105The library and http_client example can be built with Docker. 106``` 107docker build -t lsquic-client . 108``` 109 110Then you can use the http_client example from the command line. 111``` 112docker run -it --rm lsquic-client http_client -H www.google.com -s 74.125.22.106:443 -p / 113``` 114 115Platforms 116--------- 117 118The client library has been tested on the following platforms: 119- Linux 120 - i386 121 - x86_64 122 - ARM (Raspberry Pi 3) 123- FreeBSD 124 - i386 125- Windows 126 - x86_64 127- MacOS 128 - x86_64 129 130Have fun, 131 132LiteSpeed QUIC Team. 133 134Copyright (c) 2017 - 2018 LiteSpeed Technologies Inc 135
