BWS and BAS - Embedded Web Servers
This repository contains the amalgamated C source code for Real Time Logic's embedded web and application server libraries:
- BWS: Barracuda Embedded Web Server, a compact HTTP(S) and WebSocket C library integrated with the SharkSSL TLS stack.
- BAS: Barracuda App Server, an application server and IoT toolkit built on BWS. BAS adds Lua, Lua Server Pages, and higher-level APIs for rapid embedded web and IoT development.
BWS and BAS share the same porting layer model and support a broad range of targets, including embedded Linux, Zephyr, FreeRTOS, lwIP, VxWorks, QNX, INTEGRITY, Windows, Azure RTOS, Nucleus RTOS, embOS, Mac, and other POSIX systems.
The BAS/BWS Agent Guide routes humans and AI assistants to the included skills and examples. Use the native C/C++ skill for BAS/BWS applications, REST services, WebSockets, VFS layouts, generated resources, uploads, WebDAV, and native integration. Use the Mako/Xedge Lua skill for Lua and Lua Server Pages applications, including application lifecycle, routing, browser interfaces, authentication, SMQ, SQLite, deployment, and Lua bindings. Use both skills when a native Mako/Xedge host exposes or extends Lua APIs.
| Example | Use it when | Important boundary |
|---|---|---|
| C-RESTful-Service | Implementing REST directly with BAS/BWS APIs, using a C-only toolchain, or minimizing additional code and memory overhead. | It does not use the Modern C++ REST library; it and the Modern C++ example are alternatives. |
| Modern-Cpp-REST-Service | Typed routes, structured errors, streaming, a modern C++ interface, or the embedded Svelte device UI are wanted. | It requires a modern C++ compiler and cpp/rest. |
| C-WebSockets | Building a native C++ WebSocket service with text/binary frames, multiple clients, broadcast concurrency, or embedded browser resources. | Use the Lua skill when WebSocket behavior belongs in a Mako/Xedge Lua application. |
| MakoServer | Building or customizing the standalone Mako executable, platform startup, native extensions, services, or resource packaging. | This is the native host, not an ordinary Lua/LSP application. See Mako Server compilation. |
| xedge | Porting or embedding Xedge into firmware/RTOS, including storage, hardware hooks, embedded resources, or native extensions. | This is the native host. Use the Lua skill for .preload, .config, .xlua, and LSP application work. See Xedge compilation. |
- If you plan to use BAS, start here and select your operating system: https://realtimelogic.com/downloads/bas/. This page includes a drop-down menu that opens purpose-built instructions for selected operating systems, including precompiled packages and platform-specific build options.
- To build or customize the native Mako Server or integrate Xedge into an RTOS/firmware target, see Compiling Mako Server and Xedge.
BAS and BWS Amalgamated are available under three license options:
- GPLv2
- Free commercial license for small companies: https://realtimelogic.com/startuplic/
- Standard royalty-free commercial license: https://realtimelogic.com/contactus/license/
Commercial licensing is available for users who cannot use BAS or BWS under GPLv2.
The following clarification applies to users who choose GPLv2 and distribute derivative work. The GPLv2 license applies to all BAS and BWS APIs, including but not limited to the BAS and BWS C APIs, BAS Lua APIs, and web content hosted by a BAS or BWS derivative product. Web content hosted by the server is considered part of the application as a whole.
GPLv2: https://www.gnu.org/licenses/old-licenses/gpl-2.0.en.html
This distribution includes cryptographic software. The country in which you reside may restrict the import, possession, use, or re-export of encryption software. Before using any encryption software, check your country's laws, regulations, and policies. See http://www.wassenaar.org/ for more information.
The U.S. Government Department of Commerce, Bureau of Industry and Security (BIS), has classified this software as Export Commodity Control Number (ECCN) 5D002.C.1. This includes information security software using or performing cryptographic functions with asymmetric algorithms. The form and manner of this distribution makes it eligible for export under License Exception ENC Technology Software Unrestricted (TSU), as described in BIS Export Administration Regulations, Section 740.13, for both object code and source code.
Details on the included cryptographic software are available here: