Skip to content

Commit

Permalink
Added link to nginx config guide (#146)
Browse files Browse the repository at this point in the history
  • Loading branch information
AtibQur authored Oct 17, 2024
1 parent 37c9d98 commit 76e998d
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion sites/cheerpx/src/content/docs/10-getting-started/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,11 +84,13 @@ The example below demonstrates how to set up the file system and devices using [

CheerpX requires [SharedArrayBuffer](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/SharedArrayBuffer), which itself requires the site to be cross-origin isolated. To enable cross-origin isolation, serve over HTTPS and set the following headers:

```yaml
```
Cross-Origin-Embedder-Policy: require-corp
Cross-Origin-Opener-Policy: same-origin
```

For detailed instructions on how to configure headers in Nginx, check our [Nginx configuration guide].

During development, you don't need to use HTTPS if you're using `localhost` as the origin, the `COEP` and `COOP` headers are always required though. You'll need to make sure you serve over HTTPS when you deploy.

> [!warning] Cross-origin isolation may break existing site functionality
Expand Down Expand Up @@ -125,3 +127,5 @@ await cx.run("/bin/bash", ["--login"], {
Now you can interact with the console to run commands. Make sure to give focus to the `console` element by clicking on the page if what you type on your keyboard is not displayed.

---

[Nginx configuration guide]: /docs/guides/nginx

0 comments on commit 76e998d

Please sign in to comment.