Skip to content

Commit 0ee7c65

Browse files
authored
Update README.md
1 parent 2286edf commit 0ee7c65

File tree

1 file changed

+53
-0
lines changed

1 file changed

+53
-0
lines changed

client-mbedtls/README.md

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
# secure websocket client with mbedtls
2+
3+
Simple example of the secure websocket client. Built with oat++ (AKA oatpp) web framework.
4+
TLS backend - MbedTLS.
5+
6+
See more:
7+
8+
- [Oat++ Website](https://oatpp.io/)
9+
- [Oat++ Github Repository](https://github.com/oatpp/oatpp)
10+
- [Get Started With Oat++](https://oatpp.io/docs/start)
11+
12+
## Overview
13+
14+
### Project layout
15+
16+
```
17+
|- CMakeLists.txt // projects CMakeLists.txt
18+
|- src/
19+
| |
20+
| |- WSListener.hpp // WebSocket listeners are defined here
21+
| |- App.cpp // main() is here
22+
|
23+
|- utility/install-oatpp-modules.sh // utility script to install required oatpp-modules.
24+
```
25+
26+
## Build and Run
27+
28+
### Using CMake
29+
30+
**Requires**
31+
- MbedTLS installed - see [install mbedtls](#install-mbedtls).
32+
- [oatpp](https://github.com/oatpp/oatpp), [oatpp-websocket](https://github.com/oatpp/oatpp-websocket),
33+
and [oatpp-mbedtls](https://github.com/oatpp/oatpp-mbedtls) modules installed. You may run `utility/install-oatpp-modules.sh`
34+
script to install required oatpp modules.
35+
36+
```
37+
$ mkdir build && cd build
38+
$ cmake ..
39+
$ make
40+
$ ./websocket-client-mbedtls-exe # - run application.
41+
```
42+
43+
## Install MbedTLS
44+
45+
```bash
46+
git clone -b 'mbedtls-2.16.1' --single-branch --depth 1 --recurse-submodules https://github.com/ARMmbed/mbedtls
47+
48+
cd mbedtls
49+
mkdir build && cd build
50+
51+
cmake ..
52+
make install
53+
```

0 commit comments

Comments
 (0)