code-server-2/docs
Joe Previte d15731a570
docs: update sections around VS Code fork (#4571)
* docs(CONTRIBUTING): update workflow based on vscode changes

* docs(MAINTAINING): add section for syncing VS Code upstream

Co-authored-by: repo-ranger[bot] <39074581+repo-ranger[bot]@users.noreply.github.com>
2021-12-06 17:58:04 +00: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 docs: update sections around VS Code fork (#4571) 2021-12-06 17:58:04 +00:00
FAQ.md Open VSX switch, Part II (#4319) 2021-11-10 10:00:59 -05:00
MAINTAINING.md docs: update sections around VS Code fork (#4571) 2021-12-06 17:58:04 +00:00
README.md chore: add deprecation notice for --link (#4562) 2021-11-29 12:03:33 -08:00
SECURITY.md refactor(docs): clean up and restructure 2021-07-12 14:03:09 -05:00
collaboration.md fixup! Update collaboration.md 2021-09-30 15:23:16 -07:00
guide.md Mention that Safari needs TLS 1.2 (#4346) 2021-10-18 10:31:30 -05:00
helm.md chore(release): bump version to 3.12.0 2021-09-15 15:54:06 -04:00
install.md fix weird format 2021-10-05 11:40:57 -05:00
ipad.md fix weird format 2021-10-05 11:40:57 -05:00
link.md chore: add deprecation notice for --link (#4562) 2021-11-29 12:03:33 -08:00
manifest.json chore(release): bump version to 3.12.0 2021-09-15 15:54:06 -04:00
npm.md fix weird format 2021-10-05 11:40:57 -05:00
requirements.md docs: add note about external domain in requirements 2021-08-24 16:38:12 -07:00
termux.md Fix : recreate the termux guide to adapt the recent changes (#4472) 2021-11-12 14:25:48 -07: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
🔔 code-server is a free browser-based IDE while Coder, is our enterprise developer workspace platform. For more information, visit Coder.com

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.

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.