c77999bcd3
* chore(release): bump version to 4.0.0 * Bump test plugin code-server engine Co-authored-by: Asher <ash@coder.com>
78 lines
3.0 KiB
Markdown
78 lines
3.0 KiB
Markdown
# code-server
|
|
|
|
[](https://github.com/cdr/code-server/discussions) [](https://cdr.co/join-community) [](https://twitter.com/coderhq) [](https://codecov.io/gh/cdr/code-server) [](https://github.com/cdr/code-server/tree/v4.0.0/docs)
|
|
|
|
Run [VS Code](https://github.com/Microsoft/vscode) on any machine anywhere and
|
|
access it in the browser.
|
|
|
|
|
|
|
|
## 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](https://coder.com/), is our enterprise developer workspace platform. For more information, visit [Coder.com](https://coder.com/docs/comparison)
|
|
| ---
|
|
|
|
## Requirements
|
|
|
|
See [requirements](requirements.md) 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](https://github.com/cdr/code-server/blob/main/install.sh), which
|
|
automates most of the process. The script uses the system package manager if
|
|
possible.
|
|
2. Manually [installing
|
|
code-server](https://coder.com/docs/code-server/latest/install)
|
|
3. Using our one-click buttons and guides to [deploy code-server to a cloud
|
|
provider](https://github.com/cdr/deploy-code-server) ⚡
|
|
|
|
If you use the install script, you can preview what occurs during the install
|
|
process:
|
|
|
|
```bash
|
|
curl -fsSL https://code-server.dev/install.sh | sh -s -- --dry-run
|
|
```
|
|
|
|
To install, run:
|
|
|
|
```bash
|
|
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](https://coder.com/docs/code-server/latest/guide) guide.
|
|
|
|
## Questions?
|
|
|
|
See answers to [frequently asked
|
|
questions](https://coder.com/docs/code-server/latest/FAQ).
|
|
|
|
## Want to help?
|
|
|
|
See [Contributing](https://coder.com/docs/code-server/latest/CONTRIBUTING) for
|
|
details.
|
|
|
|
## Hiring
|
|
|
|
Interested in [working at Coder](https://coder.com/careers)? Check out [our open
|
|
positions](https://coder.com/careers#openings)!
|
|
|
|
## For Organizations
|
|
|
|
Want remote development for your organization or enterprise? Visit [our
|
|
website](https://coder.com) to learn more about Coder.
|