bughz
/
code-server
mirror of https://github.com/coder/code-server.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
code-server/docs
History
Joe Previte e2f585f368
docs: add --edge to install section (#5767) 
This adds documentation for the flag `--edge` which we've had for a
while but forgot to document.

Fixes #5717

Co-authored-by: repo-ranger[bot] <39074581+repo-ranger[bot]@users.noreply.github.com>
 		2022-11-10 11:50:37 -07:00
..
assets Sidebar icons (#5444) 2022-08-14 03:00:46 +00:00
CODE_OF_CONDUCT.md refactor: update prettier and doctoc (#5605) 2022-10-13 22:16:55 +00:00
CONTRIBUTING.md refactor: update prettier and doctoc (#5605) 2022-10-13 22:16:55 +00:00
FAQ.md docs: update faq for getting started (#5731) 2022-11-01 17:48:32 +00:00
MAINTAINING.md refactor: get version dynamically (#5753) 2022-11-08 22:45:01 +00:00
README.md docs: clarify cpus are virtual (#5428) 2022-08-09 14:17:18 -05:00
SECURITY.md refactor(ci): fix fetch-depth and add some caching (#5563) 2022-09-19 11:56:34 -05:00
android.md docs: remove references to installing with yarn in favor of npm (#5518) 2022-08-30 12:00:11 -05:00
collaboration.md release: 4.7.0 (#5546) 2022-09-09 15:15:39 -07:00
guide.md refactor: update prettier and doctoc (#5605) 2022-10-13 22:16:55 +00:00
helm.md release: 4.8.0 (#5698) 2022-10-24 16:23:03 -07:00
install.md docs: add --edge to install section (#5767) 2022-11-10 11:50:37 -07:00
ios.md Update ios.md (#5079) 2022-04-12 11:32:49 -07:00
ipad.md refactor: update prettier and doctoc (#5605) 2022-10-13 22:16:55 +00:00
link.md docs: Update some more links (#4806) 2022-02-01 09:45:19 -07:00
manifest.json release: 4.8.0 (#5698) 2022-10-24 16:23:03 -07:00
npm.md refactor: update prettier and doctoc (#5605) 2022-10-13 22:16:55 +00:00
requirements.md docs: correct trial length (#5396) 2022-08-01 10:20:55 -05:00
termux.md refactor: update prettier and doctoc (#5605) 2022-10-13 22:16:55 +00: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 latest

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 vCPUs

Getting started

There are four 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. Deploy code-server to your team with coder/coder
  4. 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.

Note To manage code-server for a team on your infrastructure, see: coder/coder

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.