Skip to content

Commit 5acc226

Browse files
Add README.md for fullstack examples directory
Co-Authored-By: [email protected] <[email protected]>
1 parent 6b9ff2e commit 5acc226

File tree

1 file changed

+51
-0
lines changed

1 file changed

+51
-0
lines changed

fullstack/README.md

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
# wolfSSL Full-Stack Examples
2+
3+
This directory contains examples demonstrating full-stack implementations using wolfSSL components on FreeRTOS.
4+
5+
## Examples
6+
7+
### 1. FreeRTOS + wolfIP + wolfSSL HTTPS Server
8+
Located in `freertos-wolfip-wolfssl-https/`
9+
10+
Demonstrates:
11+
- HTTPS server implementation using wolfSSL
12+
- FreeRTOS POSIX simulation
13+
- wolfIP network stack integration
14+
- TLS 1.3 support
15+
- Network configuration using TAP interface
16+
17+
See the example's README.md for detailed setup and usage instructions.
18+
19+
### 2. FreeRTOS + wolfIP + wolfMQTT Client
20+
Located in `freertos-wolfip-wolfmqtt/`
21+
22+
Demonstrates:
23+
- MQTT client with TLS 1.3 using wolfMQTT
24+
- FreeRTOS POSIX simulation
25+
- wolfIP network stack integration
26+
- Secure MQTT over TLS
27+
- Network configuration using TAP interface
28+
29+
See the example's README.md for detailed setup and usage instructions.
30+
31+
## Common Requirements
32+
- Linux environment
33+
- Root access (for TAP interface setup)
34+
- CMake 3.13+
35+
- GCC
36+
- wolfSSL libraries
37+
- FreeRTOS source (automatically downloaded by setup scripts)
38+
39+
## Network Configuration
40+
Both examples use a TAP interface for network connectivity:
41+
- Host IP (Linux): 10.10.0.1/24
42+
- FreeRTOS client/server: 10.10.0.10/24
43+
44+
## Building and Running
45+
Each example contains:
46+
- `setup.sh`: Downloads and configures FreeRTOS
47+
- `setup_network.sh`: Configures TAP interface
48+
- `CMakeLists.txt`: Build configuration
49+
- Test scripts for verification
50+
51+
Follow the README.md in each example directory for specific instructions.

0 commit comments

Comments
 (0)