From e81f8373a22d86f9310c2ec769bdf91fb5efb31a Mon Sep 17 00:00:00 2001 From: Sergey Lyubka <sergey.lyubka@cesanta.com> Date: Thu, 2 Feb 2017 16:08:49 +0200 Subject: [PATCH] Update mongoose docs PUBLISHED_FROM=cfd0018a5824c5ccac532558be86c17cda64ce50 --- README.md | 2 +- docs/dns/client_example.md | 4 +++- docs/dns_resolver/overview.md | 6 +++++- docs/http/digest_auth.md | 13 ++++++++++++- docs/mqtt/client_example.md | 2 +- docs/mqtt/server_example.md | 2 +- 6 files changed, 23 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 52b4e729d..d219b2e12 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,7 @@ Looking for a complete IoT firmware solution? Check out [Mongoose OS](https://mongoose-iot.com) - open source embedded operating system for low-power connected microcontrollers. Secure, designed for Internet of Things, complete environment for prototyping, development and managing. # Support -- [Study mongoose example code](https://github.com/cesanta/mongoose/tree/master/examples) +- [Study mongoose example code](https://github.com/cesanta/mongoose-examples) - [Read User Guide and API reference](https://docs.cesanta.com/mongoose) - [Support Forum - ask your technical questions here] (http://forum.cesanta.com/index.php?p=/categories/mongoose) - [Commercial licensing and support available] (https://www.cesanta.com/services-support) diff --git a/docs/dns/client_example.md b/docs/dns/client_example.md index e30cd436c..29e94fa72 100644 --- a/docs/dns/client_example.md +++ b/docs/dns/client_example.md @@ -2,4 +2,6 @@ title: DNS client example --- -TBD +See https://github.com/cesanta/mongoose/blob/master/mongoose.c and search +for the `mg_resolve_async_eh()` function - that is the core of +built-in Mongoose async DNS resolver. diff --git a/docs/dns_resolver/overview.md b/docs/dns_resolver/overview.md index 4d20f230f..41049ac57 100644 --- a/docs/dns_resolver/overview.md +++ b/docs/dns_resolver/overview.md @@ -2,4 +2,8 @@ title: Overview --- -TBD +Mongoose uses non-blocking DNS resolver. For each name to be resolved, +it first checks the `/etc/hosts` file (or, `hosts` on Windows). +If the entry is not found there, then the `8.8.8.8` DNS server is queried. +When IP address is found, Mongoose proceeds with making the connection +with the resolved IP address. diff --git a/docs/http/digest_auth.md b/docs/http/digest_auth.md index cbdc4bbc6..a49c95f9f 100644 --- a/docs/http/digest_auth.md +++ b/docs/http/digest_auth.md @@ -2,4 +2,15 @@ title: Digest Authentication --- -TBD +Mongoose has a built-in Digest (MD5) authentication support. In order to +enable Digest authentication, create a file `.htpasswd` in the directory +you would like to protect. That file should be in the format that Apache's +`htdigest` utility. + +You can use either Apache `htdigest` utility, or +Mongoose pre-build binary (https://www.cesanta.com/products/binary) +to add new users into that file: + +``` +mongoose -A /path/to/.htdigest mydomain.com joe joes_password +``` diff --git a/docs/mqtt/client_example.md b/docs/mqtt/client_example.md index 993be0f06..22502b58b 100644 --- a/docs/mqtt/client_example.md +++ b/docs/mqtt/client_example.md @@ -2,4 +2,4 @@ title: MQTT client example --- -TBD +See https://github.com/cesanta/mongoose-examples/tree/master/examples/mqtt_client diff --git a/docs/mqtt/server_example.md b/docs/mqtt/server_example.md index 706fb5e52..ef1473591 100644 --- a/docs/mqtt/server_example.md +++ b/docs/mqtt/server_example.md @@ -2,4 +2,4 @@ title: MQTT server example --- -TBD +See https://github.com/cesanta/mongoose-examples/tree/master/examples/mqtt_broker -- GitLab