Skip to content

Commit

Permalink
Describe how to install your own vypyter
Browse files Browse the repository at this point in the history
  • Loading branch information
DanielSchiavini committed Jun 21, 2024
1 parent 63c9ec4 commit 7c20bb9
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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.
Expand Down

0 comments on commit 7c20bb9

Please sign in to comment.