binderhub
Run your code in the cloud, with technology so advanced, it feels like magic!
File Explorer
Download Latest Version (.zip)- diff.yml
- eslint.yml
- jest.yml
- playwright.yaml
- publish.yml
- test-docker-build.yaml
- test.yml
- watch-dependencies.yaml
- dependabot.yaml
- ISSUE_TEMPLATE.md
- launch.json
- __init__.py
- repoproviders.py
- badge.svg
- badge_logo.svg
- logo_social.png
- logo_square.png
- markdown-icon.svg
- rst-icon.svg
- AboutPage.jsx
- HomePage.jsx
- HomePage.test.jsx
- LoadingPage.jsx
- NotFoundPage.jsx
- App.jsx
- App.test.jsx
- index.d.ts
- index.jsx
- index.scss
- favicon.ico
- logo.svg
- robots.txt
- page.html
- __init__.py
- conftest.py
- http-record.api.figshare.com.json
- http-record.api.github.com.gists.json
- http-record.api.github.com.json
- http-record.data.depositar.io.json
- http-record.dataverse.harvard.edu.json
- http-record.demo.ckan.org.json
- http-record.doi.org.json
- http-record.gitlab.com.json
- http-record.nbviewer.jupyter.org.json
- http-record.www.hydroshare.org.json
- http-record.zenodo.org.json
- test_app.py
- test_auth.py
- test_bots.py
- test_build.py
- test_builder.py
- test_eventlog.py
- test_health.py
- test_launcher.py
- test_legacy.py
- test_main.py
- test_quota.py
- test_ratelimit.py
- test_registry.py
- test_repoproviders.py
- test_utils.py
- test_version.py
- utils.py
- __init__.py
- __main__.py
- _version.py
- app.py
- base.py
- binderspawner_mixin.py
- build.py
- build_local.py
- builder.py
- config.py
- events.py
- health.py
- launcher.py
- log.py
- main.py
- metrics.py
- quota.py
- ratelimit.py
- registry.py
- repoproviders.py
- utils.py
- check_embedded_chart_code.py
- common
- publish
- refreeze
- architecture.png
- favicon.png
- logo.png
- custom.css
- navigation.html
- index.rst
- index.rst
- repoproviders.rst
- app.rst
- build.rst
- builder.rst
- launcher.rst
- main.rst
- ref-index.rst
- registry.rst
- repoproviders.rst
- generate_id_details.png
- new_project.png
- index.rst
- private-gitlab-repo-token.png
- private-repo-token.png
- setup-binderhub.rst
- setup-prerequisites.rst
- setup-registry.rst
- turn-off.rst
- api.rst
- authentication.rst
- conf.py
- contribute.md
- cors.rst
- customizing.rst
- debug.rst
- eventlogging.rst
- https.rst
- index.rst
- overview.rst
- make.bat
- Makefile
- requirements.txt
- custom.js
- login.html
- page.html
- binderhub_config.py
- extra_notebook_config.py
- README.md
- run-appendix
- binder-api.py
- binderhub_config.py
- daemonset.yaml
- _helpers.tpl
- deployment.yaml
- httproute.yaml
- image-cleaner.yaml
- ingress.yaml
- NOTES.txt
- pdb.yaml
- rbac.yaml
- secret.yaml
- service.yaml
- .helmignore
- Chart.yaml
- schema.yaml
- values.yaml
- Dockerfile
- README.md
- requirements.in
- requirements.txt
- .gitignore
- chartpress.yaml
- LICENSE
- README.md
- conftest.py
- test_ui.py
- client.js
- spec.js
- fullbuild.eventsource
- index.test.js
- utils.js
- package.json
- README.md
- fail.ico
- progress.ico
- success.ico
- BuilderLauncher.jsx
- ErrorPage.jsx
- FaviconUpdater.jsx
- HowItWorks.jsx
- LinkGenerator.jsx
- LinkGenerator.test.jsx
- LoadingIndicator.css
- LoadingIndicator.jsx
- NBViewerIFrame.jsx
- Progress.jsx
- babel.config.js
- package.json
- README.md
- binderhub-chart+dind.yaml
- binderhub-chart+pink.yaml
- binderhub-chart-config-old.yaml
- binderhub-chart-config.yaml
- cm-insecure-registries-dind.yaml
- cm-insecure-registries-pink.yaml
- cm-insecure-registries-upgrade.yaml
- binderhub_config.py
- binderhub_config_auth_additions.py
- install-jupyterhub-chart
- jupyterhub-chart-config-auth-additions.yaml
- jupyterhub-chart-config.yaml
- binderhub_config.py
- jupyterhub_config.py
- README.md
- requirements.txt
- binderhub_config.py
- lint-and-validate-values.yaml
- generate-json-schema.py
- validate-against-schema.py
- .dockerignore
- .eslintrc.js
- .flake8
- .git-blame-ignore-revs
- .gitattributes
- .gitignore
- .hintrc
- .pre-commit-config.yaml
- .prettierignore
- .readthedocs.yaml
- babel.config.json
- CHANGES.md
- conftest.py
- CONTRIBUTING.md
- dev-requirements.txt
- LICENSE
- MANIFEST.in
- package.json
- pyproject.toml
- README.md
- requirements.txt
- setup.cfg
- setup.py
- setupTests.js
- tsconfig.json
- versioneer.py
- webpack.config.js
# Installation Guide
1. Get the code
git clone https://github.com/jupyterhub/binderhub
Downloads the entire project code from GitHub to your computer.
cd binderhub
Moves into the project folder you just downloaded.
2. Official Install Script
Easy RecommendedPrerequisites
- Python 3 Python is required to use pip.
pip install git+https://github.com/jupyterhub/binderhub
Installs the package published on PyPI directly β no need to clone the source.
After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.
Pulled directly from this repo's README.
3. Docker
EasyPrerequisites
- Git Needed to download the project code from GitHub.
- Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
β οΈ This is a large repository, so this method may point to an internal sub-package rather than the actual core product. Check the full README as well.
docker build -f helm-chart/images/binderhub/Dockerfile -t binderhub .
Builds a runnable image based on the Dockerfile.
docker run -p 8080:80 binderhub
Runs the built image as an actual container.
Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.
4. Node.js
EasyPrerequisites
cd js/packages/binderhub-client
This project's files live in a subfolder, so move into it first.
npm install
Downloads and installs the libraries listed in package.json.
npm start
Starts the development/run server.
After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.
5. Python
EasyPrerequisites
pip install git+https://github.com/jupyterhub/binderhub
Installs the package published on PyPI directly β no need to clone the source.
If it runs without errors and prints output in the terminal, it worked.
Pulled directly from this repo's README.
// repository documentation
Was this content helpful?
(0 ratings)