a
/
code-server
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
code-server/docs
History
Joe Previte c91033c611
docs(maintaining): fix #4174 		2021-09-23 15:45:29 -07: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 Add vscode via vendor package. 2021-09-15 14:54:33 -04:00
FAQ.md docs: add how to change port 2021-08-24 15:16:01 -07:00
MAINTAINING.md docs(maintaining): fix #4174 2021-09-23 15:45:29 -07:00
README.md chore(release): bump version to 3.12.0 2021-09-15 15:54:06 -04:00
SECURITY.md refactor(docs): clean up and restructure 2021-07-12 14:03:09 -05:00
collaboration.md chore(release): bump version to 3.12.0 2021-09-15 15:54:06 -04:00
guide.md Revert "Revert "refactor: move helm README to docs/helm.md"" 2021-09-13 14:16:47 -07:00
helm.md chore(release): bump version to 3.12.0 2021-09-15 15:54:06 -04:00
install.md Revert "Revert "refactor: move helm README to docs/helm.md"" 2021-09-13 14:16:47 -07:00
ipad.md add newline (whoops) 2021-09-23 14:45:09 +00:00
link.md change code block formatting 2021-08-06 18:14:43 -05:00
manifest.json chore(release): bump version to 3.12.0 2021-09-15 15:54:06 -04: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 Add vscode via vendor package. 2021-09-15 14:54:33 -04: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

"GitHub Discussions" "Join us on Slack" Twitter Follow codecov See v3.12.0 docs

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

Screenshot

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:

  1. Using the install script, which automates most of the process. The script uses the system package manager if possible.
  2. Manually installing code-server
  3. 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.