Streamlit Cloud Port Proxying on streamlit.io

banesullivan · April 29, 2022, 5:53pm

Hi there, I’m just now playing around with streamlit and impressed with the webapps I can spin up locally - but I’m running into issues deploying on the cloud.

This seems related to: Streamlit Cloud Open Ports cc @penfever

@giswqs has also struggled with this issue when deploying leafmap on Streamlit.io: https://streamlit.geemap.org/

Specifically, I am working to create a streamlit app with localtileserver: a Python package the creates a background thread with a web server to perform dynamic tile serving of geospatial raster imagery. localtileserver launches a web server that serves tiles in the Slippy Maps standated (i.e., zoom/x/y.png) so that an image can be visualized with something like streamlit-folium. Learn more:

I ran into this same issue when running localtileserver in JupyterHub as well but I was able to mitigate the issue through the use of jupyter-server-proxy:

In essence, localtileserver launches a web server on a random local port (let’s say 5555) and jupyter-server-proxy enables users to access that port on the server from their remote web browser by proxying localhost:5555 to https://hub-binder.mybinder.ovh/user/banesullivan-lo-tileserver-demo-25vjflmj/proxy/44373/ for example.

I’m wondering if there is a way to proxy a port like this on streamlit.io like with JupyterHub?

None of this is an issue when running locally as my local browser can access localhost:5555 but in the cloud, we need to proxy that port somehow so that it is available under a URL like https://share.streamlit.io/me/myapp/proxy/5555 or similar

This would be a game-changer for the kinds of apps I could create and deploy with streamlit cloud so any help would be massively appreciated!

Here is a preview of my app running locally:

banesullivan · April 29, 2022, 5:54pm

My repository for this app is here: GitHub - banesullivan/streamlit-localtileserver: A streamlit demo of localtileserver

giswqs · April 29, 2022, 6:24pm

It would be fantastic if we can get localtileserver to work with Streamlit Cloud. It will make rendering raster datasets in the cloud so much easier!

banesullivan · May 3, 2022, 8:36pm

Following up as I’m investigating this.

This currently open feature request seems like the it’s heading towards what I would need:

github.com/streamlit/streamlit

Support custom HTTP requests

opened 04:21AM - 17 Oct 19 UTC

tvst

enhancement

See: https://discuss.streamlit.io/t/streamlit-restful-app/409 Some users woul…d like to have their Streamlit servers work double duty as both a Streamlit app server and a data server (for REST endpoints, for example) ### API proposal 1 A traditional-looking API for that would be something like: ```python st.server.add_route('foo', foo_callback) ``` Then, when a POST or GET HTTP request is made against `/foo`, the callback `foo_callback` would handle it and return a response. I haven't thought through whether this would be possible to implement given our current "run from the top" architecture. It's possible this would require a big refactor. ### API proposal 2 A more Streamlit-style API would be something like: ```python if st.server.request.foo == 'bar': st.server.respond({'data': df}) # And .respond() would cause the script to finish executing immediately. ``` In this proposal, the `if` condition would be true if: - The user sent a POST to `/` with `foo` set to `bar` (either in a form or in JSON) - Or the user sent a GET to `/?foo=bar` This API is easier to implement and arguably easier to understand. --- My preference at this point is proposal 2. That said, both of these proposals are just straw-man designs to start a discussion. I believe neither of these is ready to implement at this point.

And is related to this topic: Streamlit restful app

banesullivan · May 3, 2022, 11:09pm

Opened a PR:

github.com/streamlit/streamlit

Add opt-in port proxying via jupyter-server-proxy

streamlit:develop ← banesullivan:feat/portProxy

opened 11:07PM - 03 May 22 UTC

banesullivan

+23 -0

