code-server/docs/README.md

90 lines
3.1 KiB
Markdown
Raw Normal View History

2021-06-24 17:10:00 +00:00
# code-server
2019-01-08 00:46:19 +00:00
2021-07-14 19:20:40 +00:00
[!["GitHub Discussions"](https://img.shields.io/badge/%20GitHub-%20Discussions-gray.svg?longCache=true&logo=github&colorB=purple)](https://github.com/cdr/code-server/discussions) [!["Join us on Slack"](https://img.shields.io/badge/join-us%20on%20slack-gray.svg?longCache=true&logo=slack&colorB=brightgreen)](https://cdr.co/join-community) [![Twitter Follow](https://img.shields.io/twitter/follow/CoderHQ?label=%40CoderHQ&style=social)](https://twitter.com/coderhq) [![codecov](https://codecov.io/gh/cdr/code-server/branch/main/graph/badge.svg?token=5iM9farjnC)](https://codecov.io/gh/cdr/code-server) [![See v3.11.0 docs](https://img.shields.io/static/v1?label=Docs&message=see%20v3.11.0%20&color=blue)](https://github.com/cdr/code-server/tree/v3.11.0/docs)
Run [VS Code](https://github.com/Microsoft/vscode) on any machine anywhere and
access it in the browser.
2019-03-06 01:45:21 +00:00
2021-06-24 16:21:28 +00:00
![Screenshot](./assets/screenshot.png)
2020-05-22 02:16:16 +00:00
## 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](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
2021-07-14 19:20:40 +00:00
code-server](https://coder.com/docs/code-server/v3.11.0/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:
2020-05-20 03:41:28 +00:00
```bash
2020-05-27 19:48:03 +00:00
curl -fsSL https://code-server.dev/install.sh | sh -s -- --dry-run
```
To install, run:
```bash
2020-05-21 21:10:29 +00:00
curl -fsSL https://code-server.dev/install.sh | sh
```
When done, the install script prints out instructions for running and starting
code-server.
2020-05-22 19:38:03 +00:00
We also have an in-depth [setup and
2021-07-14 19:20:40 +00:00
configuration](https://coder.com/docs/code-server/v3.11.0/guide) guide.
2021-03-08 23:58:43 +00:00
### code-server --link
2020-10-21 20:45:53 +00:00
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:
2020-10-13 23:25:09 +00:00
2020-10-21 20:45:53 +00:00
- TLS
- Authentication
- Port forwarding
2020-10-13 23:25:09 +00:00
```bash
$ code-server --link
Proxying code-server, you can access your IDE at https://example.cdr.co
```
## Questions?
See answers to [frequently asked
2021-07-14 19:20:40 +00:00
questions](https://coder.com/docs/code-server/v3.11.0/FAQ).
2019-01-08 00:46:19 +00:00
## Want to help?
2020-03-19 21:53:31 +00:00
2021-07-14 19:20:40 +00:00
See [Contributing](https://coder.com/docs/code-server/v3.11.0/CONTRIBUTING) for
details.
2020-03-19 21:53:31 +00:00
2020-06-09 22:10:28 +00:00
## Hiring
Interested in [working at Coder](https://coder.com/careers)? Check out [our open
positions](https://coder.com/careers#openings)!
2020-07-29 17:37:19 +00:00
## For Organizations
2019-09-27 14:39:29 +00:00
Want remote development for your organization or enterprise? Visit [our
website](https://coder.com) to learn more about Coder.