2020-02-19 00:07:01 +00:00
|
|
|
# code-server
|
2019-01-08 00:46:19 +00:00
|
|
|
|
2019-07-12 23:41:56 +00:00
|
|
|
`code-server` is [VS Code](https://github.com/Microsoft/vscode) running on a
|
|
|
|
remote server, accessible through the browser.
|
2019-03-06 01:45:21 +00:00
|
|
|
|
2019-03-07 02:59:43 +00:00
|
|
|
Try it out:
|
2019-09-27 14:39:29 +00:00
|
|
|
|
2019-03-07 02:59:43 +00:00
|
|
|
```bash
|
2020-01-27 18:16:58 +00:00
|
|
|
docker run -it -p 127.0.0.1:8080:8080 -v "$PWD:/home/coder/project" codercom/code-server
|
2019-03-07 02:59:43 +00:00
|
|
|
```
|
|
|
|
|
2019-07-31 22:08:37 +00:00
|
|
|
- **Consistent environment:** Code on your Chromebook, tablet, and laptop with a
|
2020-02-04 19:27:46 +00:00
|
|
|
consistent dev environment. Develop more easily for Linux if you have a
|
|
|
|
Windows or Mac and pick up where you left off when switching workstations.
|
2019-07-31 22:08:37 +00: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-04 18:31:27 +00:00
|
|
|
|
2020-02-19 00:07:01 +00:00
|
|
|
![Example gif](/doc/assets/ide.gif)
|
2020-02-04 19:27:46 +00:00
|
|
|
|
2019-03-04 18:31:27 +00:00
|
|
|
## Getting Started
|
2019-09-18 18:21:38 +00:00
|
|
|
|
|
|
|
### Requirements
|
|
|
|
|
2019-10-30 15:33:07 +00:00
|
|
|
- 64-bit host.
|
|
|
|
- At least 1GB of RAM.
|
|
|
|
- 2 cores or more are recommended (1 core works but not optimally).
|
2020-02-04 19:27:46 +00:00
|
|
|
- Secure connection over HTTPS or localhost (required for service workers and
|
|
|
|
clipboard support).
|
2019-10-30 15:33:07 +00:00
|
|
|
- For Linux: GLIBC 2.17 or later and GLIBCXX 3.4.15 or later.
|
2019-09-18 18:21:38 +00:00
|
|
|
|
2019-04-20 01:20:31 +00:00
|
|
|
### Run over SSH
|
2019-09-27 14:39:29 +00:00
|
|
|
|
2019-04-20 01:22:00 +00:00
|
|
|
Use [sshcode](https://github.com/codercom/sshcode) for a simple setup.
|
2019-04-20 01:20:31 +00:00
|
|
|
|
2019-09-13 15:17:27 +00:00
|
|
|
### Digital Ocean
|
2019-09-27 14:39:29 +00:00
|
|
|
|
2019-09-13 15:17:27 +00:00
|
|
|
[![Create a Droplet](./doc/assets/droplet.svg)](https://marketplace.digitalocean.com/apps/code-server?action=deploy)
|
|
|
|
|
2019-07-23 20:38:00 +00:00
|
|
|
### Binaries
|
2019-09-27 14:39:29 +00:00
|
|
|
|
2019-07-31 22:08:37 +00:00
|
|
|
1. [Download a binary](https://github.com/cdr/code-server/releases). (Linux and
|
2019-09-27 14:39:29 +00:00
|
|
|
OS X supported. Windows coming soon)
|
2019-07-23 20:38:00 +00:00
|
|
|
2. Unpack the downloaded file then run the binary.
|
2019-08-08 16:21:45 +00:00
|
|
|
3. In your browser navigate to `localhost:8080`.
|
2019-01-08 00:46:19 +00:00
|
|
|
|
2019-07-23 20:38:00 +00:00
|
|
|
- For self-hosting and other information see [doc/quickstart.md](doc/quickstart.md).
|
|
|
|
- For hosting on cloud platforms see [doc/deploy.md](doc/deploy.md).
|
2019-03-04 18:31:27 +00:00
|
|
|
|
2020-02-19 00:07:01 +00:00
|
|
|
## FAQ
|
2019-10-23 16:49:05 +00:00
|
|
|
|
2020-02-19 00:07:01 +00:00
|
|
|
See [./doc/FAQ.md](./doc/FAQ.md).
|
2019-01-08 00:46:19 +00:00
|
|
|
|
2019-03-04 18:31:27 +00:00
|
|
|
## Enterprise
|
2019-09-27 14:39:29 +00:00
|
|
|
|
2019-11-14 17:16:08 +00:00
|
|
|
Visit [our enterprise page](https://coder.com) for more information about our
|
2020-02-19 00:07:01 +00:00
|
|
|
enterprise offerings.
|