History

Leonardo Galesky 0de9c07f0a Apply suggestions from @bpmct's code review Co-authored-by: Ben Potter <me@bpmct.net>		2021-09-13 11:08:27 -03:00
..
assets	fix(docs): use png screenshot instead of svg	2021-09-09 17:58:17 -07:00
CODE_OF_CONDUCT.md	Update docs/CODE_OF_CONDUCT.md	2021-02-03 11:08:06 -07:00
CONTRIBUTING.md	refactor: match /test/unit structure to /src	2021-07-29 09:48:40 -07:00
FAQ.md	docs: add how to change port	2021-08-24 15:16:01 -07:00
MAINTAINING.md	docs: add troubleshooting section for documentation	2021-08-30 10:32:56 -07:00
README.md	fix(docs): use png screenshot instead of svg	2021-09-09 17:58:17 -07:00
SECURITY.md	refactor(docs): clean up and restructure	2021-07-12 14:03:09 -05:00
collaboration.md	Apply suggestions from @bpmct's code review	2021-09-13 11:08:27 -03:00
guide.md	fix: update tar version with resolution	2021-09-07 14:51:16 -07:00
install.md	Revert "refactor: move helm README to docs/helm.md"	2021-08-25 12:02:39 -07:00
ipad.md	refactor(docs): clean up and restructure	2021-07-12 14:03:09 -05:00
link.md	change code block formatting	2021-08-06 18:14:43 -05:00
manifest.json	docs(): create code sharing docs	2021-09-12 14:55:06 -03:00
npm.md	docs: fix typos and wording in npm	2021-08-24 16:35:13 -07:00
requirements.md	docs: add note about external domain in requirements	2021-08-24 16:38:12 -07:00
termux.md	refactor(docs): clean up and restructure	2021-07-12 14:03:09 -05:00
triage.md	refactor(docs): clean up and restructure	2021-07-12 14:03:09 -05:00
upgrade.md	refactor(docs): clean up and restructure	2021-07-12 14:03:09 -05:00

README.md

code-server

Run VS Code on any machine anywhere and access it in the browser.

Highlights

Code on any device with a consistent development environment
Use cloud servers to speed up tests, compilations, downloads, and more
Preserve battery life when you're on the go; all intensive tasks run on your server

Requirements

See requirements for minimum specs, as well as instructions on how to set up a Google VM on which you can install code-server.

TL;DR: Linux machine with WebSockets enabled, 1 GB RAM, and 2 CPUs

Getting started

There are three ways to get started:

Using the install script, which automates most of the process. The script uses the system package manager if possible.
Manually installing code-server
Using our one-click buttons and guides to deploy code-server to a cloud provider ⚡

If you use the install script, you can preview what occurs during the install process:

curl -fsSL https://code-server.dev/install.sh | sh -s -- --dry-run

To install, run:

curl -fsSL https://code-server.dev/install.sh | sh

When done, the install script prints out instructions for running and starting code-server.

We also have an in-depth setup and configuration guide.

TLS and authentication (beta)

To add TLS and authentication out of the box, use code-server --link.

Questions?

See answers to frequently asked questions.

Want to help?

See Contributing for details.

Hiring

Interested in working at Coder? Check out our open positions!

For Organizations

Want remote development for your organization or enterprise? Visit our website to learn more about Coder.