Skip to main content

Deployment

Ath the end of the day, Wave produces web-apps with their own web server. This means any VM provider can be used for Wave deployment.

Deploying Wave scripts​

Wave scripts are regular Python scripts. Deploy them as you would any Python script.

Deploying Wave apps​

Wave apps are ASGI-compatible, based on Uvicorn / Starlette, a high-performance Python server.

You can run Wave apps behind any ASGI server, like uvicorn, gunicorn, daphne, hypercorn, etc.

To run your app using an ASGI server, append :main to the app argument. For example, if you were normally executing your app foo.py using wave run foo, and want to run your app using Uvicorn, use uvicorn foo:main.

These commands are equivalent:

(venv) $ wave run --no-reload --no-autostart foo
(venv) $ uvicorn foo:main

For more information, see uvicorn.org/deployment and starlette.io/#performance.

To configure a different port, see configuring ports.

Beyond defaults​

If different than default ports are used for Wave server (http://localhost:10101) or Wave app (http://localhost:8000), it's necessary to properly set env variables:

  • Wave server - H2O_WAVE_LISTEN.
  • Wave app - H2O_WAVE_APP_ADDRESS and H2O_WAVE_ADDRESS.

More info about configuration options can be found in the configuration section.

Deploying with HTTPS​

Wave consists of 2 servers and both need to be configured separately.

  • Wave server - H2O_WAVE_TLS_CERT_FILE and H2O_WAVE_TLS_KEY_FILE
  • Wave app - uvicorn foo:main <other-params> --ssl-keyfile=<key file> --ssl-certfile=<cert file>. See uvicorn docs.

HTTPS is all or nothing meaning either both server and app use TLS or none does.

Deployment to separate machines​

Although most people deploy their Wave server and Wave app to the same machine, it's not the only way. When deploying to separate machines, the main challenge is to make sure Wave server and Wave app can communicate properly.

For wave app machine, the following needs to be set:

  • H2O_WAVE_APP_ADDRESS - the address of the Wave app machine that Wave server connects to. Defaults to http://localhost:8000. In real world, this would be something like http://myapp1.mycompany.com:8000.
  • H2O_WAVE_ADDRESS - the address of the Wave server machine. Defaults to http://localhost:10101. In real world, this would be something like http://myapp1server.mycompany.com:10101.
  • --host 0.0.0.0 - Uvicorn exposes localhost by default, which would only listen for local network requests. 0.0.0.0 tells it to listen on all addresses.
tip

Do not specify addresses with https protocol if you haven't configured Wave server and Wave app to use TLS.

AWS EC2 deployment​

See the detailed blog post by Greg Fousas.