code-server/README.md

84 lines
3.1 KiB
Markdown
Raw Normal View History

# code-server
2019-01-08 00:46:19 +00:00
[!["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)](#)
2019-03-05 21:53:05 +00:00
[![Discord](https://discordapp.com/api/guilds/463752820026376202/widget.png)](https://discord.gg/zxSwN8Z)
2019-01-08 00:46:19 +00:00
2019-03-06 01:45:21 +00:00
`code-server` is [VS Code](https://github.com/Microsoft/vscode) running on a remote server, accessible through the browser.
2019-03-07 02:59:43 +00:00
Try it out:
```bash
2019-03-15 05:24:44 +00:00
docker run -t -p 127.0.0.1:8443:8443 -v "${PWD}:/root/project" codercom/code-server code-server --allow-http --no-auth
2019-03-07 02:59:43 +00:00
```
2019-03-06 01:45:21 +00:00
- 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.
2019-03-08 16:34:31 +00:00
- All intensive computation runs on your server.
2019-03-06 01:45:21 +00:00
- You're no longer running excess instances of Chrome.
![Screenshot](/doc/assets/ide.png)
## Getting Started
2019-03-07 02:59:43 +00:00
### Hosted
[Try `code-server` now](https://coder.com/signup) for free at coder.com.
2019-03-07 02:59:43 +00:00
### Docker
See docker oneliner mentioned above. Dockerfile is at [/Dockerfile](/Dockerfile).
### Binaries
2019-03-14 22:32:18 +00:00
1. [Download a binary](https://github.com/codercom/code-server/releases) (Linux and OS X supported. Windows coming soon)
2. Start the binary with the project directory as the first argument
```
2019-03-08 16:10:50 +00:00
code-server <initial directory to open>
```
> You will be prompted to enter the password shown in the CLI
2019-03-04 22:11:48 +00:00
`code-server` should now be running at https://localhost:8443.
> 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).
2019-01-08 00:46:19 +00:00
How to [secure your setup](/doc/security/ssl.md).
## Development
### Known Issues
- Creating custom VS Code extensions and debugging them doesn't work.
### Future
- Windows support.
2019-03-14 22:32:18 +00:00
- Electron and Chrome OS applications to bridge the gap between local<->remote.
- Run VS Code unit tests against our builds to ensure features work as expected.
### Notes
- At the moment we can't use the official VSCode Marketplace. We've created a custom extension marketplace focused around open-sourced extensions. However, if you have access to the `.vsix` file, you can manually install the extension.
## Contributing
2019-01-08 00:46:19 +00:00
2019-03-06 18:11:27 +00:00
Development guides are coming soon.
2019-01-08 00:46:19 +00:00
## License
2019-01-08 00:46:19 +00:00
[MIT](LICENSE)
2019-01-08 00:46:19 +00:00
## Enterprise
2019-01-08 00:46:19 +00:00
2019-03-06 18:11:27 +00:00
Visit [our enterprise page](https://coder.com/enterprise) for more information about our enterprise offering.
## Commercialization
If you would like to commercialize code-server, please contact contact@coder.com.