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