Deployment Documentation

Problem

It’s still a little unclear how one would actually deploy and “own” jupyterlite.

Proposed Solution

Add a Deployment section which includes:

• how to configure
  • where to put a jupyterlite.json
  • JSON Schema
• how to get the code
  • we could be shipping the tarball to the docs site, which is as good as any, for now
• configuring different SaaS providers
  • vercel
  • github pages
  • readthedocs
• on-premises
  • nginx?
  • inside other host apps
    • jupyterhub
    • jupyter_server (#41)
      • jupyter-server-proxy
    • django?
    • fastapi?
    • flask?
  • how to configure CDN replacements (#45)

Additional context

• #30 probably required before this is actually important

[JacobJeppesen]

Thanks for the quick reply.

I changed it such that Django acts as a “dumb” http server when serving JupyterLite, and serves the files directly from the collected static files (just had to install whitenoise to allow this). Everything seems to work now. Looking back, this is really how I should have done it to start with.

If anyone else needs this, the working example is here: https://github.com/JacobJeppesen/jupyterlite-django-deployment

[bollwyvl]

Yeah, there are a lot of distracting directions (e.g. #141) right now, but getting a minimal CLI out is probably more important. Once written, It’s going to be much easier to keep that documented in a semi-automatic way, e.g. jupyter lite --help, rather than a bunch of narrative docs.

Once that works, it will be:

pip install jupyterlite <any labextensions you want>
jupyter lite init ./my-jupyterlite
cp <your notebooks> ./my-jupyterlite/files
jupyter lite build ./my-jupyterlite

…and the contents of ./my-jupyterlite will be a ready-to-host site, on s3 or whatever. Shouldn’t have any nodejs dependency. We can leave some hooks open, e.g. jupyter lite publish --to s3 but that implementation probably wouldn’t live in this repo.

Since #141 isn’t going to be merged any time soon, maybe I’ll switch gears and try and get something passable out re #41…