2020-02-19 08:07:01 +08:00
|
|
|
# code-server
|
2019-01-08 08:46:19 +08:00
|
|
|
|
2019-07-13 07:41:56 +08:00
|
|
|
`code-server` is [VS Code](https://github.com/Microsoft/vscode) running on a
|
|
|
|
|
remote server, accessible through the browser.
|
2019-03-06 09:45:21 +08:00
|
|
|
|
2019-03-07 10:59:43 +08:00
|
|
|
Try it out:
|
2019-09-27 22:39:29 +08:00
|
|
|
|
2019-03-07 10:59:43 +08:00
|
|
|
```bash
|
2020-01-28 02:16:58 +08:00
|
|
|
docker run -it -p 127.0.0.1:8080:8080 -v "$PWD:/home/coder/project" codercom/code-server
|
2019-03-07 10:59:43 +08:00
|
|
|
```
|
|
|
|
|
|
2020-02-21 06:29:08 +08:00
|
|
|
- **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.
|
2019-08-01 06:08:37 +08:00
|
|
|
- **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.
|
2019-03-05 02:31:27 +08:00
|
|
|
|
2020-03-03 05:13:39 +08:00
|
|
|
|
|
|
|
|
|
2019-03-05 02:31:27 +08:00
|
|
|
## Getting Started
|
2019-09-19 02:21:38 +08:00
|
|
|
|
|
|
|
|
### Requirements
|
|
|
|
|
|
2019-10-30 23:33:07 +08:00
|
|
|
- 64-bit host.
|
|
|
|
|
- At least 1GB of RAM.
|
|
|
|
|
- 2 cores or more are recommended (1 core works but not optimally).
|
2020-02-05 03:27:46 +08:00
|
|
|
- Secure connection over HTTPS or localhost (required for service workers and
|
|
|
|
|
clipboard support).
|
2019-10-30 23:33:07 +08:00
|
|
|
- For Linux: GLIBC 2.17 or later and GLIBCXX 3.4.15 or later.
|
2019-09-19 02:21:38 +08:00
|
|
|
|
2019-04-20 09:20:31 +08:00
|
|
|
### Run over SSH
|
2019-09-27 22:39:29 +08:00
|
|
|
|
2019-04-20 09:22:00 +08:00
|
|
|
Use [sshcode](https://github.com/codercom/sshcode) for a simple setup.
|
2019-04-20 09:20:31 +08:00
|
|
|
|
2019-09-13 23:17:27 +08:00
|
|
|
### Digital Ocean
|
2019-09-27 22:39:29 +08:00
|
|
|
|
2020-03-10 03:40:41 +08:00
|
|
|
[](https://marketplace.digitalocean.com/apps/code-server)
|
2019-09-13 23:17:27 +08:00
|
|
|
|
2020-02-27 05:33:13 +08:00
|
|
|
### Releases
|
2019-09-27 22:39:29 +08:00
|
|
|
|
2020-02-27 05:33:13 +08:00
|
|
|
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.
|
2019-08-09 00:21:45 +08:00
|
|
|
3. In your browser navigate to `localhost:8080`.
|
2019-01-08 08:46:19 +08:00
|
|
|
|
2020-02-19 08:07:01 +08:00
|
|
|
## FAQ
|
2019-10-24 00:49:05 +08:00
|
|
|
|
2020-02-19 08:07:01 +08:00
|
|
|
See [./doc/FAQ.md](./doc/FAQ.md).
|
2019-01-08 08:46:19 +08:00
|
|
|
|
2019-03-05 02:31:27 +08:00
|
|
|
## Enterprise
|
2019-09-27 22:39:29 +08:00
|
|
|
|
2019-11-15 01:16:08 +08:00
|
|
|
Visit [our enterprise page](https://coder.com) for more information about our
|
2020-02-19 08:07:01 +08:00
|
|
|
enterprise offerings.
|
