nebari-dev / nebari-dev/nebari-docs
[DOC] - Running servers on Nebari (panel serve, flask apps, etc)
Nobody has claimed this yet.
- Dominant language
- No language data
- Stars
- 21
- Forks
- 40
- Avg merge
- 19h 50m
- Merged PRs (30d)
- 6
Description
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/username@quansight.com/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
...
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start from the issue's server URL pattern and the panel serve example, then locate the relevant Nebari documentation entry point; no file or test is named in the payload. Document proxy URLs for server applications, including the Panel websocket-origin requirement, and verify the example is accurate.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- flask
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100