Skip to content

docs: Move CORS configuration to the REST API page #6431

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
igorlukanin merged 3 commits into from
Apr 13, 2023
Merged

docs: Move CORS configuration to the REST API page #6431

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ea4893a
Move
igorlukanin Apr 13, 2023
dffd52e
Lint
igorlukanin Apr 13, 2023
10891fc
Update docs/content/REST-API/REST-API.mdx
igorlukanin Apr 13, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 0 additions & 20 deletions docs/content/Configuration/Overview.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,25 +47,6 @@ mode does the following:
- Logs incorrect/invalid configuration for `externalRefresh` /`waitForRenew`
instead of throwing errors

## Configuring CORS

The Cube REST API supports Cross-Origin Resource Sharing (CORS) for all API
requests. By default, the middleware allows requests from any origin (`*`). To
change the allowed domain, you can do the following:

```javascript
module.exports = {
http: {
cors: {
origin: 'https://myapp.com',
},
},
};
```

Please consult the Configuration Reference [for more
options][link-config-cors-opts].

## Concurrency and pooling

<InfoBox>
Expand All @@ -85,7 +66,6 @@ default, you must ensure that the new value is greater than the number of
concurrent connections used by Cube's query queues and refresh scheduler.

[link-config]: /config
[link-config-cors-opts]: /config#http
[link-dev-playground]: /dev-tools/dev-playground
[link-env-vars]: /reference/environment-variables
[link-scheduled-refresh]: /schema/reference/pre-aggregations#scheduled-refresh
Expand Down
22 changes: 22 additions & 0 deletions docs/content/REST-API/REST-API.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,28 @@ you can still use it to pass a security context.
curl -H "Authorization: EXAMPLE-API-TOKEN" https://example.com/cubejs-api/v1/sql
```

### <--{"id" : "Prerequisites"}--> Configuring CORS

REST API supports [Cross-Origin Resource Sharing (CORS)][cors].

By default, requests from any origin (`*`) are allowed. To allow requests from a
specific domain only, use the following configuration in the `cube.js` file:

```javascript
module.exports = {
http: {
cors: {
origin: 'https://example.com',
},
},
};
```

Please see [configuration options][ref-config-cors] for details.

[cors]: https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS
[ref-config-cors]: /config#http

### <--{"id" : "Prerequisites"}--> Continue wait

If the request takes too long to be processed, Cube Backend responds with
Expand Down