removed leftover merge text
[henge/kiak.git] / usage
1 Usage: strapp [OPTION]...
2 Route https connections from a hardware port to a remote host, and initiate
3 peer-to-peer connection with clients. A 'route' is established from the first
4 directory specified in the requested URL.
5
6 CONFIG
7 -c, --config=path[:path]...
8
9 Configuration files to use. Each file in the sequence
10 can override any of the previous file's settings.
11 (/etc/strapp.conf:~/.strapp/strapp.conf:./strapp.conf)
12 - config settings are overridden by command line opts
13
14 -j, --client-js=path Path to the client Strapp code (./client.js)
15 -J, --host-js=path Path to the host Strapp code (./host.js)
16 -C, --ca-cert=path Accessible location of the CA Cert (../certs/cert.pem)
17 -K, --ca-key=path Accessible location of the CA Key (../certs/key.pem)
18 -p, --port=number The local port to bind HTTP/S listener to (2443)
19 -d, --file-dir=path Path to the directory that will serve files over HTTP
20 if a client's requested route doesn't exist and can't
21 be created
22
23 ROUTING
24 -b, --bind=[string:path[,string:path]]...
25
26 Bindings of routes to paths. Any route bound to a
27 path will, instead of distributing the strapp client,
28 service the file at that path. If the file is a
29 directory, it will be mounted at that route. Multiple
30 bindings may be established by separating the
31 key:value pairs with ',' commas. (www:./www)
32 e.g. Service a typical frontpage
33 -i ./html/index.html -b js:./js,html:./html,css:./css
34 e.g. Route-based http hosting
35 -b user1:/home/user1/www,user2:/home/user2/www
36
37 -e, --electron=string Specify a route name for the local electron render
38 window which will be launched on execution (nil)
39 - enables optional electron dependency
40
41 -D, --dedicated=string Route all incoming connections to this route (nil)
42 - can be used in conjunction with '-e' for single-user
43 e.g. Create a dedicated electron listener
44 $ strapp -e default -d default
45 - All routes point to 'default' which is bound to
46 the local electron window. No other hosts may
47 be established, so no remote hosts may exist
48
49 COMPATIBILITY
50 --no-tls=bool Don't use HTTPS and WSS protocols (false)
51 - makes 'ca-cert' and 'ca-key' unnecessary
52
53 --legacy-socket=bool Use Socket.io compatibility layer to enable
54 long-polling and AJAX fallbacks (false)
55 - enables optional socket.io dependency
56
57 (c)2017 loljk