code-server/docs/README.md

78 lines
3.2 KiB
Markdown
Raw Normal View History

2021-06-24 17:10:00 +00:00
# code-server
2019-01-08 00:46:19 +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.10.2 docs](https://img.shields.io/static/v1?label=Docs&message=see%20v3.10.2%20&color=blue)](https://github.com/cdr/code-server/tree/v3.10.2/docs)
2020-05-17 20:53:08 +00:00
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
For a good experience, we recommend at least:
- 1 GB of RAM
- 2 cores
2021-06-29 18:36:25 +00:00
You can use whatever linux distribution floats your boat but in our [guide](https://coder.com/docs/code-server/v3.10.2/guide) we assume Debian on Google Cloud.
2020-05-18 00:47:33 +00:00
## Getting Started
There are three ways you can get started:
2021-06-24 16:21:28 +00:00
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; see [Installation](https://coder.com/docs/code-server/v3.10.2/install) for instructions applicable to most use cases
2021-03-08 23:58:43 +00:00
3. Use our one-click buttons and guides to [deploy code-server to a popular cloud provider](https://github.com/cdr/deploy-code-server) ⚡
2020-06-04 20:31:01 +00:00
If you choose to 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 configuration](https://coder.com/docs/code-server/v3.10.2/guide) guide.
2021-03-08 23:58:43 +00:00
### code-server --link
2020-10-21 20:45:53 +00:00
2020-11-16 22:18:12 +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
2021-03-17 02:59:30 +00:00
Proxying code-server, you can access your IDE at https://valmar-jon.cdr.co
```
2020-02-19 00:07:01 +00:00
## FAQ
See [./FAQ.md](https://coder.com/docs/code-server/v3.10.2/FAQ).
2019-01-08 00:46:19 +00:00
## Want to help?
2020-03-19 21:53:31 +00:00
See [CONTRIBUTING](https://coder.com/docs/code-server/v3.10.2/CONTRIBUTING) for details.
2020-03-19 21:53:31 +00:00
2020-06-09 22:10:28 +00:00
## Hiring
2021-06-30 16:14:04 +00:00
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.