Customizing your BinderHub deployment#
Important
In this section, we assume that you are deploying BinderHub to Kubernetes using Helm as documented in Zero to BinderHub.
Frontend#
BinderHub’s frontend is built using React.
We prepared the key parts of the BinderHub’s frontend as re-usable components available as @jupyterhub/binderhub-react-components on NPM.
Some customization might require changes in the re-usable components or the way the are connected.
About page customization#
BinderHub’s frontend is configured with simple about page at https://BINDERHOST/about. By default this shows the version of BinderHub you are running. You can add additional HTML to the page by setting the about_message configuration option to the raw HTML you would like to add. You can use this to display contact information or other details about your deployment.
Example#
The about page was configured at https://mybinder.org/about using about_message:
about_message: |
<p>mybinder.org is public infrastructure operated by the <a href="https://jupyterhub-team-compass.readthedocs.io/en/latest/team.html#binder-team">Binder Project team</a>.<br /><br />
The Binder Project is a member of <a href="https://jupyter.org">Project Jupyter</a>.
Donations are managed by <a href="https://lf-charities.org">LF Charities</a>, a US 501c3 non-profit.<br /><br />
For abuse please email: <a href="mailto:binder-team@googlegroups.com">binder-team@googlegroups.com</a>, to report a
security vulnerability please see: <a href="https://mybinder.readthedocs.io/en/latest/faq.html#where-can-i-report-a-security-issue">Where can I report a security issue</a><br /><br />
For more information about the Binder Project, see <a href="https://mybinder.readthedocs.io/en/latest/about.html">the About Binder page</a></p>
window.pageConfig#
Warning
This should be used only when providing a BinderHub frontend without the BinderHub backend.
Some customization is exposed using the window.pageConfig JavaScript variable, including
aboutMessagebadgeBaseUrlbannerHtmlbaseUrllogoUrllogoWidthrepoProviders
Change the value of the above keys will change how the BinderHub’s frontend works.
Extra JavaScript#
BinderHUb tries to be neutral regarding web analytics. You should be able to configure any web analytics tools using extra_header_html and extra_footer_scripts.
Example#
Plausible was configured at https://mybinder.org using extra_header_html:
extra_header_html:
01-plausible: |
<script defer data-domain="mybinder.org" src="https://plausible.io/js/script.file-downloads.outbound-links.js"></script>
<script>window.plausible = window.plausible || function() { (window.plausible.q = window.plausible.q || []).push(arguments) }</script>
JupyterHub customization#
Because BinderHub uses JupyterHub to manage all user sessions, you can customize many aspects of the resources available to the user. This is primarily done by modifications to your BinderHub’s Helm chart (config.yaml).
To make edits to your JupyterHub deplyoment via config.yaml, use the following pattern:
binderhub:
jupyterhub: <JUPYTERHUB-CONFIG-YAML>
For example, see this section of the mybinder.org Helm Chart.
For information on how to configure your JupyterHub deployment, see the JupyterHub for Kubernetes Customization Guide.
If you want to customise the spawner you can subclass it in extraConfig. For example:
binderhub:
jupyterhub:
hub:
extraConfig:
10-binder-customisations: |
class MyCustomBinderSpawner(BinderSpawner):
...
c.JupyterHub.spawner_class = MyCustomBinderSpawner
BinderHub uses the jupyterhub.hub.extraConfig setting to customise JupyterHub. For example, BinderSpawner is defined under the 00-binder key. Keys are evaluated in alphanumeric order, so later keys such as 10-binder-customisations can use objects defined in earlier keys.
Custom configuration for specific repositories#
Sometimes you would like to provide a repository-specific configuration. For example, if you’d like certain repositories to have higher pod quotas than others, or if you’d like to provide certain resources to a subset of repositories.
To override the configuration for a specific repository, you can provide a list of dictionaries that allow you to provide a pattern to match against each repository’s specification, and override configuration values for any repositories that match this pattern.
Note
If you provide multiple patterns that match a single repository in your spec-specific configuration, then later values in the list will override earlier values.
To define this list of patterns and configuration overrides, use the following pattern in your Helm Chart (here we show an example using GitHubRepoProvider, but this works for other RepoProviders as well):
config:
GitHubRepoProvider:
spec_config:
- pattern: ^ines/spacy-binder.*:
config:
key1: value1
- pattern: pattern2
config:
key1: othervalue1
key2: othervalue2
For example, the following specification configuration will assign a pod quota of 999 to the spacy-binder repository, and a pod quota of 1337 to any repository in the JupyterHub organization.
config:
GitHubRepoProvider:
spec_config:
- pattern: ^ines/spacy-binder.*:
config:
quota: 999
- pattern: ^jupyterhub.*
config:
quota: 1337
Banning specific repositories#
You may want to exclude certain repositories from your BinderHub instance. You can do this by providing a list of banned_spec patterns. BinderHub will not accept URLs matching any of the banned patterns.
For example, the following configuration will prevent notebooks in the spacy-binder repository and the ml-training repository from launching.
config:
GitHubRepoProvider:
# Add banned repositories to the list below
# They should be strings that will match "^<org-name>/<repo-name>.*"
banned_specs:
- ^ines/spacy-binder.*
- ^aschen/ml-training.*
You can also use a negative lookahead. For example, the following configuration will prevent all notebooks except those in repositories in the myorg organization from launching.
config:
GitHubRepoProvider:
banned_specs:
- ^(?!myorg\/.*).*$