X Tutup
Skip to content

jmkiser-dev/code-server

 
 

Repository files navigation

code-server

release ci

code-server is VS Code accessible through the browser.

Try it out:

docker run -it -p 127.0.0.1:8080:8080 codercom/code-server

Screenshot

Getting Started

Requirements

  • 64-bit host.
  • At least 1GB of RAM.
  • 2 cores or more are recommended (1 core works but not optimally).
  • Secure connection over HTTPS or localhost (required for service workers and clipboard support).
  • For Linux: GLIBC 2.17 or later and GLIBCXX 3.4.15 or later.
  • Docker (for Docker versions of code-server).

Run over SSH

Use sshcode for a simple setup.

Docker

See the Docker one-liner mentioned above. Dockerfile is at /Dockerfile.

Digital Ocean

Create a Droplet

Binaries

  1. Download a binary. (Linux and OS X supported. Windows coming soon)
  2. Unpack the downloaded file then run the binary.
  3. In your browser navigate to localhost:8080.

Build

yarn
yarn build
node build/out/entry.js # You can run the built JavaScript with Node.
yarn binary             # Or you can package it into a binary.

If changes are made to the patch and you've built previously you must manually reset VS Code then run yarn patch:apply.

Security

Authentication

By default code-server enables password authentication using a randomly generated password. You can set the PASSWORD environment variable to use your own instead or use --auth none to disable password authentication.

Do not expose code-server to the open internet without some form of authentication.

Encrypting traffic with HTTPS

If you aren't doing SSL termination elsewhere you can directly give code-server a certificate with code-server --cert followed by the path to your certificate. Additionally, you can use certificate keys with --cert-key followed by the path to your key. If you pass --cert without any path code-server will generate a self-signed certificate.

If code-server has been passed a certificate it will also respond to HTTPS requests and will redirect all HTTP requests to HTTPS. Otherwise it will respond only to HTTP requests.

You can use Let's Encrypt to get an SSL certificate for free.

Do not expose code-server to the open internet without SSL, whether built-in or through a proxy.

Roadmap

  • Stay up to date! Get notified about new releases of code-server. Screenshot
  • Electron and Chrome OS applications to bridge the gap between local<->remote.

Telemetry

Use the --disable-telemetry flag to completely disable telemetry. We use the data collected to improve code-server.

Enterprise

Visit our enterprise page for more information about our enterprise offering.

About

Run VS Code on a remote server.

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages

  • TypeScript 85.5%
  • HTML 5.9%
  • Shell 2.8%
  • JavaScript 2.7%
  • Dockerfile 1.9%
  • CSS 1.2%
X Tutup