{"id":19578581,"url":"https://github.com/materialsproject/mp-jupyterhub","last_synced_at":"2026-01-27T11:02:10.630Z","repository":{"id":151270947,"uuid":"72375797","full_name":"materialsproject/mp-jupyterhub","owner":"materialsproject","description":"Jupyterhub for spinning up materials project notebook environments","archived":false,"fork":false,"pushed_at":"2016-11-02T18:37:04.000Z","size":9,"stargazers_count":2,"open_issues_count":0,"forks_count":3,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-04-22T23:46:17.538Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-2-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/materialsproject.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2016-10-30T21:11:53.000Z","updated_at":"2020-03-21T02:13:53.000Z","dependencies_parsed_at":"2023-04-18T04:47:20.305Z","dependency_job_id":null,"html_url":"https://github.com/materialsproject/mp-jupyterhub","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/materialsproject/mp-jupyterhub","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/materialsproject%2Fmp-jupyterhub","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/materialsproject%2Fmp-jupyterhub/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/materialsproject%2Fmp-jupyterhub/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/materialsproject%2Fmp-jupyterhub/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/materialsproject","download_url":"https://codeload.github.com/materialsproject/mp-jupyterhub/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/materialsproject%2Fmp-jupyterhub/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28812367,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-27T07:41:26.337Z","status":"ssl_error","status_checked_at":"2026-01-27T07:41:08.776Z","response_time":168,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-11T07:12:02.739Z","updated_at":"2026-01-27T11:02:10.597Z","avatar_url":"https://github.com/materialsproject.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"Jupyterhub Setup For Materials Project Docker Image\n===================================================\n\nThis service will allow you to spin up a multiuser Jupyter notebook environment with the materialsproject Docker image.\nIt uses Github OAuth to authenticate users.\n\n\n### Prerequisistes\n- Python 3\n- Docker\n- Node.js\n- A Github Account\n\n\nJupyterhub requires Python 3. Either install your OS specific [Python 3](https://www.python.org/downloads/) or download the [Anaconda distribution](https://www.continuum.io/downloads).\n\nYou can get node.js from https://nodejs.org/en/\n\n\nFirst get the Docker image: \n```\ndocker pull materialsproject/jupyterhub-singleuser\n```\n\n### Install and Setup\n\n1. Install the requirements\n   ```\n   npm install -g configurable-http-proxy\n   pip3 install -r requirements.txt\n   ```\n   This will install jupyter, jupyterhub, dockerspawner and oauthenticator\n\n\n2. Setup your OAuth tokens in Github via https://github.com/settings/developers\n   - Select \"Register a New Application\"\n   - Make sure you fill out the callback URL as https://\u003cyourdomain.org\u003e/hub/oauth_callback (use http is you don't have SSL enabled)\n   - Once registered note the Client ID and Client Secret\n\n3. Edit `run/env.sh` and enter `GITHUB_CLIENT_SECRET`, `GITHUB_CLIENT_ID` and `OAUTH_CALLBACK_URL` from above\n\n4. Edit the Jupyterhub config `run/jupyterhub_config.py` as needed. You may need to adjust values for if you wish to run with SSL:\n   ```python\n\n   c.JupyterHub.port = 443\n\n   c.JupyterHub.ssl_cert = '/path/to/cert'\n   c.JupyterHub.ssl_key = '/path/to/key'\n   ```\n   You may also adjust values for the shared directory from `/tmp` to your shared volume:\n   ```python\n   c.DockerSpawner.volumes = {\n       '/tmp': '/wkshp_shared'\n   }\n   ```\n\n5. Add initial users to `run/userlist`\n\n### Run\n\nIf you have set appropriate SSL certs above you can leave off the `--no-ssl` below:\n```\ncd run\n./run.sh --no-ssl\n```\n\n\n\n\n\n\n\n\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmaterialsproject%2Fmp-jupyterhub","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmaterialsproject%2Fmp-jupyterhub","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmaterialsproject%2Fmp-jupyterhub/lists"}