|
| 1 | +# code-server · [](https://github.com/cdr/code-server/discussions) [](https://cdr.co/join-community) [](https://twitter.com/coderhq) |
| 2 | + |
| 3 | +[](https://codecov.io/gh/cdr/code-server) |
| 4 | +[](https://github.com/cdr/code-server/tree/v3.10.2/docs) |
| 5 | + |
| 6 | +Run [VS Code](https://github.com/Microsoft/vscode) on any machine anywhere and access it in the browser. |
| 7 | + |
| 8 | + |
| 9 | + |
| 10 | +## Highlights |
| 11 | + |
| 12 | +- Code on any device with a consistent development environment |
| 13 | +- Use cloud servers to speed up tests, compilations, downloads, and more |
| 14 | +- Preserve battery life when you're on the go; all intensive tasks run on your server |
| 15 | + |
| 16 | +## Requirements |
| 17 | + |
| 18 | +For a good experience, we recommend at least: |
| 19 | + |
| 20 | +- 1 GB of RAM |
| 21 | +- 2 cores |
| 22 | + |
| 23 | +You can use whatever linux distribution floats your boat but in our [guide](./guide.md) we assume Debian on Google Cloud. |
| 24 | + |
| 25 | +## Getting Started |
| 26 | + |
| 27 | +There are three ways you can get started: |
| 28 | + |
| 29 | +1. Using the [install script](https://github.com/cdr/code-server/blob/main/install.sh), which automates most of the process. The script uses the system package manager (if possible) |
| 30 | +2. Manually installing code-server; see [Installation](./install.md) for instructions applicable to most use cases |
| 31 | +3. Use our one-click buttons and guides to [deploy code-server to a popular cloud provider](https://github.com/cdr/deploy-code-server) ⚡ |
| 32 | + |
| 33 | +If you choose to use the install script, you can preview what occurs during the install process: |
| 34 | + |
| 35 | +```bash |
| 36 | +curl -fsSL https://code-server.dev/install.sh | sh -s -- --dry-run |
| 37 | +``` |
| 38 | + |
| 39 | +To install, run: |
| 40 | + |
| 41 | +```bash |
| 42 | +curl -fsSL https://code-server.dev/install.sh | sh |
| 43 | +``` |
| 44 | + |
| 45 | +When done, the install script prints out instructions for running and starting code-server. |
| 46 | + |
| 47 | +We also have an in-depth [setup and configuration](./guide.md) guide. |
| 48 | + |
| 49 | +### code-server --link |
| 50 | + |
| 51 | +We're working on a cloud platform that makes deploying and managing code-server easier. |
| 52 | +Consider running code-server with the beta flag `--link` if you don't want to worry about |
| 53 | + |
| 54 | +- TLS |
| 55 | +- Authentication |
| 56 | +- Port Forwarding |
| 57 | + |
| 58 | +```bash |
| 59 | +$ code-server --link |
| 60 | +Proxying code-server, you can access your IDE at https://valmar-jon.cdr.co |
| 61 | +``` |
| 62 | + |
| 63 | +## FAQ |
| 64 | + |
| 65 | +See [./FAQ.md](./FAQ.md). |
| 66 | + |
| 67 | +## Want to help? |
| 68 | + |
| 69 | +See [CONTRIBUTING](./CONTRIBUTING.md) for details. |
| 70 | + |
| 71 | +## Hiring |
| 72 | + |
| 73 | +Interested in [working at Coder](https://coder.com)? Check out [our open positions](https://jobs.lever.co/coder)! |
| 74 | + |
| 75 | +## For Organizations |
| 76 | + |
| 77 | +Visit [our website](https://coder.com) for more information about remote development for your organization or enterprise. |
0 commit comments