Copy page

Guides

Visual Studio Code Server

Visual Studio Code is a source-code editor developed by Microsoft. It includes support for debugging, syntax highlighting, intelligent code completion, snippets, code refactoring, and embedded Git. It features a Code server, which allows you to run Visual Studio Code remotely and access it through a web browser or your local Visual Studio Code client.

This guide explains how to create and deploy a Visual Studio Code server app. To run this example, follow these steps:

1. Install the CLI and a container runtime engine, for example Docker. Use the unikraft CLI or the legacy kraft CLI.

2. Clone the examples repository and cd into the examples/visual-studio-code-server directory:

Code
git clone https://github.com/unikraft-cloud/examples
cd examples/visual-studio-code-server/

Make sure to log into Unikraft Cloud and pick a metro close to you. This guide uses fra (Frankfurt, 🇩🇪):

When done, invoke the following command to deploy this app on Unikraft Cloud:

The output shows the instance address and other details:

Code
[●] Deployed successfully!
 │
 ├─────── name: code-server
 ├─────── uuid: c1a619a0-e222-4042-94b8-ba4b39353417
 ├────── metro: https://api.fra.unikraft.cloud/v1
 ├────── state: starting
 ├───── domain: https://blue-shape-chmxf1g4.fra.unikraft.app
 ├────── image: visual-studio-code-server@sha256:633ec8a8dcb342b093c6f055f84fc056ee1abe40ff56e98bd612c4b9d4ddffcb
 ├───── memory: 2048 MiB
 ├──── service: blue-shape-chmxf1g4
 ├─ private ip: 10.0.0.49
 └─────── args: /app/code-server/bin/code-server --host 0.0.0.0 --port 8443 --auth password

This will create a volume for data persistence, and mount it at /workspace inside the VM.

In this case, the instance name is code-server and the address is https://blue-shape-chmxf1g4.fra.unikraft.app. The name was preset, but the address is different for each run. Enter the provided address into your browser of choice to access the Code server instance.

You can list information about the volume by running:

Code
NAME            CREATED AT      SIZE     ATTACHED TO  MOUNTED BY   STATE      PERSISTENT
code-workspace  13 minutes ago  1.0 GiB  code-server  code-server  mounted    true

You can list information about the instance by running:

Code
NAME         FQDN                                  STATE    STATUS   IMAGE                                                 MEMORY   VCPUS  ARGS                                 BOOT TIME
code-server  blue-shape-chmxf1g4.fra.unikraft.app  standby  standby  visual-studio-code-server@sha256:633ec8a8dcb342b0...  2.0 GiB  1      /app/code-server/bin/code-server...  8.45 ms

When done, you can remove the instance:

The volume isn't removed by default, so you can recreate the instance and still have access to your old data. Remove it using:

Learn more

Use the --help option for detailed information on using Unikraft Cloud:

Or visit the CLI Reference or the legacy CLI Reference.