This project contains an Xterm.js frontend that connets to a Go backend to provide a shell to the host system. Basically, access your shell from a browser.

Some use cases I had:

1. Deploy to a compute instance in your networks and expose it when needed to gain shell access to your network over the browser
2. Deploy to a Kubernetes cluster with appropriate (Cluster)Role and (Cluster)RoleBinding resources to allow some level of access to developers
3. Exposing a CLI tool (see ./examples/k9s for an example) over the browser. Think CLI-as-a-frontend
4. Doing a demo for a CLI tool over the browser

Table of Contents

• Cloudshell
• Development
  • Install dependencies
  • Test run it
• Build/Release
  • Building the project
  • Creating the Docker image
  • Publishing the Docker image
  • Publishing example Docker images
• Usage/Configuration
  • Cloudshell CLI tool
• Deploy
  • Running the Docker image
  • Deploying via Helm
• CI/CD
• License

Run make init to install both Node.js and Golang dependencies.

Run make start to start the Go backend which will also serve the static files for the website.

Open your browser at http://localhost:8376 to view your shell in the browser.

To build this project, run make build to build the binary

Run make package to create the Docker image. To customise the package process:

1. Create a file named Makefile.properties (this will be -included by the Makefile)
2. Set image_namespace to your desired namespace (defaults to zephinzer)
3. Set image_name to your desired image name (defaults to cloudshell)
4. Set image_tag to your desired tag (defaults to the first 8 characters of the Git commit hash)

Run make publish to publish the Docker image. Same customisations as above apply.

Run make publish-example id=${id} to publish the example Docker images where ${id} is the directory name of the directory in the ./examples directory.

Configurations can be set via flags or environment variables. To view available configurations in your binary instance, run cloudshell --help. Otherwise, flags and environment variables follow a rule of kebab-lower-case for flags and SNAKE_UPPER_CASE for environment variables.

Run make run to run the Docker image locally

Go to ./deploy/cloudshell and run helm install --values ./values.yaml --set-url url=cloudshell.yourdomainname.com cloudshell .. Replace cloudshell.yourdomainname.com with your own domain name. You could also set the url property inside the ./values.yaml file.

The following environment variables should be set in the CI pipeline:

This project is licensed under the MIT license.