From 10b9d372370360cbb65d9668c73a869bea6b0e9d Mon Sep 17 00:00:00 2001 From: David Pratten Date: Mon, 11 Sep 2023 20:10:40 +1000 Subject: [PATCH] Update run instructions --- docs/run_notebooks.md | 56 ++----------------------------------------- 1 file changed, 2 insertions(+), 54 deletions(-) diff --git a/docs/run_notebooks.md b/docs/run_notebooks.md index 3c94718..f6fd214 100644 --- a/docs/run_notebooks.md +++ b/docs/run_notebooks.md @@ -1,5 +1,5 @@ -# How to run the example notebooks -Here is a step by step guide to running and/or edit and re-running the example [Jupyter](https://jupyter.org/) notebooks. This will work where ever docker containers are supported. Here are detailed instructions for two options. On your own computer and on https://fly.io +# How to edit and re-run the example notebooks +Here is a step by step guide to running and/or edit and re-running the example [Jupyter](https://jupyter.org/) notebooks. This will work where ever docker containers are supported. ## On Docker on your computer - Install Docker on your computer. https://docs.docker.com/get-docker/ @@ -17,55 +17,3 @@ docker run -p 8888:8888 ghcr.io/davidpratten/jetisu:latest ![img.png](jetisu_jupyter_lab.png) -## On fly.io - -__SECURITY NOTE__: _after deploying the notebooks to the internet be sure to keep the access token secret. See [Security in Jupyter Notebooks](https://jupyter-server.readthedocs.io/en/latest/operators/security.html#security-in-notebook-documents) for more information._ - -Follow steps 1 to 3 here https://fly.io/docs/hands-on/ - -![Hands-on with Flyl.io](handsonwithflyio.png) - -When you get to step 4. substitute the following steps to launch the Jetisu Toolkit notebooks. - -4a. Create a directory on your computer and make it your current directory in your terminal. - -4b. Issue the following command to launch the Jetisu Toolkit from the GitHub container repository - -``` -flyctl launch --image ghcr.io/davidpratten/jetisu:latest --now --generate-name --region lax --dockerignore-from-gitignore --internal-port 8888 -``` -fly.io will allocate a unique name for your app and you will see a ```Logs:``` monitoring URL on screen. - -![results of fly.io launch.png](results%20of%20fly.io%20launch.png) - -4c. Copy and paste your monitoring URL into your browser. - -If the launch and deploy were successful, at the bottom of the log you will see the access token allocated to your instance of the Jetisu Toolkit Notebooks. - -![access token.png](access%20token.png) - -4d. Copy the access token - -4e. Click the Overview link on the top right of the page. - -![overview button.png](overview%20button.png) - -4f. Click the hostname link to go to the notebooks on the web - -![click on the host name.png](click%20on%20the%20host%20name.png) - -4g. Paste in the access token that you copied at step 4d. above. - -![enter the access token.png](enter%20the%20access%20token.png) - -4h. Congratulations! The notebooks are running on the internet and you can edit and run them. - -![img.png](jetisu_jupyter_lab.png) - -After successful deployment you can set the access token to a string of your own choosing by issuing the following command, providing a [UUID](https://www.uuidgenerator.net/) of your own. After this command is issued, your notebook's server will reboot and start using your token. - -``` -flyctl secrets set JUPYTER_TOKEN= -``` -### Remove the app from fly.io -To remove the app once you are finished with it, use the ```Settings``` link on the dashboard for your app. \ No newline at end of file