code-server/README.md

59 lines
1.7 KiB
Markdown
Raw Normal View History

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