Page
Library
Module
Module type
Parameter
Class
Class type
Source
Mehari_lwt_unix
SourceAn IO module Mehari implementation for Unix and Windows using Lwt. Contains also extra features based on Unix filesystem such as CGI.
include Mehari_mirage.S with type addr = Ipaddr.t
TCP/IP stack.
include Mehari.NET
with module IO := IO
and type addr = Ipaddr.t
with type addr = Ipaddr.t
Type for IP address.
Rate limiter. See Rate limit.
type middleware =
(addr Mehari.request -> Mehari.response IO.t) ->
addr Mehari.request ->
Mehari.response IO.t
Middlewares take a handler
, and run some code before or after — producing a “bigger” handler
. See Middleware.
Does nothing but call its inner handler. Useful for disabling middleware conditionally during application startup:
if development then
my_middleware
else
Mehari.no_middleware
Combines a list of middlewares into one, such that these two lines are equivalent: Mehari.pipeline [ mw1 ; mw2 ] @@ handler
mw1 @@ mw2 @@ handler
.
Creates a router. If none of the routes match the Mehari.request
, the router returns Mehari.not_found
.
val route :
?rate_limit:rate_limiter ->
?mw:middleware ->
?regex:bool ->
string ->
(addr Mehari.request -> Mehari.response IO.t) ->
route
route ~rate_limit ~mw ~regex path handler
forwards requests for path
to handler
. path
can be a string literal or a regex in Perl style depending of value of regex
. If rate limit is in effect, handler
is not executed and a respond with Mehari.status
Mehari.slow_down
is sended.
scope ~rate_limit ~mw prefix routes
groups routes
under the path prefix
, rate_limit
and mw
.
A dummy value of type route
that is completely ignored by the router. Useful for disabling routes conditionally during application start.
val make_rate_limit :
?period:int ->
int ->
[ `Second | `Minute | `Hour | `Day ] ->
rate_limiter
make_rate_limit ~period n unit
creates a rate_limiter
which limits client to n
request per period * unit
. For example,
make_rate_limit ~period:2 5 `Hour
limits client to 5 requests every 2 hours.
val virtual_hosts :
?meth:[ `ByURL | `SNI ] ->
(string * (addr Mehari.request -> Mehari.response IO.t)) list ->
addr Mehari.request ->
Mehari.response IO.t
virtual_hosts ?meth [(domain, handler); ...]
produces a handler
which enables virtual hosting at the TLS-layer using SNI.
meth
can be used to choose which source to match the hostnames against. Defaults to `SNI
.Set Mehari's logger to the given log level.
val logger :
(addr Mehari.request -> Mehari.response IO.t) ->
addr Mehari.request ->
Mehari.response IO.t
Logs and times requests. Time spent logging is included.
Same as Mehari.response
, but the new Mehari.response
is wrapped in a promise.
Same as respond
but respond with given Mehari.body
and use given Mehari.mime
as mime type.
Same as respond
but respond with given text and use text/plain
as Mehari.mime
type.
val respond_gemtext :
?charset:string ->
?lang:string list ->
Mehari.Gemtext.t ->
Mehari.response IO.t
Same as respond
but respond with given Mehari.Gemtext.t
and use text/gemini
as Mehari.mime
type.
val respond_raw :
[ `Body of string | `Full of int * string * string ] ->
Mehari.response IO.t
Same as Mehari.response_raw
, but the new Mehari.response
is wrapped in a promise.
include Mehari.FS
with module IO := IO
and type addr := addr
and type dir_path := string
Mehari supports CGI scripting as described in RFC 3875
The CGI script must write the gemini response to the stdout stream. Status code and meta string on the first line, and the optional response body on subsequent lines. The bytes generated by the CGI script will be forwarded verbatim to the Gemini client, without any additional modification by the server.
Some variables are empty for compatibility with other CGI script.
Let's say that the url requested is gemini://localhost/cgi/foo.cgi?input
:
AUTH_TYPE
: CERTIFICATE
if a client certificate is provided, empty otherwise.CONTENT_LENGTH
: Empty.CONTENT_TYPE
: Empty.GATEWAY_INTERFACE
: CGI/1.1
.PATH_INFO
: Example value: /cgi/foo.cgi
.PATH_TRANSLATED
: Example value: /cgi/foo.cgi
.QUERY_STRING
: Example value: input
.REMOTE_ADDR
: Example value: 127.0.0.1
.REMOTE_HOST
: Same as REMOTE_ADDR
.REMOTE_IDENT
: Empty.REMOTE_METHOD
: Empty.REMOTE_USER
: Client certificate common if it is provided, empty otherwise.SCRIPT_NAME
: Example value: /var/cgi/foo.cgi
.SERVER_NAME
: Example value: /var/cgi/foo.cgi
.SERVER_PORT
: Example value: 1965
.SERVER_PROTOCOL
: GEMINI
.SERVER_SOFTWARE
: Example value: Mehari/1.0
.val run_cgi :
?timeout:float ->
?nph:bool ->
string ->
addr Mehari.request ->
Mehari.response Lwt.t
run_cgi ?timeout ?nph script_path req
executes the given file as a CGI script and return a Mehari.response
based on bytes printed on stdout by script. Responds with Mehari.cgi_error
in case of error or timeout
exceeding.
timeout
defaults to 5.0
.nph
decides if NPH (Non-Parsed Header) is enable. Defaults to false
.val run_lwt :
?port:int ->
?verify_url_host:bool ->
?config:Tls.Config.server ->
?timeout:float ->
certchains:Tls.Config.certchain list ->
?v4:Ipaddr.V4.Prefix.t ->
?v6:Ipaddr.V6.Prefix.t ->
handler ->
unit Lwt.t
See Mehari_mirage.S.run
.