Skip to content

Commit 622bfe1

Browse files
author
nicola
committed
cleaning documentation
1 parent d1994ab commit 622bfe1

1 file changed

Lines changed: 14 additions & 23 deletions

File tree

‎README.md‎

Lines changed: 14 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -70,29 +70,20 @@ $ ldnode -v
7070

7171
The command line tool has the following options
7272

73-
usage: ldnode [path] [options]
74-
75-
options:
76-
--uri Address, port, and default path of the server. (Example: http://localhost:3000/test/)
77-
--base Base location to serve resources. Requests whose paths do not have base as a prefix will be ignored
78-
--live Offer and support live updates
79-
-p Port to use
80-
-v Log messages to console
81-
--changesSuffix The suffix that will be used to identify the requests that will subscribe to changes to the object requested. Defaults to ,changes
82-
--cors Enable CORS via the 'Access-Control-Allow-Origin' header
83-
-c Set cache time (in seconds). e.g. -c10 for 10 seconds.
84-
To disable caching, use -c-1.
85-
--changesSuffix sss Change the URI suffix used for the URI of a change stream
86-
--SSESuffix sss Change the URI suffix used for the URI of a SSE stream
87-
88-
-S --ssl Enable https.
89-
-C --cert Path to ssl cert file (default: cert.pem).
90-
-K --key Path to ssl key file (default: key.pem).
91-
92-
--webid Enable WebID authentication
93-
--privateKey Path to the private key used to enable webid authentication
94-
--cert Path to the private key used to enable webid authentication
95-
-h --help Print this list and exit.
73+
Usage: ldnode [options]
74+
75+
Options:
76+
-v, --verbose Print the logs to console
77+
--version Print current ldnode version
78+
-u, --uri Default address of the server (e.g. http[s]://host:port/path)
79+
-b, --base Base location to serve resources
80+
-p, --port Port to use
81+
-c, --cache Set cache time (in seconds), 0 for no cache
82+
-K, --key Path to the ssl key
83+
-C, --cert Path to the ssl cert
84+
--webid Enable WebID+TLS authentication
85+
-s, --secret HTTP Session secret key (e.g. "your secret phrase")
86+
-s, --no-live Disable live support through WebSockets
9687

9788
## Tests
9889

0 commit comments

Comments
 (0)