Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Doc: Tunneling Jupyter #3841

Merged
merged 4 commits into from
Apr 17, 2023
Merged

Conversation

ax3l
Copy link
Member

@ax3l ax3l commented Apr 14, 2023

Document how to tunnel Jupyter servers.

Image used in docs:
Untitled

@ax3l ax3l added the component: documentation Docs, readme and manual label Apr 14, 2023
@ax3l ax3l force-pushed the doc-tunneling-jupyter branch 2 times, most recently from 99a4a54 to 58030e2 Compare April 14, 2023 17:56
Document how to tunnel Jupyter servers.
@tanweihou
Copy link

Hi @ax3l , in line 36 of Docs/source/dataanalysis/workflows/tunneling.rst , would it be better if we add the following?

"you start Jupyter locally in headless mode, jupyter notebook --no-browser"

Then, jupyter will not try to open a browser inside a ssh terminal.

Thanks.

@ax3l
Copy link
Member Author

ax3l commented Apr 14, 2023

That's a great point, thank you for the suggestion!


* this step must be done **after** Jupyter was started on the desktop
* ``ssh -L <laptop-port>:<Ip-as-seen-on-desktop>:<desktop-port> <desktop-ip> -N``
* so concrete: ``ssh -L 8888:localhost:8888 your-computers-hostname.dhcp.lbl.gov -N``
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If being concrete anyway, maybe it would be helpful to explicitly show different ports on laptop and desktop, something like
jupyter lab --no-browser --port 8890,
then
ssh -L 8888:localhost:8890 your-computers-hostname.dhcp.lbl.gov -N
if that works

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hm, I think that makes it more complicated right now.

We should name the ports if we want to show this, imho, e.g., with quoting a bit more of a script here? Let's do this as a follow-up?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That makes sense, ok with me

@RemiLehe RemiLehe merged commit 71566b7 into ECP-WarpX:development Apr 17, 2023
@ax3l ax3l deleted the doc-tunneling-jupyter branch April 17, 2023 20:34
lucafedeli88 pushed a commit to lucafedeli88/WarpX that referenced this pull request Apr 21, 2023
* Doc: Tunneling Jupyter

Document how to tunnel Jupyter servers.

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Add explicit headless command to workflow

* Fix quotes

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component: documentation Docs, readme and manual
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants