From f1aaf45de70404968523198d4be2d5c1c6baac8c Mon Sep 17 00:00:00 2001 From: Jackson Delahunt Date: Sun, 27 Aug 2023 20:37:57 +1000 Subject: [PATCH] docs --- .github/workflows/deploy.yml | 2 +- README.md | 6 +++++- 2 files changed, 6 insertions(+), 2 deletions(-) diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml index d342d7b..ccc7483 100644 --- a/.github/workflows/deploy.yml +++ b/.github/workflows/deploy.yml @@ -30,7 +30,7 @@ jobs: ngrok_auth_token: ${{ secrets.NGROK_AUTH_TOKEN }} - name: Get URL - run: echo "Desktop Environment URL $(curl -s localhost:4040/api/tunnels | jq -r .tunnels[0].public_url)" + run: echo "Cloud Desktop Environment URL $(curl -s localhost:4040/api/tunnels | jq -r .tunnels[0].public_url)" - name: Run for 20 mins run: sleep 1200 diff --git a/README.md b/README.md index 7adc1ab..2ed5e06 100644 --- a/README.md +++ b/README.md @@ -25,7 +25,11 @@ git clone https://github.com/sabrehagen/desktop-environment ## Running in the Cloud -Fork this repository, add your [ngrok auth token](https://dashboard.ngrok.com/login) to the repository secrets as `NGROK_AUTH_TOKEN`, run the [Deploy Desktop Environment](../../actions/workflows/deploy.yml) GitHub Actions workflow, and the desktop environment will be deployed to GitHub's Actions infrastructure. The environment url will be printed in the output of the `Get URL` workflow step. +- Fork this repository. +- Enable [Read and write permissions](../../settings/actions) on your fork to allow GitHub Actions to push the container to your repository's container registry. +- Add your [ngrok auth token](https://dashboard.ngrok.com/login) to the repository secrets as `NGROK_AUTH_TOKEN` to enable remote access. +- Run the [Deploy Desktop Environment](../../actions/workflows/deploy.yml) GitHub Actions workflow for the desktop environment to be deployed to GitHub's Actions infrastructure. +- Click the Cloud Desktop Environment URL printed in the output of the `Get URL` workflow step. Fork the [cloud-computer/cloud-computer](https://github.com/cloud-computer/cloud-computer) repository to deploy the desktop environment to Google cloud.