README.md 1.6 KB
Newer Older
A
Anmol Sethi 已提交
1
# code-server
A
Asher 已提交
2

3 4
`code-server` is [VS Code](https://github.com/Microsoft/vscode) running on a
remote server, accessible through the browser.
5

6
Try it out:
7

8
```bash
9
docker run -it -p 127.0.0.1:8080:8080 -v "$PWD:/home/coder/project" codercom/code-server
10 11
```

12 13 14
- **Code anywhere:** Code on your Chromebook, tablet, and laptop with a
  consistent dev environment. Develop on a Linux machine and pick up from any
  device with a web browser.
A
Asher 已提交
15 16 17
- **Server-powered:** Take advantage of large cloud servers to speed up tests,
  compilations, downloads, and more. Preserve battery life when you're on the go
  since all intensive computation runs on your server.
K
Kyle Carberry 已提交
18

A
Asher 已提交
19 20
![Example gif](/doc/assets/code-server.gif)

K
Kyle Carberry 已提交
21
## Getting Started
22 23 24

### Requirements

A
Asher 已提交
25 26 27
- 64-bit host.
- At least 1GB of RAM.
- 2 cores or more are recommended (1 core works but not optimally).
A
Asher 已提交
28 29
- Secure connection over HTTPS or localhost (required for service workers and
  clipboard support).
A
Asher 已提交
30
- For Linux: GLIBC 2.17 or later and GLIBCXX 3.4.15 or later.
31

K
Kyle Carberry 已提交
32
### Run over SSH
33

K
Kyle Carberry 已提交
34
Use [sshcode](https://github.com/codercom/sshcode) for a simple setup.
K
Kyle Carberry 已提交
35

A
Asher 已提交
36
### Digital Ocean
37

38
[![Create a Droplet](./doc/assets/droplet.svg)](https://marketplace.digitalocean.com/apps/code-server)
A
Asher 已提交
39

A
Asher 已提交
40
### Releases
41

A
Asher 已提交
42 43 44
1. [Download a release](https://github.com/cdr/code-server/releases). (Linux and
   OS X supported. Windows support planned.)
2. Unpack the downloaded release then run the included `code-server` script.
A
Asher 已提交
45
3. In your browser navigate to `localhost:8080`.
A
Asher 已提交
46

A
Anmol Sethi 已提交
47
## FAQ
A
Asher 已提交
48

A
Anmol Sethi 已提交
49
See [./doc/FAQ.md](./doc/FAQ.md).
A
Asher 已提交
50

K
Kyle Carberry 已提交
51
## Enterprise
52

A
Asher 已提交
53
Visit [our enterprise page](https://coder.com) for more information about our
A
Anmol Sethi 已提交
54
enterprise offerings.