Skip to content

docs: more prescriptive remote connection docs #6871

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Oct 22, 2025
Merged

docs: more prescriptive remote connection docs #6871

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 15 additions & 3 deletions docs/faq.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -434,18 +434,30 @@ You can use any Python package. marimo cells run arbitrary Python code.

Use SSH port-forwarding to run marimo on a remote server
and connect to it from a browser on your local machine. Make sure
to pass the `--headless` flag when starting marimo on remote:
to pass the `--headless` flag when starting marimo on remote; on the remote
machine, we also recommend using a port other than marimo's default port, such
as 8080:

_On the remote machine, run:_

```bash
marimo edit --headless
marimo edit --headless --port 8080
```

You may also want to set a custom host and port:
or, if you want to set a custom host:

```bash
marimo edit --headless --host 0.0.0.0 --port 8080
```

_On local, run:_

```
ssh -N -L 3718:127.0.0.1:8080 REMOTE_USER@REMOTE_HOST
```

Then open `localhost:3718` in your browser.
Copy link
Collaborator

Choose a reason for hiding this comment

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

I think we do an offset for LSP and other internal servers (starting from 400): marimo/_server/start.py

Not an issue, just a note, and double checked because I thought it might be 1000

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Nice note, thanks for the context


<a name="faq-interfaces"></a>

### How do I make marimo accessible on all network interfaces?
Expand Down