code-server/docs
Asher a1af9e2a56
chore: move to patches (#4997)
* Move integration types into code-server

This will be easier to maintain than to have it as a patch.

* Disable connection token

Using a flag means we will not need to patch it out.  I think this is
new from 1.64?

* Add product.json to build process

This way we do not have to patch it.

* Ship with remote agent package.json

Instead of the root one.  This contains fewer dependencies.

* Let Code handle errors

This way we will not have to patch Code to make this work and I think it
makes sense to let Code handle the request.

If we do want to handle errors we can do it cleanly by patching their
error handler to throw instead.

* Move manifest override into code-server

This way we will not have to patch it.

* Move to patches

- Switch submodule to track upstream
- Add quilt to the process
- Add patches

The node-* ignore was ignoring one of the diffs so I removed it.  This
was added when we were curling Node as node-v{version}-darwin-x64 for
the macOS build but this no longer happens (we use the Node action to
install a specific version now so we just use the system-wide Node).

* Use pre-packaged Code
2022-03-22 15:07:14 -05: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 chore: move to patches (#4997) 2022-03-22 15:07:14 -05:00
FAQ.md docs: Update some more links (#4806) 2022-02-01 09:45:19 -07:00
MAINTAINING.md fix(ci): correctly download npm/docker artifacts (#4995) 2022-03-17 11:52:39 -07:00
README.md release: v4.1.0 (#4946) 2022-03-03 14:46:17 -06:00
SECURITY.md docs: Update some more links (#4806) 2022-02-01 09:45:19 -07:00
android.md docs: add section for Android (#4621) 2021-12-15 20:37:16 +00:00
collaboration.md release: v4.1.0 (#4946) 2022-03-03 14:46:17 -06:00
guide.md Update guide.md (#4981) 2022-03-11 09:49:12 -07:00
helm.md release: v4.1.0 (#4946) 2022-03-03 14:46:17 -06:00
install.md docs: Update some more links (#4806) 2022-02-01 09:45:19 -07:00
ios.md docs: add section for iOS (#4622) 2021-12-14 23:43:52 +00:00
ipad.md docs: Update some more links (#4806) 2022-02-01 09:45:19 -07:00
link.md docs: Update some more links (#4806) 2022-02-01 09:45:19 -07:00
manifest.json release: v4.1.0 (#4946) 2022-03-03 14:46:17 -06:00
npm.md docs: Update some more links (#4806) 2022-02-01 09:45:19 -07:00
requirements.md Update requirements.md (#4882) 2022-02-18 11:06:58 -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 docs: Update some more links (#4806) 2022-02-01 09:45:19 -07: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 v4.1.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.