Go to file
Elliott King 33dbb7b707
Fix broken link on docs site
Links don't work on docs site unless they have md formatting.
2021-06-29 16:43:57 -04:00
.github Spawn a code-server instance for each test suite 2021-06-29 12:06:38 -05:00
.tours chore: update node to v14 (#3481) 2021-06-01 22:49:03 +05:30
ci Spawn a code-server instance for each test suite 2021-06-29 12:06:38 -05:00
docs Fix broken link on docs site 2021-06-29 16:43:57 -04:00
lib/vscode Merge pull request #3588 from cdr/dependabot/npm_and_yarn/lib/vscode/normalize-url-4.5.1 2021-06-09 15:06:08 -07:00
src Move onLine to utilities 2021-06-29 12:04:31 -05:00
test Fix occasional logout failure 2021-06-29 12:06:48 -05:00
typings refactor: parse options with multiple = in cli 2021-06-08 14:33:17 -07:00
.dockerignore Simplify packaging and improve scripts 2020-05-08 01:04:24 -04:00
.editorconfig Add back .editorconfig 2020-02-19 14:22:14 -05:00
.eslintrc.yaml fix: remove eslint-plugin-jest-playwright 2021-04-29 10:46:14 -07:00
.gitattributes browser: Add favicon.afdesign 2021-01-08 23:03:34 -05:00
.gitignore refactor: migrate parcel to browserify 2021-06-28 11:41:45 -07:00
.prettierrc.yaml Shake CI and docs up 2020-02-14 19:46:17 -05:00
.stylelintrc.yaml Fix bugs in CI 2020-02-18 19:06:35 -05:00
CHANGELOG.md refactor: migrate parcel to browserify 2021-06-28 11:41:45 -07:00
LICENSE.txt Shake CI and docs up 2020-02-14 19:46:17 -05:00
ThirdPartyNotices.txt Add ThirdPartyNotices.txt 2020-07-16 19:01:09 -06:00
install.sh chore(deps-dev): bump prettier-plugin-sh from 0.6.1 to 0.7.1 (#3680) 2021-06-28 22:06:55 +05:30
package.json refactor: migrate parcel to browserify 2021-06-28 11:41:45 -07:00
tsconfig.json refactor: migrate parcel to browserify 2021-06-28 11:41:45 -07:00
yarn.lock chore(deps-dev): bump @typescript-eslint/parser from 4.28.0 to 4.28.1 (#3688) 2021-06-29 21:34:51 +05:30

docs/README.md

code-server

"GitHub Discussions" "Join us on Slack" Twitter Follow codecov See v3.10.2 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

For a good experience, we recommend at least:

  • 1 GB of RAM
  • 2 cores

You can use whatever linux distribution floats your boat but in our guide we assume Debian on Google Cloud.

Getting Started

There are three ways you can 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; see Installation for instructions applicable to most use cases
  3. Use our one-click buttons and guides to deploy code-server to a popular cloud provider

If you choose to 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.

We're working on a cloud platform that makes deploying and managing code-server easier. Consider running code-server with the beta flag --link if you don't want to worry about

  • TLS
  • Authentication
  • Port Forwarding
$ code-server --link
Proxying code-server, you can access your IDE at https://valmar-jon.cdr.co

FAQ

See ./FAQ.md.

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.