|Reading time:||30 min|
|Last updated:||26 Jun 2023|
|26 Jun 2023|
This guide is intended to get you up and running with this tool quickly with the most common settings. For a thorough review of all options, refer to the official documentation.
OpenVSCode Server supports the Arm architecture and is useful for developing on a remote Arm machine. It can be used on cloud instances, without requiring a Linux desktop to be installed. It’s also useful when developing on a local Arm machine with a Linux subsystem, such as Windows Subsystem for Linux (WSL), ChromeOS with Linux enabled, or Multipass.
Follow the instructions below to install OpenVSCode Server natively on an Arm Linux machine.
Confirm you are using an Arm machine by running:
The output should be:
If you see a different result, you are not using an Arm computer running 64-bit Linux.
Download a release of OpenVSCode Server from the
GitHub release area
. The releases are in sync with VS Code and change frequently. Make sure to download the
For example, use
wget to download.
Install the download by extracting the file
tar xvfz openvscode-server-v1.79.2-linux-arm64.tar.gz
To start OpenVSCode Server run:
The server will print a URL to access VS Code in a browser. The URL is localhost URL. If your machine is a remote system or a Linux subsystem there are two options to connect using your local browser.
Refer to SSH for more info about SSH.
-L option of
ssh to forward port 3000.
ssh -L 3000:localhost:3000 user@ip-address
After connecting with port forwarding, use the localhost link printed by
openvscode-server. It includes a token for security and will be similar to:
Open the link in your local browser and VS Code will appear.
The second option is to open port
3000 for access. On a cloud instance this involves changing the security group to open TCP port 3000. For best security, Make sure to open the port for your IP address only, not from all IP addresses.
Each cloud provider will have instructions on how to work with security group. Refer to the AWS documentation as an example.
With the port open, substitute the public IP address of the instance instead of localhost.
On ChromeOS you can use the Linux configuration settings to automatically do port forwarding. No SSH connection is needed.
There are command line options to change the port, the token, and other configuration options. To see the options run:
If you are running all on a local machine the token can be eliminated using the
It’s also possible to run an existing docker image which uses Ubuntu Linux for Arm and mounts your host directory to access files on your computer. Refer to the GitHub README for more information.
Install your favorite Extensions, select your favorite Color Theme, and enjoy VS Code in the browser.
How would you rate the overall quality of this tool quick-install guide?