From 7c20bb9c3bc15b193db2aab0130019d01d3a92b8 Mon Sep 17 00:00:00 2001 From: Daniel Schiavini Date: Fri, 21 Jun 2024 11:02:14 +0200 Subject: [PATCH] Describe how to install your own vypyter --- README.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/README.md b/README.md index 867255f..9303975 100644 --- a/README.md +++ b/README.md @@ -15,6 +15,7 @@ It exposes port 8000 and uses environment variables defined in the `.env` file a ## Getting Started +### Running locally To run the project locally, you need to follow these steps: 1. Ensure Docker and Docker Compose are installed on your machine. If not, you can download them from the official Docker website. @@ -41,6 +42,12 @@ Run the command `docker compose up` to start it in the foreground, or `docker co 5. The `vypyter` service should now be running and accessible at `http://localhost:8000`. +### Deploying to a server + +If you want to deploy the JupyterHub to a server, please read the following article: +[Deploy your own Vyper JupyterLab notebook server +](https://medium.com/@daniel.schiavini/deploy-your-own-vyper-jupyterlab-notebook-server-a3b00184be20). + ## GitHub Actions In order to run the GitHub Actions, you need to add the following secrets to your repository: - `AUTH_SSH_USER`: The username used to authenticate with the server.