Skip to content

Commit

Permalink
refactored README file to fit github's new font size
Browse files Browse the repository at this point in the history
  • Loading branch information
@ostinelli
ostinelli committed Jan 22, 2012
1 parent 10c8392 commit 545bf23
Showing 1 changed file with 105 additions and 76 deletions.
181 changes: 105 additions & 76 deletions README.txt
View file
@@ -1,46 +1,49 @@
==========================================================================================================
======================================================================================
MISULTIN - An Erlang library for building fast lightweight HTTP servers.
<https://github.com/ostinelli/misultin>

>-|-|-(°>


INSTALL INSTRUCTIONS
==========================================================================================================
======================================================================================

1. Compile

Run the appropriate script:

* OSX | Linux users: make
* Windows users: make.bat. Note that Erlang bin directory (by default, C:\Program Files\erl5.7.2\bin\)
must be in your path for the script to work.
* Windows users: make.bat. Note that Erlang bin directory (by default,
C:\Program Files\erl5.x.x\bin\) must be in your path for the script to work.

This script will compile the .erl files in the Misultin src directory and save the compiled files into the
ebin directory.
This script will compile the .erl files in the Misultin src directory and save the
compiled files into the ebin directory.

2. (Optional) Copy Misultin files

This optional step will allow Misultin to be called from modules running from any directory on your file
system.
This optional step will allow Misultin to be called from modules running from any
directory on your file system.

Locate the directory where Erlang is installed on your system. Under OSX and Linux, it should be something
similar to /usr/local/lib/erlang/ or /usr/lib/erlang/. Under Windows, Erlang is installed by default in
something similar to C:\Program Files\erl5.7.2\ (version changes may apply).
Locate the directory where Erlang is installed on your system. Under OSX and Linux, it
should be something similar to /usr/local/lib/erlang/ or /usr/lib/erlang/. Under
Windows, Erlang is installed by default in something similar to
C:\Program Files\erl5.7.2\ (version changes may apply).

Browse into the lib directory under this Erlang root and copy the root misultin-0.x directory into this
directory. You should now have Misultin under something similar to:
Browse into the lib directory under this Erlang root and copy the root misultin-0.x
directory into this directory. You should now have Misultin under something similar
to:

* OSX | Linux users: /usr/local/lib/erlang/lib/misultin-0.x/
* Windows users: C:\Program Files\erl5.7.2\lib\misultin-0.x\

3. Test

If you did proceed with step 2, CD to the Misultin examples directory and start an Erlang shell.
If you did proceed with step 2, CD to the Misultin examples directory and start an
Erlang shell.

If you did not proceed with step 2, copy the file misultin_hello_world.erl from the Misultin examples
directory to the directory where the .beam files compiled in step 1 are located, then CD to this
directory and start an Erlang shell.
If you did not proceed with step 2, copy the file misultin_hello_world.erl from the
Misultin examples directory to the directory where the .beam files compiled in step 1
are located, then CD to this directory and start an Erlang shell.

In the shell, compile and run misultin_hello_world by issuing:

Expand All @@ -49,8 +52,8 @@ In the shell, compile and run misultin_hello_world by issuing:
(one@rob.loc)2>misultin_hello_world:start(8080).
{ok,<0.50.0>}

Open your favourite browser and point it to http://localhost:8080/, you should read "Hello World."
printed on your page.
Open your favourite browser and point it to http://localhost:8080/, you should read
"Hello World." printed on your page.

You may now stop the misultin_hello_world HTTP server:

Expand All @@ -64,86 +67,101 @@ You're ready to go.


DOCUMENTATION
==========================================================================================================
======================================================================================

API Documentation is available online on the Misultin's wiki: https://github.com/ostinelli/misultin/wiki
API Documentation is available online on the Misultin's wiki:
https://github.com/ostinelli/misultin/wiki


SSL NOTES
==========================================================================================================
======================================================================================
If you are running misultin behind an SSL terminator such as stunnel or stud, then set
{ws_force_ssl, true}
so that websocket handshakes work.

If you are using stunnel to terminate, you can also set
{proxy_protocol, true}
to make misultin expect a PROXY.. line as per http://haproxy.1wt.eu/download/1.5/doc/proxy-protocol.txt
to make misultin expect a PROXY.. line as per
http://haproxy.1wt.eu/download/1.5/doc/proxy-protocol.txt

Newer versions of stunnel support this with the "protocol = proxy" config option.


CHANGELOG
==========================================================================================================
======================================================================================

0.9-dev:
- added SESSIONS state, persistent across requests
- added access log callback function, so that main application can log HTTP access
- added streaming input for big files or endless input, using a manual body_recv function in
conjunction with the {auto_recv_body, false} option
- added static directory support, so that GET requests to /static/* can automatically send files
from a specified directory (thanks to egobrain suggestion)
- added access log callback function, so that main application can log HTTP
access
- added streaming input for big files or endless input, using a manual body_recv
function in conjunction with the {auto_recv_body, false} option
- added static directory support, so that GET requests to /static/* can
automatically send files from a specified directory (thanks to egobrain
suggestion)
- added request redirection helper method
- consistently improved memory usage by not copying by default to handler processes the full request
or websocket record
- added configuration option to set which websocket versions must be supported by the server
- consistently improved memory usage by not copying by default to handler
processes the full request or websocket record
- added configuration option to set which websocket versions must be supported
by the server
- added support for websocket draft-hybi-10
- added support for websocket draft-hybi-17 (thanks to RJ)
- added support for websockets on FireFox (thanks to Egobrain)
- added support for 'If-Modified-Since' headers in file sending (thanks to davidgaleano)
- added support for websockets when behind stunnel with {external_ssl, boolean()} option (thanks to
RJ)
- added support for 'If-Modified-Since' headers in file sending (thanks to
davidgaleano)
- added support for websockets when behind stunnel with
{external_ssl, boolean()} option (thanks to RJ)
- added support to see the correct client IP when behind stunnel, according to
<http://haproxy.1wt.eu/download/1.5/doc/proxy-protocol.txt> (thanks to RJ)
- added support for OPTIONS method (thanks to majek)
- rebar-ized makefile
- corrected minor bugs (thank you all - you know who you are!)

0.8: - Misultin has been redesigned to use supervisor behaviours where appropriate, to be more OTP
compliant
0.8: - Misultin has been redesigned to use supervisor behaviours where appropriate,
to be more OTP compliant
- added Cookie support
- added preliminary support multipart/form-data and a file upload example [thanks to Max Lapshin]
- added preliminary support multipart/form-data and a file upload example
[thanks to Max Lapshin]
- added Date and Server headers
- added support for headers being specified as binaries [thanks to akaspin]
- added an example on how to properly embed misultin in your application
- Req:get(peer_addr) now properly extracts peer information from headers "X-Real-Ip" or
"X-Forwarded-For" if these are available [thanks to Max Lapshin]
- Req:get(peer_addr) now properly extracts peer information from headers
"X-Real-Ip" or "X-Forwarded-For" if these are available [thanks to Max
Lapshin]
- solved bug on large data being sent over via websockets [thanks to omarkj]
- corrected binary sending bug in websockets which would fail binaries on io_lib format [thanks to
normanb]
- corrected binary sending bug in websockets which would fail binaries on
io_lib format [thanks to normanb]
- added recbuf advanced option [issue #40]
- added preliminary test suite
- various optimizations using binary when needed

0.7.1: - considerably improved stability under heavy load
- misultin now accepts incoming connections with a pool of acceptors instead of a single one
- Misultin can now be used both with parametrized modules and with pure erlang code too [thanks to
yrashk, nox and essen]
- misultin now accepts incoming connections with a pool of acceptors instead of
a single one
- Misultin can now be used both with parametrized modules and with pure erlang
code too [thanks to yrashk, nox and essen]
- added support for HEAD, PUT, DELETE, TRACE and CONNECT methods
- now websockets are on {active, once} mode to avoid malicious clients overflooding [thanks to
essen]
- ensured that body of request can be read on all methods except TRACE as per http specs
- now websockets are on {active, once} mode to avoid malicious clients
overflooding [thanks to essen]
- ensured that body of request can be read on all methods except TRACE as per
http specs
- added support for iolist() in chunked resposes [thanks to RJ]

0.7: - added max_connections options parameter, which specifies maximum concurrent open connections
accepted by the server
- added post_max_size options parameter, which sets the maximum size of POST data
- added get_url_max_size options parameter, which sets the maximum length of URI
- added CHUNKED support, both for incoming requests and outgoing responses [thanks to yrashk
suggestion]
- added trapping of client closing a browser in Comet applications [thanks to yrashk]
0.7: - added max_connections options parameter, which specifies maximum concurrent
open connections accepted by the server
- added post_max_size options parameter, which sets the maximum size of POST
data
- added get_url_max_size options parameter, which sets the maximum length of
URI
- added CHUNKED support, both for incoming requests and outgoing responses
[thanks to yrashk suggestion]
- added trapping of client closing a browser in Comet applications [thanks to
yrashk]
- added SSL support for websockets [enhancement track #25, thanks to viplifes]
- Misultin can now be started without a registered name or with a different name, so that multiple
versions of misultin can be started on a single node
- added support for IP address specified in tuple format [thanks to okeuday suggestion]
- Misultin can now be started without a registered name or with a different
name, so that multiple versions of misultin can be started on a single node
- added support for IP address specified in tuple format [thanks to okeuday
suggestion]
- added support to extract plain uri unquoted as a list() [thanks to okeuday]
- added Comet Long Polling example
- added Comet iFrame example
Expand All @@ -156,14 +174,16 @@ CHANGELOG
- minor bug corrections

0.6.1: - added support to websocket protocol hixie draft 76 [thanks to sergio veiga]
- added support to multiple websocket draft protocols [for backwards compatibility]
- added ws_autoexit option which allows to get an event on websocket controlling processes [issue
track #15, suggestion of esente]
- added support to multiple websocket draft protocols [for backwards
compatibility]
- added ws_autoexit option which allows to get an event on websocket
controlling processes [issue track #15, suggestion of esente]
- added headers also in misultin websockets [thanks to jlirochon]
- made it basho's rebar friendly [thanks to mrinalwadhwa]

0.6: - added HTTP compression option
- refactoring of the main server loop, so that it is now isolated from the HTTP functionality
- refactoring of the main server loop, so that it is now isolated from the HTTP
functionality
- removed unnecessary compilation warnings
- replaced proplists:get_value with much faster utility function

Expand All @@ -173,40 +193,49 @@ CHANGELOG
0.4: - added preliminary websocket support

0.3.4: - added Req support to return the socket handling the request
- bug correction on Content-Length: 0 header causing timeout on POST requests [issue track #12,
thanks to gdamjan]
- bug correction on Content-Length: 0 header causing timeout on POST requests
[issue track #12, thanks to gdamjan]

0.3.3: - added echoing of the Connection header [issue track #7, thanks to thijsterlouw]
- bug correction on acceptor respawning [issue track #10, thanks to thijsterlouw]
0.3.3: - added echoing of the Connection header [issue track #7, thanks to
thijsterlouw]
- bug correction on acceptor respawning [issue track #10, thanks to
thijsterlouw]

0.3.2: - optimized error handling [issue track #5, thanks to Max Lapshin]

0.3.1: - added flow control using inet options {active, once} [issue track #4, thanks to Max Lapshin]
0.3.1: - added flow control using inet options {active, once} [issue track #4, thanks
to Max Lapshin]
- added support to standard http headers response
- added http 400 bad request error in socket handling
- bug correction: removed erroneous sending of response timeout on listening open connections
- bug correction: removed erroneous sending of response timeout on listening
open connections
- added stream_support optimization option

0.3: - reengineering of the listener process, using active instead of passive mode in request parsing,
except for BODY where passive is still used [thanks to Lev Walkin]
0.3: - reengineering of the listener process, using active instead of passive mode
in request parsing, except for BODY where passive is still used [thanks to
Lev Walkin]
- added better support for request timeout

0.2.2: - added .app file [thanks to Essien Ita Essien]
- simplified get_options [thanks to Essien Ita Essien]
- added ip address option [thanks to Essien Ita Essien]
- added ipv6 support
- added recv_timeout option
- bug correction: requests peer address and port are now not reset on open connections multiple
requests
- bug correction: requests peer address and port are now not reset on open
connections multiple requests

0.2.1: - added support for Content-Type that specifies charset in POST data [thanks to Tuncer Ayaz]
0.2.1: - added support for Content-Type that specifies charset in POST data [thanks to
Tuncer Ayaz]
- added support for iolist in misultin_req:ok/1,2 and misultin_req:respond/2,3
- code optimized taking out unnecessary binary conversion and lists:flatten [thanks to Feng Yu]
- code optimized taking out unnecessary binary conversion and lists:flatten
[thanks to Feng Yu]

0.2: - added trap exit for acceptor failure
- added backlog option
- added fallback if no connection header is present [issue track #1, thanks to Ciconia]
- added limit for parsing headers to avoid malicious attacks [thanks to Mazen Harake]
- added fallback if no connection header is present [issue track #1, thanks to
Ciconia]
- added limit for parsing headers to avoid malicious attacks [thanks to Mazen
Harake]
- minor bug corrections

0.1: - initial release.
Expand Down

0 comments on commit 545bf23

Please sign in to comment.