1
0
mirror of https://github.com/coder/code-server.git synced 2024-12-05 07:13:06 +08:00
code-server/README.md

54 lines
1.9 KiB
Markdown
Raw Normal View History

# code-server
2019-01-08 08:46:19 +08: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-01-08 08:46:19 +08:00
`code-server` is VS Code running on a remote server, accessible through the browser.
![Screenshot](/doc/assets/ide.png)
## Getting Started
[Try `code-server` now](https://coder.com/signup) for free at coder.com.
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
```
code-server <inital directory to open>
```
> You will be prompted to enter the password shown in the CLI
`code-server` should now be running at https://<IP>: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 08:46:19 +08:00
How to [secure your setup](/doc/security/ssl.md).
## Development
### Known Issues
- Debugging extensions doesnt work.
### 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
Guides on setup for development will be coming soon. :)
2019-01-08 08:46:19 +08:00
## License
2019-01-08 08:46:19 +08:00
[MIT](LICENSE)
2019-01-08 08:46:19 +08:00
## Enterprise
2019-01-08 08:46:19 +08:00
Visit [our enterprise page](https://coder.com/enterprise) for more information on our enterprise offering.