Go to file
Joseph Reiter 3bf470f19c
docs: simplify termux installation process (#5078)
* Update termux.md

1) Updated information to use PRoot (simpler than Andronix and the way supported by Termux) to create and access the Debian distro.
2) Added helpful information on using PRoot with your dev environment.
3) Cleaned up spelling, grammar, and made documentation more consistent between sections.

* docs: Termux correct packages to install

Updated some erroneously missing packages (vim and sudo) necessary for multi-user setup.

* docs: cleaned up verbiage

Co-authored-by: Joe Previte <jjprevite@gmail.com>

* docs: corrected punctuation

Co-authored-by: Joe Previte <jjprevite@gmail.com>

* docs: correct punctuation

Co-authored-by: Joe Previte <jjprevite@gmail.com>

* docs: clarify pkg command shorthand

* Ran yarn fmt on docs

Co-authored-by: Joe Previte <jjprevite@gmail.com>
2022-04-12 15:42:22 -07:00
.github Set permissions for GitHub actions (#5090) 2022-04-12 18:59:11 +00:00
.tours chore: move Code to a submodule (#4990) 2022-03-14 21:37:29 -05:00
ci chore: remove file ext. from LICENSE (#5070) 2022-04-07 10:36:33 -07:00
docs docs: simplify termux installation process (#5078) 2022-04-12 15:42:22 -07:00
lib chore(Code): upgrade to 1.65 (#5047) 2022-03-30 18:33:58 -05:00
patches fix: version in about dialog (#5057) 2022-03-31 16:14:03 -05:00
src chore: move to patches (#4997) 2022-03-22 15:07:14 -05:00
test fix: version in about dialog (#5057) 2022-03-31 16:14:03 -05:00
typings docs: Update some more links (#4806) 2022-02-01 09:45:19 -07:00
.dockerignore Simplify packaging and improve scripts 2020-05-08 01:04:24 -04:00
.editorconfig Revert .editorconfig (#4640) 2021-12-16 15:30:07 -06:00
.eslintrc.yaml chore: replace eslint-import-resolver-alias with eslint-import-resolver-typescript (#4546) 2021-12-07 14:39:01 -07:00
.gitattributes browser: Add favicon.afdesign 2021-01-08 23:03:34 -05:00
.gitignore chore(Code): upgrade to 1.65 (#5047) 2022-03-30 18:33:58 -05:00
.gitmodules chore: move to patches (#4997) 2022-03-22 15:07:14 -05:00
.node-version chore: Update dependency requirements. Fix node version manager. 2021-07-21 14:32:16 -04:00
.nvmrc chore: Update dependency requirements. Fix node version manager. 2021-07-21 14:32:16 -04:00
.prettierrc.yaml chore: move Code to a submodule (#4990) 2022-03-14 21:37:29 -05:00
.stylelintrc.yaml Fix bugs in CI 2020-02-18 19:06:35 -05:00
CHANGELOG.md release: 4.2.0 (#5014) 2022-03-22 16:34:29 -07:00
LICENSE chore: remove file ext. from LICENSE (#5070) 2022-04-07 10:36:33 -07:00
ThirdPartyNotices.txt Add ThirdPartyNotices.txt 2020-07-16 19:01:09 -06:00
install.sh feat: Add a shrinkwrap file to the NPM release (#5010) 2022-03-29 12:33:56 -05:00
package.json chore(deps): update dependency minimist to v2.2.1 (#5013) 2022-03-30 15:41:26 -07:00
renovate.json chore(rennovate): ignore updates for express (#5044) 2022-03-30 13:25:37 -07:00
tsconfig.json chore: move Code to a submodule (#4990) 2022-03-14 21:37:29 -05:00
yarn.lock chore(deps): update dependency minimist to v2.2.1 (#5013) 2022-03-30 15:41:26 -07:00

docs/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
🔔 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.