Prodigy annotation - Starting the web server at http://localhost:8080

[wanga (Albert Wang)]

For security purpose, how can I change http://localhost:8080 to https:?

[ines (Ines Montani)]

Hi! See here for the recommended approach:

Prodigy with https

I would recommend adding a reverse proxy in front that is restricted to only https connections. For instance, you would advertise the service on localhost, and have something like Nginx, Traefik or Apache communicating externally, via https.

If you're using Prodigy in Jupyterlab, see this thread:

jupyter-notebook: how to ssl the prodigy output?

I think the easiest solution would be to slightly tweak the uvicorn server in prodigy/app.py and add an SSL certificate (see the "Running with HTTPS" section here), so you can serve the Prodigy app via HTTPS. Then you'd be able to load it within an iframe on an HTTPS site. It might be as straightforward as adding two arguments for the SSL certificate to uvicorn.run. If that works, we can also easily add this as a feature to Prodigy, e.g. by accepting environment variables.

[wanga (Albert Wang)]

I need enable SSL. what i need do?
How to generate CSR for our CA certificate request?
What is the key file? Do I need generate key file separately? then input to prodigy or uvicorn?

[wanga (Albert Wang)]

How to modify "uvicorn.run" in app.py file to make https work?

[ines (Ines Montani)]

I'm not sure I understand the question? You can just edit the file in your Prodigy installation and it should work. See the threads I linked above and the uvicorn docs for details on how to set up SSL – this is something you'll have to set up independently of Prodigy.

[wanga (Albert Wang)]

Do you mean:

1. Create a ssl_keyfile and ssl_certfile using "Let's Encrypt" [Can I use Nignx to do it?]
   

   

2. In app.py file, add two more lines: ssl_keyfile, ssl_certfile like below?

uvicorn doesn't seem to accept our log levels via getLogger, so we also

# pass it in explicitly here
uvicorn.run(
    app,
    host=host,
    port=int(port),
    log_level=get_log_level(),
    log_config=_uvicorn_log_config,
    ssl_keyfile="path to keyfile",
    ssl_certfile = "path to cert file",
)

[ines (Ines Montani)]

Yes, exactly. You probably want to try it with a simple dummy application first and make sure the certificate works. Once you have it working with a standalone dummy app and uvicorn, you can port it over to Prodigy.