Skip to content
Snippets Groups Projects
README.md 3.6 KiB
Newer Older
Sergey Lyubka's avatar
Sergey Lyubka committed
# Mongoose - Embedded Web Server / Embedded Networking Library
![](https://img.shields.io/badge/license-GPL_2-green.svg "License")
Mongoose is ideal for embedded environments. It has been designed
Sergey Lyubka's avatar
Sergey Lyubka committed
for connecting devices and bringing them online. On the market since 2004,
used by vast number of open source and
commercial products - it even runs on the International Space station!
Sergey Lyubka's avatar
Sergey Lyubka committed
Mongoose makes embedded network programming fast, robust, and easy.
Sergey Lyubka's avatar
Sergey Lyubka committed
- [Download Mongoose Source Code here](https://www.cesanta.com/download.html)
Sergey Lyubka's avatar
Sergey Lyubka committed

novlean's avatar
novlean committed
Connectivity is vital for software and embedded devices, but there are many pitfalls to consider when embedding a web server. 
This white paper breaks down on the top 9 things to avoid when embedding a web server.

- [Download “9 Things NOT to do when embedding a web server” white paper here](https://www.cesanta.com/whitepaper.html)

Looking for a complete IoT firmware solution?

Check out [Mongoose OS](https://mongoose-os.com) - open source embedded operating system for low-power connected microcontrollers. Secure, designed for Internet of Things, complete environment for prototyping, development and managing.
- [Study mongoose example code](https://github.com/cesanta/mongoose/tree/master/examples)
Dmitry Frank's avatar
Dmitry Frank committed
- [Read User Guide and API reference](https://cesanta.com/docs/overview/intro.html)
novlean's avatar
novlean committed
- [Support Forum - ask your technical questions here](https://community.mongoose-os.com/)
Sergey Lyubka's avatar
Sergey Lyubka committed
- [Commercial licensing and support available](https://www.cesanta.com/licensing.html)
- [Check our latest releases](https://github.com/cesanta/mongoose/releases)
Sergey Lyubka's avatar
Sergey Lyubka committed

* Cross-platform: works on Linux/UNIX, MacOS, QNX, eCos, Windows, Android,
Sergey Lyubka's avatar
Sergey Lyubka committed
  iPhone, FreeRTOS (TI CC3200, ESP8266), etc
* Supported hardware platforms: TI CC3200, TI MSP432, NRF52, STM32, PIC32, ESP8266, ESP32 and more
* Builtin protocols:
   - plain TCP, plain UDP, SSL/TLS (over TCP, one-way or two-way)
   - HTTP client, HTTP server
Evelyn's avatar
Evelyn committed
   - WebSocket client, WebSocket server
   - MQTT client, MQTT broker
   - CoAP client, CoAP server
   - DNS client, DNS server, async DNS resolver
* Single-threaded, asynchronous, non-blocking core with simple event-based API
* Native support for [PicoTCP embedded TCP/IP stack](http://www.picotcp.com),
  [LWIP embedded TCP/IP stack](https://en.wikipedia.org/wiki/LwIP)
* Tiny static and run-time footprint
* Source code is both ISO C and ISO C++ compliant
* Very easy to integrate: just copy
  [mongoose.c](https://raw.githubusercontent.com/cesanta/mongoose/master/mongoose.c) and
  [mongoose.h](https://raw.githubusercontent.com/cesanta/mongoose/master/mongoose.h)
  files to your build tree
Evelyn's avatar
Evelyn committed

# Licensing

Mongoose is released under Commercial and [GNU GPL v.2](http://www.gnu.org/licenses/old-licenses/gpl-2.0.html) open source licenses.
Evelyn's avatar
Evelyn committed

Sergey Lyubka's avatar
Sergey Lyubka committed
Commercial Projects: [Contact us for commercial license.](https://www.cesanta.com/contact.html)
Sergey Lyubka's avatar
Sergey Lyubka committed
# Dashboard Example
Sergey Lyubka's avatar
Sergey Lyubka committed
Mongoose is often used to implement device dashboards and real-time
data exchange over Websocket. Here is a dashboard example that illustrates
the functionality:

Sergey Lyubka's avatar
Sergey Lyubka committed
![](http://www.cesanta.com/images/dashboard.png)
Sergey Lyubka's avatar
Sergey Lyubka committed
[Developing a new product? Contact us today to discuss how Mongoose can help.](https://www.cesanta.com/contact.html)
Evelyn's avatar
Evelyn committed
# Contributions

Contributions are welcome! Please follow the guidelines below:

- Sign [Cesanta CLA](https://cesanta.com/cla.html) and send GitHub pull request
- When making pull requests, please make sure that it has only one commit,
 and imlements/fixes only one piece of functionality
Evelyn's avatar
Evelyn committed

# Looking for a pre-compiled Mongoose web server Windows or Mac binary?
Sergey Lyubka's avatar
Sergey Lyubka committed
- [Download pre-compiled Mongoose web server binary.](https://www.cesanta.com/binary.html)