README.lwsws.md

   1 Libwebsockets Web Server
   2 ------------------------
   3
   4 lwsws is an implementation of a very lightweight, ws-capable generic web
   5 server, which uses libwebsockets to implement everything underneath.
   6
   7 Build
   8 -----
   9
  10 Just enable -DLWS_WITH_LWSWS=1 at cmake-time.
  11
  12 It enables libuv and plugin support automatically.
  13
  14
  15 Configuration
  16 -------------
  17
  18 lwsws uses JSON config files, they're pure JSON but # may be used to turn the rest of the line into a comment.
  19
  20 There is a single file intended for global settings
  21
  22 /etc/lwsws/conf
  23
  24 ```
  25 # these are the server global settings
  26 # stuff related to vhosts should go in one
  27 # file per vhost in ../conf.d/
  28
  29 {
  30   "global": {
  31    "uid": "48",  # apache user
  32    "gid": "48",  # apache user
  33    "count-threads": "1",
  34    "server-string": "myserver v1", # returned in http headers
  35    "init-ssl": "yes"
  36  }
  37 }
  38 ```
  39
  40 and a config directory intended to take one file per vhost
  41
  42 /etc/lwsws/conf.d/warmcat.com
  43
  44 ```
  45 {
  46         "vhosts": [{
  47                 "name": "warmcat.com",
  48                 "port": "443",
  49                 "interface": "eth0",  # optional
  50                 "host-ssl-key": "/etc/pki/tls/private/warmcat.com.key",  # if given enable ssl
  51                 "host-ssl-cert": "/etc/pki/tls/certs/warmcat.com.crt",
  52                 "host-ssl-ca": "/etc/pki/tls/certs/warmcat.com.cer",
  53                 "mounts": [{  # autoserve
  54                         "mountpoint": "/",
  55                         "origin": "file:///var/www/warmcat.com",
  56                         "default": "index.html"
  57                 }]
  58         }]
  59 }
  60 ```
  61
  62 Vhosts
  63 ------
  64
  65 One server can run many vhosts, where SSL is in use SNI is used to match
  66 the connection to a vhost and its vhost-specific SSL keys during SSL
  67 negotiation.
  68
  69 Listing multiple vhosts looks something like this
  70
  71 ```
  72 {
  73  "vhosts": [ {
  74      "name": "localhost",
  75      "port": "443",
  76      "host-ssl-key":  "/etc/pki/tls/private/libwebsockets.org.key",
  77      "host-ssl-cert": "/etc/pki/tls/certs/libwebsockets.org.crt",
  78      "host-ssl-ca":   "/etc/pki/tls/certs/libwebsockets.org.cer",
  79      "mounts": [{
  80        "mountpoint": "/",
  81        "origin": "file:///var/www/libwebsockets.org",
  82        "default": "index.html"
  83        }, {
  84         "mountpoint": "/testserver",
  85         "origin": "file:///usr/local/share/libwebsockets-test-server",
  86         "default": "test.html"
  87        }],
  88      # which protocols are enabled for this vhost, and optional
  89      # vhost-specific config options for the protocol
  90      #
  91      "ws-protocols": [{
  92        "warmcat,timezoom": {
  93          "status": "ok"
  94        }
  95      }]
  96     },
  97     {
  98     "name": "localhost",
  99     "port": "7681",
 100      "host-ssl-key":  "/etc/pki/tls/private/libwebsockets.org.key",
 101      "host-ssl-cert": "/etc/pki/tls/certs/libwebsockets.org.crt",
 102      "host-ssl-ca":   "/etc/pki/tls/certs/libwebsockets.org.cer",
 103      "mounts": [{
 104        "mountpoint": "/",
 105        "origin": ">https://localhost"
 106      }]
 107    },
 108     {
 109     "name": "localhost",
 110     "port": "80",
 111      "mounts": [{
 112        "mountpoint": "/",
 113        "origin": ">https://localhost"
 114      }]
 115    }
 116
 117   ]
 118 }
 119 ```
 120
 121 That sets up three vhosts all called "localhost" on ports 443 and 7681 with SSL, and port 80 without SSL but with a forced redirect to https://localhost
 122
 123
 124 Vhost name and port
 125 -------------------
 126
 127 The vhost name field is used to match on incoming SNI or Host: header, so it
 128 must always be the host name used to reach the vhost externally.
 129
 130  - Vhosts may have the same name and different ports, these will each create a
 131 listening socket on the appropriate port.
 132
 133  - Vhosts may also have the same port and different name: these will be treated as
 134 true vhosts on one listening socket and the active vhost decided at SSL
 135 negotiation time (via SNI) or if no SSL, then after the Host: header from
 136 the client has been parsed.
 137
 138
 139 Protocols
 140 ---------
 141
 142 Vhosts by default have available the union of any initial protocols from context creation time, and
 143 any protocols exposed by plugins.
 144
 145 Vhosts can select which plugins they want to offer and give them per-vhost settings using this syntax
 146
 147 ```
 148      "ws-protocols": [{
 149        "warmcat-timezoom": {
 150          "status": "ok"
 151        }
 152      }]
 153
 154 ```
 155
 156 The "x":"y" parameters like "status":"ok" are made available to the protocol during its per-vhost
 157 LWS_CALLBACK_PROTOCOL_INIT (@in is a pointer to a linked list of struct lws_protocol_vhost_options
 158 containing the name and value pointers).
 159
 160 To indicate that a protocol should be used when no Protocol: header is sent
 161 by the client, you can use "default": "1"
 162
 163 ```
 164      "ws-protocols": [{
 165        "warmcat-timezoom": {
 166          "status": "ok",
 167          "default": "1"
 168        }
 169      }]
 170
 171 ```
 172
 173
 174 Other vhost options
 175 -------------------
 176
 177  - If the three options `host-ssl-cert`, `host-ssl-ca` and `host-ssl-key` are given, then the vhost supports SSL.
 178
 179  Each vhost may have its own certs, SNI is used during the initial connection negotiation to figure out which certs to use by the server name it's asking for from the request DNS name.
 180
 181  - `keeplive-timeout` (in secs) defaults to 60 for lwsws, it may be set as a vhost option
 182
 183  - `interface` lets you specify which network interface to listen on, if not given listens on all
 184
 185  - "`unix-socket`": "1" causes the unix socket specified in the interface option to be used instead of an INET socket
 186
 187  - "`sts`": "1" causes lwsws to send a Strict Transport Security header with responses that informs the client he should never accept to connect to this address using http.  This is needed to get the A+ security rating from SSL Labs for your server.
 188
 189  - "`access-log`": "filepath"   sets where apache-compatible access logs will be written
 190
 191
 192 Mounts
 193 ------
 194
 195 Where mounts are given in the vhost definition, then directory contents may
 196 be auto-served if it matches the mountpoint.
 197
 198 Mount protocols are used to control what kind of translation happens
 199
 200  - file://  serve the uri using the remainder of the url past the mountpoint based on the origin directory.
 201
 202  Eg, with this mountpoint
 203
 204 ```
 205        {
 206         "mountpoint": "/",
 207         "origin": "file:///var/www/mysite.com",
 208         "default": "/"
 209        }
 210 ```
 211
 212  The uri /file.jpg would serve /var/www/mysite.com/file.jpg, since / matched.
 213
 214  - ^http:// or ^https://  these cause any url matching the mountpoint to issue a redirect to the origin url
 215
 216  - cgi://   this causes any matching url to be given to the named cgi, eg
 217
 218 ```
 219        {
 220         "mountpoint": "/git",
 221         "origin": "cgi:///var/www/cgi-bin/cgit",
 222         "default": "/"
 223        }, {
 224         "mountpoint": "/cgit-data",
 225         "origin": "file:///usr/share/cgit",
 226         "default": "/"
 227        },
 228 ```
 229
 230  would cause the url /git/myrepo to pass "myrepo" to the cgi /var/www/cgi-bin/cgit and send the results to the client.
 231
 232 Note: currently only a fixed set of mimetypes are supported.
 233
 234
 235 Other mount options
 236 -------------------
 237
 238 1) When using a cgi:// protcol origin at a mountpoint, you may also give cgi environment variables specific to the mountpoint like this
 239
 240 ```
 241        {
 242         "mountpoint": "/git",
 243         "origin": "cgi:///var/www/cgi-bin/cgit",
 244         "default": "/",
 245         "cgi-env": [{
 246                 "CGIT_CONFIG": "/etc/cgitrc/libwebsockets.org"
 247         }]
 248        }
 249 ```
 250
 251  This allows you to customize one cgi depending on the mountpoint (and / or vhost).
 252
 253 2) It's also possible to set the cgi timeout (in secs) per cgi:// mount, like this
 254
 255 ```
 256         "cgi-timeout": "30"
 257 ```
 258
 259 3) Cache policy of the files in the mount can also be set.  If no
 260 options are given, the content is marked uncacheable.
 261
 262        {
 263         "mountpoint": "/",
 264         "origin": "file:///var/www/mysite.com",
 265         "cache-max-age": "60",      # seconds
 266         "cache-reuse": "1",         # allow reuse at client at all
 267         "cache-revalidate": "1",    # check it with server each time
 268         "cache-intermediaries": "1" # allow intermediary caches to hold
 269        }
 270
 271
 272 Plugins
 273 -------
 274
 275 Protcols and extensions may also be provided from "plugins", these are
 276 lightweight dynamic libraries.  They are scanned for at init time, and
 277 any protocols and extensions found are added to the list given at context
 278 creation time.
 279
 280 Protocols receive init (LWS_CALLBACK_PROTOCOL_INIT) and destruction
 281 (LWS_CALLBACK_PROTOCOL_DESTROY) callbacks per-vhost, and there are arrangements
 282 they can make per-vhost allocations and get hold of the correct pointer from
 283 the wsi at the callback.
 284
 285 This allows a protocol to choose to strictly segregate data on a per-vhost
 286 basis, and also allows the plugin to handle its own initialization and
 287 context storage.
 288
 289 To help that happen conveniently, there are some new apis
 290
 291  - lws_vhost_get(wsi)
 292  - lws_protocol_get(wsi)
 293  - lws_callback_on_writable_all_protocol_vhost(vhost, protocol)
 294  - lws_protocol_vh_priv_zalloc(vhost, protocol, size)
 295  - lws_protocol_vh_priv_get(vhost, protocol)
 296
 297 dumb increment, mirror and status protocol plugins are provided as examples.
 298
 299
 300 Additional plugin search paths
 301 ------------------------------
 302
 303 Packages that have their own lws plugins can install them in their own
 304 preferred dir and ask lwsws to scan there by using a config fragment
 305 like this, in its own conf.d/ file managed by the other package
 306
 307 {
 308   "global": {
 309    "plugin-dir": "/usr/local/share/coherent-timeline/plugins"
 310   }
 311 }
 312
 313
 314 lws-server-status plugin
 315 ------------------------
 316
 317 One provided protocol can be used to monitor the server status.
 318
 319 Enable the protocol like this on a vhost's ws-protocols section
 320
 321        "lws-server-status": {
 322          "status": "ok",
 323          "update-ms": "5000"
 324        }
 325
 326 "update-ms" is used to control how often updated JSON is sent on a ws link.
 327
 328 And map the provided HTML into the vhost in the mounts section
 329
 330        {
 331         "mountpoint": "/server-status",
 332         "origin": "file:///usr/local/share/libwebsockets-test-server/server-status",
 333         "default": "server-status.html"
 334        }
 335
 336 You might choose to put it on its own vhost which has "interface": "lo", so it's not
 337 externally visible.
 338
 339
 340 Integration with Systemd
 341 ------------------------
 342
 343 lwsws needs a service file like this as `/usr/lib/systemd/system/lwsws.service`
 344
 345 ```
 346 [Unit]
 347 Description=Libwebsockets Web Server
 348 After=syslog.target
 349
 350 [Service]
 351 ExecStart=/usr/local/bin/lwsws
 352 StandardError=null
 353
 354 [Install]
 355 WantedBy=multi-user.target
 356
 357 ```
 358
 359 You can find this prepared in `./lwsws/usr-lib-systemd-system-lwsws.service`
 360
 361
 362 Integration with logrotate
 363 --------------------------
 364
 365 For correct operation with logrotate, `/etc/logrotate.d/lwsws` (if that's
 366 where we're putting the logs) should contain
 367
 368 ```
 369 /var/log/lwsws/*log {
 370     copytruncate
 371     missingok
 372     notifempty
 373     delaycompress
 374 }
 375 ```
 376
 377 You can find this prepared in `/lwsws/etc-logrotate.d-lwsws`
 378
 379 Prepare the log directory like this
 380
 381 ```
 382 sudo mkdir /var/log/lwsws
 383 sudo chmod 700 /var/log/lwsws
 384 ```