README.md 2.6 KB
Newer Older
K
Kyle Carberry 已提交
1
# code-server
A
Asher 已提交
2

K
Kyle Carberry 已提交
3 4 5
[!["Open Issues"](https://img.shields.io/github/issues-raw/codercom/code-server.svg)](https://github.com/codercom/code-server/issues)
[!["Latest Release"](https://img.shields.io/github/release/codercom/code-server.svg)](https://github.com/codercom/code-server/releases/latest)
[![MIT license](https://img.shields.io/badge/license-MIT-green.svg)](#)
C
Colin 已提交
6
[![Discord](https://discordapp.com/api/guilds/463752820026376202/widget.png)](https://discord.gg/zxSwN8Z)
A
Asher 已提交
7

8 9 10 11 12 13 14 15
`code-server` is [VS Code](https://github.com/Microsoft/vscode) running on a remote server, accessible through the browser.

- Code on your Chromebook, tablet, and laptop with a consistent dev environment.
	- If you have a Windows or Mac workstation, more easily develop for Linux.
- Take advantage of large cloud servers to speed up tests, compilations, downloads, and more.
- Preserve battery life when you're on the go.
	- All intensive computation is ran on your server.
	- You're no longer running excess instances of Chrome.
K
Kyle Carberry 已提交
16 17 18 19 20 21 22

![Screenshot](/doc/assets/ide.png)

## Getting Started

[Try `code-server` now](https://coder.com/signup) for free at coder.com.

23 24
**OR**

K
Kyle Carberry 已提交
25 26 27 28 29 30 31
1.  [Download a binary](https://github.com/codercom/code-server/releases) (Linux and OSX supported. Windows coming soon)
2.  Start the binary with the project directory as the first argument

    ```
    code-server <inital directory to open>
    ```
	> You will be prompted to enter the password shown in the CLI
A
Asher 已提交
32
	`code-server` should now be running at https://localhost:8443.
A
Asher 已提交
33

K
Kyle Carberry 已提交
34 35 36 37 38
	> code-server uses a self-signed SSL certificate that may prompt your browser to ask you some additional questions before you proceed. Please [read here](doc/self-hosted/index.md) for more information.

For detailed instructions and troubleshooting, see the [self-hosted quick start guide](doc/self-hosted/index.md).

Quickstart guides for [Google Cloud](doc/admin/install/google_cloud.md), [AWS](doc/admin/install/aws.md), and [Digital Ocean](doc/admin/install/digitalocean.md).
A
Asher 已提交
39

K
Kyle Carberry 已提交
40 41 42 43 44 45 46 47 48 49 50 51 52 53 54
How to [secure your setup](/doc/security/ssl.md).

## Development

### Known Issues

- Debugging extensions doesn’t work.

### Future

- Windows support.
- Electron and ChromeOS applications to bridge the gap between local<->remote.
- Run VS Code unit tests against our builds to ensure features work as expected.

## Contributing
A
Asher 已提交
55

56
Development guides are coming soon.
A
Asher 已提交
57

K
Kyle Carberry 已提交
58
## License
A
Asher 已提交
59

K
Kyle Carberry 已提交
60
[MIT](LICENSE)
A
Asher 已提交
61

K
Kyle Carberry 已提交
62
## Enterprise
A
Asher 已提交
63

64
Visit [our enterprise page](https://coder.com/enterprise) for more information about our enterprise offering.
A
Asher 已提交
65 66 67 68

## Commercialization

If you would like to commercialize code-server, please contact contact@coder.com.