kopia lustrzana https://github.com/jupyterhub/repo2docker
84 wiersze
2.7 KiB
ReStructuredText
84 wiersze
2.7 KiB
ReStructuredText
.. _install:
|
|
|
|
Installing ``repo2docker``
|
|
==========================
|
|
|
|
repo2docker requires Python 3.4 and above on Linux and macOS. See
|
|
:ref:`below <windows>` for more information about Windows support.
|
|
|
|
Prerequisite: docker
|
|
--------------------
|
|
|
|
Install `Docker <https://www.docker.com>`_ as it is required
|
|
to build Docker images. The
|
|
`Community Edition <https://www.docker.com/community-edition>`_,
|
|
is available for free.
|
|
|
|
Recent versions of Docker are recommended.
|
|
The latest version of Docker, ``18.03``, successfully builds repositories from
|
|
`binder-examples <https://github.com/binder-examples>`_.
|
|
The `BinderHub <https://binderhub.readthedocs.io/>`_ helm chart uses version
|
|
``17.11.0-ce-dind``. See the
|
|
`helm chart <https://github.com/jupyterhub/binderhub/blob/master/helm-chart/binderhub/values.yaml#L167>`_
|
|
for more details.
|
|
|
|
Installing with ``pip``
|
|
-----------------------
|
|
|
|
We recommend installing ``repo2docker`` with the ``pip`` tool::
|
|
|
|
python3 -m pip install jupyter-repo2docker
|
|
|
|
For information on using ``repo2docker``, see :ref:`usage`.
|
|
|
|
Installing from source code
|
|
---------------------------
|
|
|
|
Alternatively, you can install repo2docker from source,
|
|
i.e. if you are contributing back to this project::
|
|
|
|
git clone https://github.com/jupyter/repo2docker.git
|
|
cd repo2docker
|
|
pip install -e .
|
|
|
|
That's it! For information on using ``repo2docker``, see
|
|
:ref:`usage`.
|
|
|
|
.. _windows:
|
|
|
|
Windows support
|
|
---------------
|
|
|
|
Windows support for ``repo2docker`` is still in the experimental stage.
|
|
|
|
An article about `using Windows and the WSL`_ (Windows Subsytem for Linux or
|
|
Bash on Windows) provides additional information about Windows and docker.
|
|
|
|
|
|
.. _using Windows and the WSL: https://nickjanetakis.com/blog/setting-up-docker-for-windows-and-wsl-to-work-flawlessly
|
|
|
|
.. _jupyterhub_ready:
|
|
|
|
JupyterHub-ready images
|
|
-----------------------
|
|
|
|
JupyterHub_ allows multiple
|
|
users to collaborate on a shared Jupyter server. ``repo2docker`` can build
|
|
Docker images that can be shared within a JupyterHub deployment. For example,
|
|
`mybinder.org <https://mybinder.org>`_ uses JupyterHub and ``repo2docker``
|
|
to allow anyone to build a Docker image of a git repository online and
|
|
share an executable version of the repository with a URL to the built image.
|
|
|
|
To build JupyterHub_-ready Docker images with ``repo2docker``, the
|
|
version of your JupterHub deployment must be included in the
|
|
``environment.yml`` or ``requirements.txt`` of the git repositories you
|
|
build.
|
|
|
|
If your instance of JupyterHub uses ``DockerSpawner``, you will need to set its
|
|
command to run ``jupyterhub-singleuser`` by adding this line in your
|
|
configuration file::
|
|
|
|
c.DockerSpawner.cmd = ['jupyterhub-singleuser']
|
|
|
|
.. _JupyterHub: https://github.com/jupyterhub/jupyterhub
|