Skip to content

Commit 8f61963

Browse files
committed
docs: add note about SSH forwarding in v4
1 parent de21d9a commit 8f61963

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

docs/intro.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,14 @@ CryoSPARC installation must be accessible via one of the following methods:
3333
- Running on a machine on the same network with `BASE_PORT` open for connections
3434
- Running at some publicly accessible web URL, e.g., `https://cryosparc.example.com`
3535

36+
```{note}
37+
CryoSPARC Tools versions prior to v5 require that CryoSPARC instances accessed over SSH have multiple ports forwarded (`BASE_PORT + 2`, `BASE_PORT + 3`, `BASE_PORT + 5`).
38+
39+
As of v5, only the `BASE_PORT`, e.g., 39000, needs to be forwarded.
40+
41+
See [SSH Port Forwarding documentation](https://guide.cryosparc.com/setup-configuration-and-management/how-to-download-install-and-configure/accessing-cryosparc#ssh-local-port-forwarding) for more information.
42+
```
43+
3644
cryosparc-tools is only available for CryoSPARC v4.1 or newer. If using CryoSPARC v4.0 or older, please see the [Manipulating .cs Files Created By CryoSPARC](https://guide.cryosparc.com/setup-configuration-and-management/software-system-guides/manipulating-.cs-files-created-by-cryosparc) guide.
3745

3846
### Python Environment
@@ -184,6 +192,7 @@ jupyter notebook --no-browser --ip=0.0.0.0 --port=8888
184192
```
185193

186194
(running-the-examples)=
195+
187196
### Running the Examples
188197

189198
The example Jupyter notebooks require additional dependencies to run. Use [conda](https://docs.conda.io/en/latest/) or [mamba](https://mamba.readthedocs.io/en/latest/) to create a new Python environment with the required dependencies. Here, the environment is named `cryosparc-tools-example` but any name may be used:

0 commit comments

Comments
 (0)