2020-02-19 00:07:01 +00:00
|
|
|
# code-server
|
2019-01-08 00:46:19 +00:00
|
|
|
|
2020-05-17 20:53:08 +00:00
|
|
|
Run [VS Code](https://github.com/Microsoft/vscode) on any machine anywhere and access it in the browser.
|
2019-03-06 01:45:21 +00:00
|
|
|
|
2020-05-17 20:53:08 +00:00
|
|
|
- **Code everywhere:** Code on your Chromebook, tablet, and laptop with a
|
2020-05-12 05:46:38 +00:00
|
|
|
consistent dev environment. Develop on a Linux machine and pick up from any
|
|
|
|
|
device with a web browser.
|
|
|
|
|
- **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 tasks runs on your server.
|
|
|
|
|
Make use of a spare computer you have lying around and turn it into a full development environment.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
2020-05-18 00:47:33 +00:00
|
|
|
## Getting Started
|
2020-05-12 05:46:38 +00:00
|
|
|
|
2020-05-17 20:53:08 +00:00
|
|
|
For a full setup and walkthrough, please see [./doc/guide.md](./doc/guide.md).
|
2020-05-12 05:46:38 +00:00
|
|
|
|
2020-05-20 16:13:03 +00:00
|
|
|
## Install
|
2019-09-27 14:39:29 +00:00
|
|
|
|
2020-05-20 16:13:03 +00:00
|
|
|
You can easily and securely install code-server with our install script.
|
2020-05-20 03:41:28 +00:00
|
|
|
|
|
|
|
|
```bash
|
2020-05-20 16:13:03 +00:00
|
|
|
# First run to print out the install process.
|
|
|
|
|
curl -sSL https://get.docker.com/ | sh -s -- --dry-run
|
|
|
|
|
# Now it will actually install.
|
|
|
|
|
curl -sSL https://get.docker.com/ | sh -s --
|
2020-05-20 03:41:28 +00:00
|
|
|
```
|
|
|
|
|
|
2020-05-20 16:13:03 +00:00
|
|
|
- For Debian, Ubuntu, Raspbian it will install the latest deb package.
|
|
|
|
|
- For Fedora, CentOS, RHEL, openSUSE it will install the latest rpm package.
|
|
|
|
|
- For Arch Linux it will install the AUR package.
|
|
|
|
|
- For any unrecognized Linux operating system it will install the latest static release into `/usr/local/lib/code-server-X.X.X`.
|
|
|
|
|
- For macOS it will install the Homebrew package.
|
|
|
|
|
- If Homebrew is not installed it will install the latest static release into `/usr/local/lib/code-server-X.X.X`.
|
2020-05-15 01:37:58 +00:00
|
|
|
|
2020-05-20 16:13:03 +00:00
|
|
|
If ran on an architecture with no binary releases, it will install the npm package with `yarn` or `npm`.
|
|
|
|
|
We only have binary releases for `amd64` and `arm64` presently.
|
2019-09-18 18:21:38 +00:00
|
|
|
|
2020-05-20 16:13:03 +00:00
|
|
|
If you still don't trust our install script, even with the above explaination and the dry run, we have
|
|
|
|
|
docs in [./doc/install.md](./doc/install.md) that explain how to install `code-server` each of the above
|
|
|
|
|
operating systems. The script runs the exact same commands.
|
2019-09-27 14:39:29 +00:00
|
|
|
|
2020-05-12 05:46:38 +00:00
|
|
|
### Docker
|
|
|
|
|
|
|
|
|
|
```bash
|
2020-05-15 02:01:45 +00:00
|
|
|
# This will start a code-server container and expose it at http://127.0.0.1:8080.
|
|
|
|
|
# It will also mount your current directory into the container as `/home/coder/project`
|
|
|
|
|
# and forward your UID/GID so that all file system operations occur as your user outside
|
|
|
|
|
# the container.
|
2020-05-15 01:57:10 +00:00
|
|
|
docker run -it -p 127.0.0.1:8080:8080 \
|
|
|
|
|
-v "$PWD:/home/coder/project" \
|
|
|
|
|
-u "$(id -u):$(id -g)" \
|
|
|
|
|
codercom/code-server:latest
|
2020-05-12 05:46:38 +00:00
|
|
|
```
|
|
|
|
|
|
2020-02-19 00:07:01 +00:00
|
|
|
## FAQ
|
2019-10-23 16:49:05 +00:00
|
|
|
|
2020-02-19 00:07:01 +00:00
|
|
|
See [./doc/FAQ.md](./doc/FAQ.md).
|
2019-01-08 00:46:19 +00:00
|
|
|
|
2020-03-19 21:53:31 +00:00
|
|
|
## Contributing
|
|
|
|
|
|
|
|
|
|
See [./doc/CONTRIBUTING.md](./doc/CONTRIBUTING.md).
|
|
|
|
|
|
2019-03-04 18:31:27 +00:00
|
|
|
## Enterprise
|
2019-09-27 14:39:29 +00:00
|
|
|
|
2020-05-17 21:57:59 +00:00
|
|
|
Visit [our website](https://coder.com) for more information about our
|
2020-02-19 00:07:01 +00:00
|
|
|
enterprise offerings.
|