## 📚 Context This addresses https://github.com/streamlit/streamlit/issues/439…#issuecomment-1116651595 and my issues described in https://discuss.streamlit.io/t/streamlit-cloud-port-proxying-on-streamlit-io/24748/4 by using `jupyter_server_proxy`'s `LocalProxyHandler` to proxy requests through the web app to any locally hosted server. cc @giswqs - What kind of change does this PR introduce? - [ ] Bugfix - [x] Feature - [ ] Refactoring - [ ] Other, please describe: ## 🧠 Description of Changes These changes make it so that a user can specify `portProxy` in their config and have `jupyter-server-proxy` installed to proxy any port on the localhost through the streamlit web app: ``` [server] portProxy = false ``` Locally, this allows you to do the following where you can launch a web server in a background thread and access it through the streamlit web server: ```py import requests import streamlit as st from werkzeug import Request, Response from server_thread import ServerThread @Request.application def app(request): return Response(f"howdy: {request.args}", 200) # Launch app in a background thread # This could be a tornado or flask or django or whatever app server = ServerThread(app) # Perform requests against the server without blocking url = f"http://localhost:8501/proxy/{server.port}/?foo=bar" st.write(url) r = requests.get(url) st.write(r.content) ``` ![Screen Shot 2022-05-03 at 4 54 52 PM](https://user-images.githubusercontent.com/22067021/166586100-3774f5da-3472-4f5a-8585-124d19213340.png) As cool as it is to say *Howdy* to a web server running on a different port, this enables a whole bunch of additional cool things you could do with streamlit like the following with my [`localtileserver`](https://github.com/banesullivan/localtileserver) package In `localtileserver`, I use `server-thread` much like the example above but to spin up a geospatial image tile server on a randomly chosen port on the host machine. I then need to proxy requests from the browser using mapping frameworks like Leaflet via `streamlit-folium` through the streamlit server to the tile server. I have included a demo that leverages this in: https://github.com/banesullivan/streamlit-localtileserver/pull/1/files Which looks a little something like: ![Screen Shot 2022-05-03 at 4 50 09 PM](https://user-images.githubusercontent.com/22067021/166586544-393bebf9-aa1a-497e-b1f0-393a99360d50.png) and you can see that the image tile requests in the browser coming from Leaflet are going through the proxied URL: ![Screen Shot 2022-05-03 at 4 50 49 PM](https://user-images.githubusercontent.com/22067021/166586589-1fe7abd4-2f60-4c8b-a82e-58e00c8f2169.png) ### Things I'm unsure about - [ ] Testing... should I add `jupyter-server-proxy` as a test dependency and test this feature? - [ ] Will this work on streamlit cloud? Because I really *need* it to ## 🧪 Testing Done - [x] Screenshots included - [ ] Added/Updated unit tests - [ ] Added/Updated e2e tests ## 🌐 References _Does this depend on other work, documents, or tickets?_ This depends on [`jupyter-server-proxy`](https://github.com/jupyterhub/jupyter-server-proxy) where they have done a lot of the leg work for implementing a `RequestHandler` that can proxy requests. IMO, this feature should be opt-in and until someone is able to implement a request handler for proxying like this directly in streamlit, that a try import/except clause is pretty acceptable. - **Issue**: Addresses #439 --- **Contribution License Agreement** By submitting this pull request you agree that all contributions to this project are made under the Apache 2.0 license.

system · May 3, 2023, 11:10pm

This topic was automatically closed 365 days after the last reply. New replies are no longer allowed.

Topic		Replies	Views
Jupyterhub + Streamlit Using Streamlit jupyter	22	12156	January 12, 2022
Running Streamlit behind proxy - Websocket Port Using Streamlit debugging	2	111	September 5, 2024
App stuck in "Please Wait" Ubuntu 18.04 Deployment	6	1079	May 29, 2024
Websockets non-negotiable? Using Streamlit	4	4707	November 19, 2021
My streamlit is running properly on local but not on streamlit cloud Community Cloud streamlit-cloud	4	431	November 4, 2023

Streamlit Cloud Port Proxying on streamlit.io

Related topics

Hello there 👋🏻

Cookie settings

Strictly necessary cookies

Performance cookies

Functional cookies

Targeting cookies