[DOC] - Running servers on Nebari (panel serve, flask apps, etc)

[kcpevey]

Preliminary Checks

• This issue is not a question, feature request, RFC, or anything other than a bug report. Please post those things in GitHub Discussions: https://github.com/nebari-dev/nebari/discussions

Summary

If you're running something as a server on Nebari, you'll need to modify the URL to get the proper link.

The URL will need to be in the form:
{nebari instance url}/user/{username}/proxy/{port}/{app_name}

Supposing {username} ran panel serve --allow-websocket-origin=nebari.qhub.dev --port 5006 my_app.py

The url to access this app will be: https://nebari.quansight.dev/user/[email protected]/proxy/5006/my_app (without the extension).

Note that Panel is also a special case where you'll need to add "allow-websocket-origin" parameter for security reasons.

Steps to Resolve this Issue

...

[pavithraes]

Thanks for opening this, @kcpevey!

Some context for new folks interested in contributing, we need to document the above behavior in relevant pages, including:

• https://www.nebari.dev/docs/tutorials/creating-cds-dashboard
• https://www.nebari.dev/docs/troubleshooting

[pmeier]

In case you deploy something without an {app_name}, the URL must include a trailing / after {port}, i.e. {nebari instance url}/user/{username}/proxy/{port}/. Dropping the /, i.e. {nebari instance url}/user/{username}/proxy/{port} will send relative requests, e.g. static files, to {nebari instance url}/user/{username}/proxy/ as root.

[Adam-D-Lewis]

Relevant info: nebari-dev/nebari#2273