mirror/mongoose
1
0
Fork 0
mirror of https://github.com/cesanta/mongoose.git synced 2024-11-28 05:19:08 +08:00
Code Issues Actions 5 Packages Projects Releases Wiki Activity

Docs updated

Browse Source
This commit is contained in:
Sergey Lyubka 2014-01-04 20:12:07 +00:00
parent 7cec2fe280
commit 96bb9aac36
2 changed files with 55 additions and 65 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

44
README.md
View File

@ -1,48 +1,34 @@
# Project Mission # Mongoose Web Server
Project mission is to provide easy to use, powerful, embeddable web server. Mongoose easy to use, powerful, embeddable web server. Quick links:
* [Downloads](http://cesanta.com/#downloads)
* [Documentation](http://cesanta.com/#docs,Usage.md)
* [Mailing list](http://groups.google.com/group/mongoose-users)
# Downloads & Docs # Features
Sources, binaries and bundles are available for download at
[http://cesanta.com/#downloads](http://cesanta.com/#downloads).
User documentation is available at
[http://cesanta.com/#docs](http://cesanta.com/#docs,Usage.md).
# Overview
Mongoose keeps the balance between functionality and
simplicity by carefully selected list of features:
- Works on Windows, Mac, UNIX/Linux, iPhone, Android, and many other platforms - Works on Windows, Mac, UNIX/Linux, iPhone, Android, and many other platforms
- CGI, SSL, Digest auth, Websocket, WEbDAV - CGI, SSL, Digest auth, Websocket, WEbDAV, Resumed download, URL rewrite, file blacklist, IP-based ACL, Windows service
- Resumed download, URL rewrite, file blacklist, IP-based ACL, Windows service - Scripting and database support ([Lua](http://lua.org) +
- Scripting and database support (Lua Server Pages + Sqlite, see [page.lp](https://github.com/cesanta/mongoose/blob/master/build/test/page.lp) ), [Sqlite](http://sqlite.org), see
[page.lp](https://github.com/cesanta/mongoose/blob/master/build/test/page.lp) ),
which provides ready to go, powerful web development platform in which provides ready to go, powerful web development platform in
one single-click executable with no dependencies one single-click executable with no dependencies
- Simple and clean - Simple and clean
[embedding API](https://github.com/cesanta/mongoose/blob/master/mongoose.h). [embedding API](https://github.com/cesanta/mongoose/blob/master/mongoose.h).
The source is in single The source is in single
[mongoose.c](https://github.com/cesanta/mongoose/blob/master/mongoose.c) file [mongoose.c](https://github.com/cesanta/mongoose/blob/master/mongoose.c) file
to make embedding easy. to make embedding easy
- Extremely lightweight, has a core of under 40kB and tiny runtime footprint - Extremely lightweight, has a core of under 40kB and tiny runtime footprint
- Asyncronouns, non-blocking core supporting single- or multi-threaded usage - Asyncronouns, non-blocking core supporting single- or multi-threaded usage
- On the market since 2004, stable, mature and tested, - On the market since 2004, stable, mature and tested,
has man-years invested in continuous improvement and refinement has several man-years invested in continuous improvement and refinement
- Professional support and consultancy available from
Note that Windows and MacOS binaries have following 3rd party software [Cesanta Software](http://cesanta.com), developer of Mongoose
compiled in:
<a href="http://wolfssl.com">WolfSSL lightweight SSL library</a>,
<a href="http://sqlite.org">SQLite embedded database</a>,
<a href="http://lua.org">Lua embedded scripting engine</a>.
Questions can be asked at
[mongoose-users@googlegroups.com](http://groups.google.com/group/mongoose-users)
mailing list.
# Acknowledgements # Acknowledgements
Author is grateful to the following people who made their contribution: Mongoose made better thanks to the contribution of following people:
Arnout Vandecappelle, Benoît Amiaux, Boris Pek, Cody Hanson, Colin Leitner, Arnout Vandecappelle, Benoît Amiaux, Boris Pek, Cody Hanson, Colin Leitner,
Daniel Oaks, Eric Bakan, Erik Oomen, Filipp Kovalev, Ger Hobbelt, Daniel Oaks, Eric Bakan, Erik Oomen, Filipp Kovalev, Ger Hobbelt,

76
docs/Usage.md
View File

@ -1,64 +1,66 @@
# Mongoose Usage Guide # Mongoose User Guide
Mongoose is small and easy to use web server. It is self-contained, and does Mongoose is small and easy to use web server built on top of
not require any external software to run. mongoose library. It is designed with maximum simplicity in mind. For example,
to share any directory, just drop mongoose executable file in that directory,
On Windows, mongoose iconifies itself to the system tray icon when started. double-click it (on UNIX, run it from shell) and launch a browser at
Right-click on the icon pops up a menu, where it is possible to stop [http://localhost:8080](http://localhost:8080) Note that 'localhost' should
mongoose, or configure it, or install it as Windows service. The easiest way
to share a folder on Windows is to copy `mongoose.exe` to a folder,
double-click the exe, and launch a browser at
[http://localhost:8080](http://localhost:8080). Note that 'localhost' should
be changed to a machine's name if a folder is accessed from other computer. be changed to a machine's name if a folder is accessed from other computer.
On UNIX and Mac, mongoose is a command line utility. Running `mongoose` in On Windows and Mac, Mongoose iconifies itself to the system tray when started.
Right-click on the icon pops up a menu, where it is possible to stop
mongoose, or configure it.
On UNIX, `mongoose` is a command line utility. Running `mongoose` in
terminal, optionally followed by configuration parameters terminal, optionally followed by configuration parameters
(`mongoose [OPTIONS]`) or configuration file name (`mongoose [OPTIONS]`) or configuration file name
(`mongoose [config_file_name]`) starts the (`mongoose [config_file_name]`) starts the
web server. Mongoose does not detach from terminal. Pressing `Ctrl-C` keys web server:
would stop the server.
$ mongoose -document_root /var/www # Running mongoose with cmdline options
$ mongoose /etc/my_config.txt # Running mongoose with config file
$ mongoose # Running with no parameters. This will
# serve current directory on port 8080
Mongoose does not detach from terminal. Pressing `Ctrl-C` keys
stops the server.
When started, mongoose first searches for the configuration file. When started, mongoose first searches for the configuration file.
If configuration file is specified explicitly in the command line, i.e. If configuration file is specified explicitly in the command line, then
`mongoose path_to_config_file`, then specified configuration file is used. specified configuration file is used.
Otherwise, mongoose would search for file `mongoose.conf` in the same directory Otherwise, mongoose would search for file `mongoose.conf` in the same directory
where binary is located, and use it. Configuration file can be absent. where binary is located, and use it. Configuration file can be absent.
Configuration file is a sequence of lines, each line containing Configuration file is a sequence of lines, each line containing
command line argument name and it's value. Empty lines, and lines beginning command line argument name and it's value. Empty lines and lines beginning
with `#`, are ignored. Here is the example of `mongoose.conf` file: with `#` are ignored. Here is the example of `mongoose.conf` file:
document_root c:\www # This is a comment
listening_ports 8080,8043s document_root C:\www
ssl_certificate c:\mongoose\ssl_cert.pem listening_port 80
ssl_certificate C:\mongoose\ssl_cert.pem
When configuration file is processed, mongoose process command line arguments, Command line arguments are highest priority and can override
if they are specified. Command line arguments therefore can override configuration file settings. For example, if `mongoose.conf` has line
configuration file settings. Command line arguments must start with `-`.
For example, if `mongoose.conf` has line
`document_root /var/www`, and mongoose has been started as `document_root /var/www`, and mongoose has been started as
`mongoose -document_root /etc`, then `/etc` directory will be served as `mongoose -document_root /etc`, then `/etc` directory will be used as
document root, because command line options take priority over document root.
configuration file. Configuration options section below provide a good
overview of Mongoose features.
Note that configuration options on the command line must start with `-`, Note that configuration options on the command line must start with `-`,
but their names are the same as in the config file. All option names are and their names are the same as in the config file. Exampli gratia,
listed in the next section. Thus, the following two setups are equivalent: the following two setups are equivalent:
# Using command line arguments $ mongoose -listening_port 1234 -document_root /var/www
$ mongoose -listening_ports 1234 -document_root /var/www
# Using config file $ cat > mongoose.conf
$ cat mongoose.conf
listening_ports 1234 listening_ports 1234
document_root /var/www document_root /var/www
^D
$ mongoose $ mongoose
Mongoose can also be used to modify `.htpasswd` passwords file: Mongoose can also be used to modify `.htpasswd` passwords file:
mongoose -A <htpasswd_file> <realm> <user> <passwd> $ mongoose -A .htpasswd mydomain.com user_name user_password
Unlike other web servers, mongoose does not require CGI scripts be located in Unlike other web servers, mongoose does not require CGI scripts be located in
a special directory. CGI scripts can be anywhere. CGI (and SSI) files are a special directory. CGI scripts can be anywhere. CGI (and SSI) files are
@ -78,4 +80,6 @@ All other characters in the pattern match themselves. Examples:
/foo Any string that begins with /foo /foo Any string that begins with /foo
**a$|**b$ Any string that ends with a or b **a$|**b$ Any string that ends with a or b
To restrict CGI files only to `/cgi-bin/` directory, use this setting:
$ mongoose -cgi_pattern /cgi-bin/*.cgi # Emulate /cgi-bin/ restriction