Commitfede783

authored

Merge pull request#925 from http-party/fix-cors-documentation

Fix CORS option documentation to match actual behavior

2 parents9d7dd6b +360b798 commitfede783Copy full SHA for fede783

File tree

-4

lines changed

-4

lines changed

Lines changed: 1 addition & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -69,7 +69,7 @@ with the provided Dockerfile.`
`69`	`69`	\|`-b` or`--brotli`\|When enabled it will serve`./public/some-file.js.br` in place of`./public/some-file.js` when a brotli compressed version of the file exists and the request accepts`br` encoding. If gzip is also enabled, it will try to serve brotli first.\|`false`\|
`70`	`70`	\|`-e` or`--ext`\|Default file extension if none supplied\|`html`\|
`71`	`71`	\|`-s` or`--silent`\|Suppress log messages from output\|\|
`72`		-\|`--cors`\|Enable CORS via the`Access-Control-Allow-Origin` header\|\|
	`72`	+\|`--cors`\|Enable CORS via the`Access-Control-Allow-Origin: *` header. Optionally provide comma-separated values to add to`Access-Control-Allow-Headers`\|\|
`73`	`73`	\|`-H` or`--header`\|Add an extra response header (can be used several times)\|\|
`74`	`74`	\|`-o [path]`\|Open browser window after starting the server. Optionally provide a URL path to open. e.g.: -o /other/dir/\|\|
`75`	`75`	\|`-c`\|Set cache time (in seconds) for cache-control max-age header, e.g.`-c10` for 10 seconds. To disable caching, use`-c-1`.\|`3600`\|

Lines changed: 2 additions & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -36,7 +36,8 @@ if (argv.h \|\| argv.help) {`
`36`	`36`	`' -e --ext Default file extension if none supplied [none]',`
`37`	`37`	`' -s --silent Suppress log messages from output',`
`38`	`38`	`' --cors[=headers] Enable CORS via the "Access-Control-Allow-Origin" header',`
`39`		`-' Optionally provide CORS headers list separated by commas',`
	`39`	`+' When enabled, sets Access-Control-Allow-Origin to "*"',`
	`40`	`+' Optional value adds to Access-Control-Allow-Headers',`
`40`	`41`	`' -H',`
`41`	`42`	`' --header',`
`42`	`43`	`' Add an extra response header (can be used several times)',`

Lines changed: 3 additions & 2 deletions

Original file line number	Diff line number	Diff line change
`@@ -59,8 +59,9 @@ Suppress log messages from output.`
`59`	`59`
`60`	`60`	`.TP`
`61`	`61`	`.BI\-\-cors"" [\fIHEADERS\fR]`
`62`		`-Enable CORS via the "Access-Control-Allow-Origin" header.`
`63`		`-Optionally provide CORS headers list separated by commas.`
	`62`	`+Enable CORS by setting "Access-Control-Allow-Origin" to "*".`
	`63`	`+Optional comma-separated headers list adds to "Access-Control-Allow-Headers".`
	`64`	`+Default Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept, Range.`
`64`	`65`
`65`	`66`	`.TP`
`66`	`67`	`.BI\-H","\-\-header""\fIHEADER\fR`

Lines changed: 3 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -98,6 +98,9 @@ function HttpServer(options) {`
`98`	`98`	`});`
`99`	`99`	`}`
`100`	`100`
	`101`	`+// CORS configuration:`
	`102`	`+// --cors enables CORS by setting Access-Control-Allow-Origin to '*'`
	`103`	`+// --cors=header1,header2 also adds custom headers to Access-Control-Allow-Headers`
`101`	`104`	`if(options.cors){`
`102`	`105`	`this.headers['Access-Control-Allow-Origin']='*';`
`103`	`106`	`this.headers['Access-Control-Allow-Headers']='Origin, X-Requested-With, Content-Type, Accept, Range';`

Comments

(0)