Table of contents
How to SSH to the machine
Looking at logs
Why is my environment not building?
Running the environments on my local machine
My extension and / or dependency does not seem to be installed
The name of the environment is not displayed in the top bar
The environment is very slow to build
Finding the source for an environment
Removing an environment returns an error
First make sure your SSH key has been deployed to the server. See Adding the public SSH key to the server for more details.
Once the key is set up, connect to the machine over SSH using the following command:
ssh ubuntu@51.178.95.143
See: The Littlest JupyterHub documentation.
If for some reasons an environment does not appear after Adding a new environment, it is possible that there are some issues building it and installing the dependencies.
We recommend building the environment either locally with repo2docker (next section) or on Binder.
repo2docker
See Testing on Binder and the repo2docker FAQ for more details.
To run the same environments on a local machine, you can use jupyter-repo2docker with the following parameters:
jupyter-repo2docker
jupyter-repo2docker --ref a4edf334c6b4b16be3a184d0d6e8196137ee1b06 https://github.com/plasmabio/template-python
Update the parameters based on the image you would like to build.
This will create a Docker image and start it automatically once the build is complete.
Refer to the repo2docker documentation for more details.
See the two previous sections to investigate why they are missing.
The logs might contain silent errors that did not cause the build to fail.
This functionality requires the jupyter-topbar-text extension to be installed in the environment.
jupyter-topbar-text
This extension must be added to the postBuild file of the repository. See this commit as an example.
postBuild
The name of the environment will then be displayed as follows:
Since the environments are built as Docker images, they can leverage the Docker cache to make the builds faster.
In some cases Docker will not be able to leverage the cache, for example when building a Python or R environment for the first time.
Another reason for the build to be slow could be the amount of dependencies specified in files such as environment.yml or requirements.txt.
environment.yml
requirements.txt
Check out the previous section for more info on how to troubleshoot it.
If you are managing the environments, you can click on the Reference link in the UI, which will open a new tab to the repository pointing the commit hash:
Reference
If you are using the environments, the name contains the information about the repository and the reference used to build the environment.
On the repository page, enter the reference in the search input box:
See Removing an environment returns an error for more info.