From 1c525ef1ad7d3f9aa117a48d009a61821513a9bb Mon Sep 17 00:00:00 2001 From: Jeremy Tuloup Date: Tue, 8 Oct 2024 17:27:11 +0000 Subject: [PATCH] add deployment section to the README --- README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/README.md b/README.md index a778afe..762c7b1 100644 --- a/README.md +++ b/README.md @@ -46,6 +46,18 @@ Then build a new JupyterLite site: jupyter lite build ``` +## Deployment + +If you would like to deploy a JupyterLite site with the terminal extension, you will need to configure your server to add the `Cross-Origin-Embedder-Policy` and `Cross-Origin-Opener-Policy` headers. + +As an example, this repository deploys the JupyterLite terminal to [Vercel](https://vercel.com), using the following files: + +- `vercel.json`: configure the COOP / COEP server headers +- `requirements-deploy.txt`: dependencies for the JupyterLite deployment +- `deploy.sh`: script to deploy to Vercel, using micromamba to have full control on the Python versions and isolate the build in a virtual environment + +For more information, have a look at the JupyterLite documentation: https://jupyterlite.readthedocs.io/ + ## Contributing ### Development install