code-server/README.md

78 lines
2.9 KiB
Markdown
Raw Normal View History

2020-10-07 05:29:53 +08:00
# code-server · [!["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)
2019-01-08 08:46:19 +08:00
![Lines](https://img.shields.io/badge/Coverage-51.67%25-green.svg)
2021-03-05 06:24:59 +08:00
[![See latest docs](https://img.shields.io/static/v1?label=Docs&message=see%20latest%20&color=blue)](https://github.com/cdr/code-server/tree/v3.9.1/docs)
2020-05-18 04:53:08 +08:00
Run [VS Code](https://github.com/Microsoft/vscode) on any machine anywhere and access it in the browser.
2019-03-06 09:45:21 +08:00
2021-02-04 00:32:35 +08:00
![Screenshot](./docs/assets/screenshot.png)
2020-05-22 10:16:16 +08: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
You can use whatever linux distribution floats your boat but in our [guide](./docs/guide.md) we assume Debian on Google Cloud.
2020-05-18 08:47:33 +08:00
## Getting Started
There are three ways you can get started:
1. Using the [install script](./install.sh), which automates most of the process. The script uses the system package manager (if possible)
2021-02-04 00:32:35 +08:00
2. Manually installing code-server; see [Installation](./docs/install.md) for instructions applicable to most use cases
2021-03-09 07:58:43 +08: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-05 04:31:01 +08:00
If you choose to use the install script, you can preview what occurs during the install process:
2020-05-20 11:41:28 +08:00
```bash
2020-05-28 03:48:03 +08:00
curl -fsSL https://code-server.dev/install.sh | sh -s -- --dry-run
```
To install, run:
```bash
2020-05-22 05:10:29 +08: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-23 03:38:03 +08:00
2021-02-04 00:32:35 +08:00
We also have an in-depth [setup and configuration](./docs/guide.md) guide.
2021-03-09 07:58:43 +08:00
### code-server --link
2020-10-22 04:45:53 +08:00
2020-11-17 06:18:12 +08: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-14 07:25:09 +08:00
2020-10-22 04:45:53 +08:00
- TLS
- Authentication
- Port Forwarding
2020-10-14 07:25:09 +08:00
```bash
$ code-server --link
2021-03-17 10:59:30 +08:00
Proxying code-server, you can access your IDE at https://valmar-jon.cdr.co
```
2020-02-19 08:07:01 +08:00
## FAQ
2021-02-04 00:32:35 +08:00
See [./docs/FAQ.md](./docs/FAQ.md).
2019-01-08 08:46:19 +08:00
## Want to help?
2020-03-20 05:53:31 +08:00
2021-02-04 00:32:35 +08:00
See [CONTRIBUTING](./docs/CONTRIBUTING.md) for details.
2020-03-20 05:53:31 +08:00
2020-06-10 06:10:28 +08:00
## Hiring
Interested in [working at Coder](https://coder.com)? Check out [our open positions](https://jobs.lever.co/coder)!
2020-07-30 01:37:19 +08:00
## For Organizations
2019-09-27 22:39:29 +08:00
2020-07-30 01:37:19 +08:00
Visit [our website](https://coder.com) for more information about remote development for your organization or enterprise.