[DOCS] Include server.cors configuration settings
#47701
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Include `server.cors` configuration settings
rwaight
added
Team:Docs
Team:Core
|
Pinging @elastic/kibana-operations (Team:Operations) |
|
Pinging @elastic/kibana-platform (Team:Platform) |
|
Pinging @elastic/kibana-docs (Team:Docs) |
💔 Build Failed |
gchaps
added
release_note:skip
joshdover
reviewed
Oct 9, 2019
docs/setup/settings.asciidoc
Outdated
| @@ -253,6 +253,10 @@ running behind a proxy. Use the `server.rewriteBasePath` setting to tell Kibana | |||
| if it should remove the basePath from requests it receives, and to prevent a | |||
| deprecation warning at startup. This setting cannot end in a slash (`/`). | |||
|
|
|||
| [[server-cors]]`server.cors:`:: *Default: `false`* Set to `true` to enable CORS support, this setting is required in order to configure `server.cors.origin`. | |||
|
|
|||
| `server.cors.origin:`:: *Default: none* Used to specify origins, "origin" must be an array. This setting requires `server.cors: true` set. Use `server.cors.origin: ["*"]` to accept all origins. | |||
There was a problem hiding this comment.
I'm actually not sure the server.cors.origins feature is implemented in production mode. We still have an open issue about this: #16714
Someone will need to verify, I may have some time later today.
KOTungseth
reviewed
Oct 10, 2019
docs/setup/settings.asciidoc
Outdated
| @@ -253,6 +253,10 @@ running behind a proxy. Use the `server.rewriteBasePath` setting to tell Kibana | |||
| if it should remove the basePath from requests it receives, and to prevent a | |||
| deprecation warning at startup. This setting cannot end in a slash (`/`). | |||
|
|
|||
| [[server-cors]]`server.cors:`:: *Default: `false`* Set to `true` to enable CORS support, this setting is required in order to configure `server.cors.origin`. | |||
There was a problem hiding this comment.
Not critical, but could we split this into two sentences? For example:
Set to true to enable CORS support. This setting is required to configure server.cors.origin.
docs/setup/settings.asciidoc
Outdated
| @@ -253,6 +253,10 @@ running behind a proxy. Use the `server.rewriteBasePath` setting to tell Kibana | |||
| if it should remove the basePath from requests it receives, and to prevent a | |||
| deprecation warning at startup. This setting cannot end in a slash (`/`). | |||
|
|
|||
| [[server-cors]]`server.cors:`:: *Default: `false`* Set to `true` to enable CORS support, this setting is required in order to configure `server.cors.origin`. | |||
|
|
|||
| `server.cors.origin:`:: *Default: none* Used to specify origins, "origin" must be an array. This setting requires `server.cors: true` set. Use `server.cors.origin: ["*"]` to accept all origins. | |||
There was a problem hiding this comment.
I think this could benefit from some reformatting. What do you think about:
Specifies origins. "origin" must be an array. To use this setting, you must set server.cors to true. To accept all origins, use server.cors.origin: ["*"].
Update formatting in the `server.cors` configuration settings
KOTungseth
approved these changes
Oct 10, 2019
💔 Build Failed |
|
@elasticmachine update branch |
💔 Build Failed |
|
@elasticmachine merge upstream |
|
Thank you @spalger and @KOTungseth. I'll |
rwaight
added a commit
that referenced
this pull request
Oct 11, 2019
Include `server.cors` configuration settings -- back port to 7.x from #47701
rwaight
added a commit
that referenced
this pull request
Oct 11, 2019
Include `server.cors` configuration settings -- back port to 7.4 from #47701 [skip ci]
rwaight
added a commit
that referenced
this pull request
Oct 11, 2019
Include `server.cors` configuration settings -- back port to 7.x from #47701
rwaight
added a commit
that referenced
this pull request
Oct 11, 2019
Include `server.cors` configuration settings -- back port to 7.4 from #47701 [skip ci]
2 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Include
server.corsconfiguration settings in the Kibana documentation. Closes #40095@KOTungseth FYI, this should be reviewed to ensure the defaults and descriptions are accurate.
Checklist
Use
strikethroughsto remove checklist items you don't feel are applicable to this PR.### For maintainers[skip ci]