Skip to content

Commit f3a0ff1

Browse files
dan-fRubenVerborgh
authored andcommitted
Update README.md for v4.0.0
1 parent 9ea4f0a commit f3a0ff1

File tree

1 file changed

+39
-20
lines changed

1 file changed

+39
-20
lines changed

README.md

Lines changed: 39 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -145,30 +145,49 @@ $ solid init --help
145145
146146
147147
$ solid start --help
148+
148149
Usage: start [options]
150+
149151
run the Solid server
150152
153+
151154
Options:
152-
-h, --help output usage information
153-
--root [value] Root folder to serve (defaut: './')
154-
--port [value] Port to use (default: '8443')
155-
--serverUri [value] Solid server uri (default: 'https://localhost:8443')
156-
--webid Enable WebID authentication and access control (uses HTTPS. default: true)
157-
--owner [value] Set the owner of the storage (overwrites the root ACL file)
158-
--ssl-key [value] Path to the SSL private key in PEM format
159-
--ssl-cert [value] Path to the SSL certificate key in PEM format
160-
--multiuser Enable multi-user mode
161-
--corsProxy [value] Serve the CORS proxy on this path
162-
--data-browser Enable viewing RDF resources using a default data browser application (e.g. mashlib)
163-
--suffix-acl [value] Suffix for acl files (default: '.acl')
164-
--suffix-meta [value] Suffix for metadata files (default: '.meta')
165-
--secret [value] Secret used to sign the session ID cookie (e.g. "your secret phrase")
166-
--error-pages [value] Folder from which to look for custom error pages files (files must be named <error-code>.html -- eg. 500.html)
167-
--mount [value] Serve on a specific URL path (default: '/')
168-
--force-user [value] Force a WebID to always be logged in (useful when offline)
169-
--strict-origin Enforce same origin policy in the ACL
170-
-v, --verbose Print the logs to console
171-
```
155+
156+
--root [value] Root folder to serve (default: './data')
157+
--port [value] SSL port to use
158+
--serverUri [value] Solid server uri (default: 'https://localhost:8443')
159+
--webid Enable WebID authentication and access control (uses HTTPS)
160+
--mount [value] Serve on a specific URL path (default: '/')
161+
--config-path [value]
162+
--db-path [value]
163+
--auth [value] Pick an authentication strategy for WebID: `tls` or `oidc`
164+
--certificate-header [value]
165+
--owner [value] Set the owner of the storage (overwrites the root ACL file)
166+
--ssl-key [value] Path to the SSL private key in PEM format
167+
--ssl-cert [value] Path to the SSL certificate key in PEM format
168+
--no-reject-unauthorized Accept self-signed certificates
169+
--multiuser Enable multi-user mode
170+
--idp [value] Obsolete; use --multiuser
171+
--no-live Disable live support through WebSockets
172+
--proxy [value] Obsolete; use --corsProxy
173+
--corsProxy [value] Serve the CORS proxy on this path
174+
--suppress-data-browser Suppress provision of a data browser
175+
--data-browser-path [value] An HTML file which is sent to allow users to browse the data (eg using mashlib.js)
176+
--suffix-acl [value] Suffix for acl files (default: '.acl')
177+
--suffix-meta [value] Suffix for metadata files (default: '.meta')
178+
--secret [value] Secret used to sign the session ID cookie (e.g. "your secret phrase")
179+
--error-pages [value] Folder from which to look for custom error pages files (files must be named <error-code>.html -- eg. 500.html)
180+
--force-user [value] Force a WebID to always be logged in (useful when offline)
181+
--strict-origin Enforce same origin policy in the ACL
182+
--useEmail Do you want to set up an email service?
183+
--email-host [value] Host of your email service
184+
--email-port [value] Port of your email service
185+
--email-auth-user [value] User of your email service
186+
--email-auth-pass [value] Password of your email service
187+
--useApiApps Do you want to load your default apps on /api/apps?
188+
--api-apps [value] Path to the folder to mount on /api/apps
189+
-v, --verbose Print the logs to console
190+
```
172191

173192
## Library Usage
174193

0 commit comments

Comments
 (0)