search

jupyterhub / jupyter-server-proxy

Jupyter notebook server extension to proxy web services.
https://jupyter-server-proxy.readthedocs.io
BSD 3-Clause "New" or "Revised" License
354 stars 147 forks source link

Adding a complete example to clarify where to put the config files. #486

Open dragz opened 5 months ago

dragz commented 5 months ago

A small addition to the examples. I wasted a few hours trying to figure out where to put the config files. It might save some time for others.

manics commented 4 months ago

Thanks, I think having a full example makes sense. What do you think about linking to our test config instead: https://github.com/jupyterhub/jupyter-server-proxy/blob/main/tests/resources/jupyter_server_config.py

The advantage of that is it's always tested so will never go out of date, and also includes full examples for all config options.

dragz commented 4 months ago

That makes perfect sense. I can change my PR or if you want to do it yourself you can just ignore my PR. What do you prefer?

dragz commented 4 months ago

I tried copying the mentioned jupyter_server_config.py but it does not work out of the box. First it fails to launch the singleuserserver because it cannot find proxyextension. Commenting those two lines out make the server start but all test examples that shows up gives 500 internal error. All this will confuse a user trying to set this up.

manics commented 4 months ago

That's a fair point! Can you change your example so that it'll work on all systems? At the moment it'll only work with anaconda. For example, import and use sys.executable