From 0a845a416346fd34fae177e1fcb66028913fb90e Mon Sep 17 00:00:00 2001 From: Shrey Date: Tue, 20 Apr 2021 20:42:09 +0530 Subject: [PATCH] Update Readme I was reading the doc and saw some 404 for links, adding a quick fix :) --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 394f32a..7980f9d 100644 --- a/README.md +++ b/README.md @@ -64,16 +64,16 @@ How does this Example Work This repository contains two key files: -* [jupyterhub_config.py](./jupyterhub_config.py) -* [requirements.txt](./requirements.txt) +* [jupyterhub_config.py](./.jupyter/jupyterhub_config.py) +* [Pipfile](./Pipfile) The ``jupyterhub_config.py`` file extends the JupyterHub configuration to enable use of the OpenShift authenticator. This relies on the template having added necessary annotations to the service account created to permit use of the service account as an OAuth provider. The code in the ``jupyerhub_config.py`` file will then automatically configure JupyterHub with the necessary OAuth client ID, secret, and public callback URL, by querying the OpenShift environment for the details. There is no need for any manual configuration. -The ``requirements.txt`` file lists additional Python packages that are required by the code in ``jupyterhub_config.py``. +The ``Pipfile`` file lists additional Python packages that are required by the code in ``jupyterhub_config.py``. -When the application is created from the template, a build will be setup that runs the ``jupyterhub`` image as an S2I builder on the code from this repository. The result of that will be that the additional Python packages listed in the ``requirements.txt`` file will be installed into the image and the ``jupyterhub_config.py`` copied into an appropriate location. +When the application is created from the template, a build will be setup that runs the ``jupyterhub`` image as an S2I builder on the code from this repository. The result of that will be that the additional Python packages listed in the ``Pipfile`` file will be installed into the image and the ``jupyterhub_config.py`` copied into an appropriate location. The customised JupyterHub image generated by the S2I build will then be what is deployed. It will run JupyterHub and the ``jupyterhub_config.py`` from this repository will be merged with the default configuration and any further configuration you might supply via the ``JUPYTERHUB_CONFIG`` template parameter.