nx/docs/react/api-web/executors/file-server.md
Isaac Mann 1c94df17c7
docs(nxdev): fix link to docs from executors (#4908)
ISSUES CLOSED: #4862

Co-authored-by: Isaac Mann <isaacplmann+git@gmail.com>
2021-02-26 09:43:58 -05:00

79 lines
975 B
Markdown

# file-server
Serve a web application from a folder
Properties can be configured in workspace.json when defining the executor, or when invoking it.
Read more about how to use executors and the CLI here: https://nx.dev/react/getting-started/cli-overview#running-tasks.
## Properties
### buildTarget
Type: `string`
Target which builds the application
### host
Default: `localhost`
Type: `string`
Host to listen on.
### maxParallel
Type: `number`
Max number of parallel jobs
### parallel
Default: `true`
Type: `boolean`
Build the target in parallel
### port
Default: `4200`
Type: `number`
Port to listen on.
### proxyUrl
Type: `string`
URL to proxy unhandled requests to.
### ssl
Default: `false`
Type: `boolean`
Serve using HTTPS.
### sslCert
Type: `string`
SSL certificate to use for serving HTTPS.
### sslKey
Type: `string`
SSL key to use for serving HTTPS.
### withDeps
Default: `true`
Type: `boolean`
Build the target and all its deps