gettingstarted.rst revision afe3d363
1afe3d363SDmitri TikhonovGetting Started
2afe3d363SDmitri Tikhonov===============
3afe3d363SDmitri Tikhonov
4afe3d363SDmitri TikhonovSupported Platforms
5afe3d363SDmitri Tikhonov-------------------
6afe3d363SDmitri Tikhonov
7afe3d363SDmitri TikhonovLSQUIC compiles and runs on Linux, FreeBSD, and Mac OS.  It has been
8afe3d363SDmitri Tikhonovtested on i386, x86_64, as well as Raspberry Pi.
9afe3d363SDmitri Tikhonov
10afe3d363SDmitri TikhonovWindows support is on the TODO list.
11afe3d363SDmitri Tikhonov
12afe3d363SDmitri TikhonovDependencies
13afe3d363SDmitri Tikhonov------------
14afe3d363SDmitri Tikhonov
15afe3d363SDmitri TikhonovLSQUIC library uses:
16afe3d363SDmitri Tikhonov
17afe3d363SDmitri Tikhonov- zlib_;
18afe3d363SDmitri Tikhonov- BoringSSL_; and
19afe3d363SDmitri Tikhonov- `ls-qpack`_ (as a Git submodule).
20afe3d363SDmitri Tikhonov
21afe3d363SDmitri TikhonovThe accompanying demo command-line tools use libevent_.
22afe3d363SDmitri Tikhonov
23afe3d363SDmitri TikhonovWhat's in the box
24afe3d363SDmitri Tikhonov-----------------
25afe3d363SDmitri Tikhonov
26afe3d363SDmitri Tikhonov- ``src/liblsquic`` -- the library
27afe3d363SDmitri Tikhonov- ``test`` -- demo client and server programs
28afe3d363SDmitri Tikhonov- ``test/unittests`` -- unit tests
29afe3d363SDmitri Tikhonov
30afe3d363SDmitri TikhonovBuilding
31afe3d363SDmitri Tikhonov--------
32afe3d363SDmitri Tikhonov
33afe3d363SDmitri TikhonovTo build the library, follow instructions in the README_ file.
34afe3d363SDmitri Tikhonov
35afe3d363SDmitri TikhonovDemo Examples
36afe3d363SDmitri Tikhonov-------------
37afe3d363SDmitri Tikhonov
38afe3d363SDmitri TikhonovFetch Google home page:
39afe3d363SDmitri Tikhonov
40afe3d363SDmitri Tikhonov::
41afe3d363SDmitri Tikhonov
42afe3d363SDmitri Tikhonov    ./http_client -s www.google.com -p / -o version=Q050
43afe3d363SDmitri Tikhonov
44afe3d363SDmitri TikhonovRun your own server (it does not touch the filesystem, don't worry):
45afe3d363SDmitri Tikhonov
46afe3d363SDmitri Tikhonov::
47afe3d363SDmitri Tikhonov
48afe3d363SDmitri Tikhonov    ./http_server -c www.example.com,fullchain.pem,privkey.pem -s 0.0.0.0:4433
49afe3d363SDmitri Tikhonov
50afe3d363SDmitri TikhonovGrab a page from your server:
51afe3d363SDmitri Tikhonov
52afe3d363SDmitri Tikhonov::
53afe3d363SDmitri Tikhonov
54afe3d363SDmitri Tikhonov    ./http_client -H www.example.com -s 127.0.0.1:4433 -p /
55afe3d363SDmitri Tikhonov
56afe3d363SDmitri TikhonovYou can play with various options, of which there are many.  Use
57afe3d363SDmitri Tikhonovthe ``-h`` command-line flag to see them.
58afe3d363SDmitri Tikhonov
59afe3d363SDmitri TikhonovNext steps
60afe3d363SDmitri Tikhonov----------
61afe3d363SDmitri Tikhonov
62afe3d363SDmitri TikhonovIf you want to use LSQUIC in your program, check out the :doc:`tutorial` and
63afe3d363SDmitri Tikhonovthe :doc:`apiref`.
64afe3d363SDmitri Tikhonov
65afe3d363SDmitri Tikhonov:doc:`internals` covers some library internals.
66afe3d363SDmitri Tikhonov
67afe3d363SDmitri Tikhonov.. _zlib: https://www.zlib.net/
68afe3d363SDmitri Tikhonov.. _BoringSSL: https://boringssl.googlesource.com/boringssl/
69afe3d363SDmitri Tikhonov.. _`ls-qpack`: https://github.com/litespeedtech/ls-qpack
70afe3d363SDmitri Tikhonov.. _libevent: https://libevent.org/
71afe3d363SDmitri Tikhonov.. _README: https://github.com/litespeedtech/lsquic/blob/master/README.md
72