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

docs v2: Remote Jupyter Notebook section #99

Open
manzt opened this issue Feb 21, 2023 · 2 comments
Open

docs v2: Remote Jupyter Notebook section #99

manzt opened this issue Feb 21, 2023 · 2 comments

Comments

@manzt
Copy link
Member

manzt commented Feb 21, 2023

From prior docs:

Remote Jupyter Notebook
--------------------------

If your Jupyter notebook is running on a remote server (at e.g. `REMOTE_IP`), you’ll need to make sure that you have an extra port (let’s call it ``HG_PORT) open on your firewall that HiGlass can use to communicate with its server. That port will then need to be passed to the server display command:

.. code-block:: python
		higlass.display(
		    ...,
		    server_port=HG_PORT,
		    host=REMOTE_IP,
		    fuse=False
		)


The `fuse=False` option is often necessary if there is no support for `FUSE`. `FUSE` is only necessary for loading remote http datasets which are not hosted on a HiGlass server.
@manzt
Copy link
Member Author

manzt commented Feb 21, 2023

I'm compiling a list of TODOs for the new documentation. The hg API should support most of these features, but I think that something like the FUSE API should be documented in it's own section.

@nvictus
Copy link
Member

nvictus commented Jul 19, 2023

TODO: document the enable_proxy feature.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants