kopia lustrzana https://github.com/jupyterhub/repo2docker
130 wiersze
3.9 KiB
ReStructuredText
130 wiersze
3.9 KiB
ReStructuredText
.. _user_interface:
|
|
|
|
============================
|
|
Configure the user interface
|
|
============================
|
|
|
|
You can build several user interfaces into the resulting Docker image.
|
|
This is controlled with various :ref:`configuration files <config-files>`.
|
|
|
|
|
|
JupyterLab
|
|
==========
|
|
|
|
You do not need any extra configuration in order to allow the use
|
|
of the JupyterLab interface. You can launch JupyterLab from within a user
|
|
session by opening the Jupyter Notebook and appending ``/lab`` to the end of the URL
|
|
like so:
|
|
|
|
.. code-block:: none
|
|
|
|
http(s)://<server:port>/lab
|
|
|
|
To switch back to the classic notebook, add ``/tree`` to the URL like so:
|
|
|
|
.. code-block:: none
|
|
|
|
http(s)://<server:port>/tree
|
|
|
|
For example, the following Binder URL will open the
|
|
`pyTudes repository <https://github.com/norvig/pytudes>`_
|
|
and begin a JupyterLab session in the ``ipynb`` folder:
|
|
|
|
https://mybinder.org/v2/gh/norvig/pytudes/master?urlpath=lab/tree/ipynb
|
|
|
|
The ``/tree/ipynb`` above is how JupyterLab directs you to a specific file
|
|
or folder.
|
|
|
|
To learn more about URLs in JupyterLab and Jupyter Notebook, visit
|
|
`starting JupyterLab <http://jupyterlab.readthedocs.io/en/latest/getting_started/starting.html>`_.
|
|
|
|
|
|
nteract
|
|
=======
|
|
|
|
`nteract is a notebook interface <https://nteract.io/>`_ built with React.
|
|
It is similar to a more feature-filled version of the traditional
|
|
Jupyter Notebook interface.
|
|
|
|
nteract comes pre-installed in any session that has been built from
|
|
a Python repository.
|
|
|
|
You can launch nteract from within a user
|
|
session by replacing ``/tree`` with ``/nteract`` at the end of a notebook
|
|
server's URL like so:
|
|
|
|
.. code-block:: none
|
|
|
|
http(s)://<server:port>/nteract
|
|
|
|
For example, the following Binder URL will open the
|
|
`pyTudes repository <https://github.com/norvig/pytudes>`_
|
|
and begin an nteract session in the ``ipynb`` folder:
|
|
|
|
https://mybinder.org/v2/gh/norvig/pytudes/master?urlpath=nteract/tree/ipynb
|
|
|
|
The ``/tree/ipynb`` above is how nteract directs you to a specific file
|
|
or folder.
|
|
|
|
To learn more about nteract, visit `the nteract website <https://nteract.io/about>`_.
|
|
|
|
|
|
RStudio
|
|
=======
|
|
|
|
The RStudio user interface is automatically enabled if a configuration file for
|
|
R is detected (i.e. an R version specified in ``runtime.txt``). If this is detected,
|
|
RStudio will be accessible by appending ``/rstudio`` to the URL, like so:
|
|
|
|
.. code-block:: none
|
|
|
|
http(s)://<server:port>/rstudio
|
|
|
|
For example, the following Binder link will open an RStudio session in
|
|
the `R demo repository <https://github.com/binder-examples/r>`_.
|
|
|
|
http://mybinder.org/v2/gh/binder-examples/r/master?urlpath=rstudio
|
|
|
|
|
|
Shiny
|
|
=====
|
|
|
|
`Shiny lets you create interactive visualizaions with R <https://shiny.rstudio.com/>`_.
|
|
Shiny is automatically enabled if a configuration file for
|
|
R is detected (i.e. an R version specified in ``runtime.txt``). If
|
|
this is detected, Shiny will be accessible by appending
|
|
``/shiny/<folder-w-shiny-files>`` to the URL, like so:
|
|
|
|
.. code-block:: none
|
|
|
|
http(s)://<server:port>/shiny/bus-dashboard
|
|
|
|
This assumes that a folder called ``bus-dashboard`` exists in the root
|
|
of the repository, and that it contains all of the files needed to run
|
|
a Shiny app.
|
|
|
|
For example, the following Binder link will open a Shiny session in
|
|
the `R demo repository <https://github.com/binder-examples/r>`_.
|
|
|
|
http://mybinder.org/v2/gh/binder-examples/r/master?urlpath=shiny/bus-dashboard/
|
|
|
|
|
|
Stencila
|
|
========
|
|
|
|
The Stencila user interface is automatically enabled if a Stencila document (i.e.
|
|
a file ``manifest.xml``) is detected. Stencila will be accessible by appending
|
|
``/stencila`` to the URL, like so:
|
|
|
|
.. code-block:: none
|
|
|
|
http(s)://<server:port>/stencila
|
|
|
|
The editor will open the Stencila document corresponding to the last ``manifest.xml``
|
|
found in the file tree. If you want to open a different document, you can configure
|
|
the path in the URL parameter ``archive``:
|
|
|
|
.. code-block:: none
|
|
|
|
http(s)://<server:port>/stencila/?archive=other-dir
|