-
-
-
-
-
-
-
- |
-
- libwebsockets
-
- Lightweight C library for HTML5 websockets
- |
-
|
-
- libwebsockets
-
- Lightweight C library for HTML5 websockets
- |
-
Generic-table is a JSON schema and client-side JS file that makes it easy to display live, table structured HTML over a ws link.
-An example plugin and index.html using it are provided.
-Enable at CMake with -DLWS_WITH_PLUGINS=1
-When the ws connection is established, the protocol should send a JSON message describing the table columns. For example
-The
-
1.8.11 It enables libuv and plugin support automatically.
lwsws uses JSON config files, they're pure JSON but # may be used to turn the rest of the line into a comment.
+There's also a single substitution, if a string contains "_lws_ddir_", then that is replaced with the LWS install data directory path, eg, "/usr/share" or whatever was set when LWS was built + installed. That lets you refer to installed paths without having to change the config if your install path was different.
There is a single file intended for global settings
/etc/lwsws/conf
and a config directory intended to take one file per vhost
/etc/lwsws/conf.d/warmcat.com
To get started quickly, an example config reproducing the old test server on port 7681, non-SSL is provided. To set it up
1) When using a cgi:// protcol origin at a mountpoint, you may also give cgi environment variables specific to the mountpoint like this
This allows you to customize one cgi depending on the mountpoint (and / or vhost).
-2) It's also possible to set the cgi timeout (in secs) per cgi:// mount, like this
3) callback:// protocol may be used when defining a mount to associate a named protocol callback with the URL namespace area. For example
All handling of client access to /formtest[anything] will be passed to the callback registered to the protocol "protocol-post-demo".
+1) Some protocols may want "per-mount options" in name:value format. You can provide them using "pmo"
{
+ "mountpoint": "/stuff",
+ "origin": "callback://myprotocol",
+ "pmo": [{
+ "myname": "myvalue"
+ }]
+ }
+2) When using a cgi:// protcol origin at a mountpoint, you may also give cgi environment variables specific to the mountpoint like this
This allows you to customize one cgi depending on the mountpoint (and / or vhost).
+3) It's also possible to set the cgi timeout (in secs) per cgi:// mount, like this
4) callback:// protocol may be used when defining a mount to associate a named protocol callback with the URL namespace area. For example
All handling of client access to /formtest[anything] will be passed to the callback registered to the protocol "protocol-post-demo".
This is useful for handling POST http body content or general non-cgi http payload generation inside a plugin.
See the related notes in README.coding.md
-4) Cache policy of the files in the mount can also be set. If no options are given, the content is marked uncacheable.
4) You can also define a list of additional mimetypes per-mount
5) Cache policy of the files in the mount can also be set. If no options are given, the content is marked uncacheable.
6) You can also define a list of additional mimetypes per-mount
Protcols and extensions may also be provided from "plugins", these are lightweight dynamic libraries. They are scanned for at init time, and any protocols and extensions found are added to the list given at context creation time.
Protocols receive init (LWS_CALLBACK_PROTOCOL_INIT) and destruction (LWS_CALLBACK_PROTOCOL_DESTROY) callbacks per-vhost, and there are arrangements they can make per-vhost allocations and get hold of the correct pointer from the wsi at the callback.
This allows a protocol to choose to strictly segregate data on a per-vhost basis, and also allows the plugin to handle its own initialization and context storage.
diff --git a/doc/latex/md_README.lwsws.tex b/doc/latex/md_README.lwsws.tex index c3992ff4b..afe0aeda3 100644 --- a/doc/latex/md_README.lwsws.tex +++ b/doc/latex/md_README.lwsws.tex @@ -12,6 +12,8 @@ It enables libuv and plugin support automatically. lwsws uses J\+S\+ON config files, they\textquotesingle{}re pure J\+S\+ON but \# may be used to turn the rest of the line into a comment. +There\textquotesingle{}s also a single substitution, if a string contains \char`\"{}\+\_\+lws\+\_\+ddir\+\_\+\char`\"{}, then that is replaced with the L\+WS install data directory path, eg, \char`\"{}/usr/share\char`\"{} or whatever was set when L\+WS was built + installed. That lets you refer to installed paths without having to change the config if your install path was different. + There is a single file intended for global settings /etc/lwsws/conf @@ -240,7 +242,17 @@ Eg, with this mountpoint \subsection*{Other mount options } -1) When using a cgi\+:// protcol origin at a mountpoint, you may also give cgi environment variables specific to the mountpoint like this +1) Some protocols may want \char`\"{}per-\/mount options\char`\"{} in name\+:value format. You can provide them using \char`\"{}pmo\char`\"{} \begin{DoxyVerb} { + "mountpoint": "/stuff", + "origin": "callback://myprotocol", + "pmo": [{ + "myname": "myvalue" + }] + } +\end{DoxyVerb} + + +2) When using a cgi\+:// protcol origin at a mountpoint, you may also give cgi environment variables specific to the mountpoint like this \begin{DoxyCode} 1 \{ 2 "mountpoint": "/git", @@ -253,11 +265,11 @@ Eg, with this mountpoint \end{DoxyCode} This allows you to customize one cgi depending on the mountpoint (and / or vhost). -2) It\textquotesingle{}s also possible to set the cgi timeout (in secs) per cgi\+:// mount, like this +3) It\textquotesingle{}s also possible to set the cgi timeout (in secs) per cgi\+:// mount, like this \begin{DoxyCode} 1 "cgi-timeout": "30" \end{DoxyCode} - 3) {\ttfamily callback\+://} protocol may be used when defining a mount to associate a named protocol callback with the U\+RL namespace area. For example + 4) {\ttfamily callback\+://} protocol may be used when defining a mount to associate a named protocol callback with the U\+RL namespace area. For example \begin{DoxyCode} 1 \{ 2 "mountpoint": "/formtest", @@ -270,7 +282,7 @@ This is useful for handling P\+O\+ST http body content or general non-\/cgi http See the related notes in R\+E\+A\+D\+M\+E.\+coding.\+md -4) Cache policy of the files in the mount can also be set. If no options are given, the content is marked uncacheable. +5) Cache policy of the files in the mount can also be set. If no options are given, the content is marked uncacheable. \begin{DoxyCode} 1 \{ 2 "mountpoint": "/", @@ -283,7 +295,7 @@ See the related notes in R\+E\+A\+D\+M\+E.\+coding.\+md \end{DoxyCode} -4) You can also define a list of additional mimetypes per-\/mount +6) You can also define a list of additional mimetypes per-\/mount \begin{DoxyCode} 1 "extra-mimetypes": \{ 2 ".zip": "application/zip", diff --git a/lib/lejp-conf.c b/lib/lejp-conf.c index 81c85b100..4637aa9d3 100644 --- a/lib/lejp-conf.c +++ b/lib/lejp-conf.c @@ -27,6 +27,8 @@ #include