Skip to content

Commit 75dba95

Browse files
committed
Revamp README.md with new installation options
1 parent 2e31e8f commit 75dba95

File tree

1 file changed

+73
-25
lines changed

1 file changed

+73
-25
lines changed

README.md

+73-25
Original file line numberDiff line numberDiff line change
@@ -1,47 +1,95 @@
11
# code-server
22

3-
`code-server` is [VS Code](https://github.com/Microsoft/vscode) running on a
4-
remote server, accessible through the browser.
3+
Run [VS Code](https://github.com/Microsoft/vscode) on any machine anywhere and access it through the browser.
54

6-
Try it out:
5+
- **Code anywhere:** Code on your Chromebook, tablet, and laptop with a
6+
consistent dev environment. Develop on a Linux machine and pick up from any
7+
device with a web browser.
8+
- **Server-powered:** Take advantage of large cloud servers to speed up tests, compilations, downloads, and more.
9+
Preserve battery life when you're on the go since all intensive tasks runs on your server.
10+
Make use of a spare computer you have lying around and turn it into a full development environment.
11+
12+
![Example gif](./doc/assets/code-server.gif)
13+
14+
## Quickstart
15+
16+
For a proper setup and walkthrough, please see [./doc/guide.md](./doc/guide.md).
17+
18+
### Debian, Ubuntu
719

820
```bash
9-
docker run -it -p 127.0.0.1:8080:8080 -v "$PWD:/home/coder/project" -u "$(id -u):$(id -g)" codercom/code-server:latest
21+
curl -sSOL https://github.com/cdr/code-server/releases/download/3.3.0/code-server-3.3.0-amd64.deb
22+
sudo dpkg -i code-server-3.3.0-linux_amd64.deb
23+
sudo systemctl enable code-server
24+
sudo systemctl start code-server
25+
# Now visit http://127.0.0.1:8080. Your password is in ~/.config/code-server/config.yaml
1026
```
1127

12-
- **Code anywhere:** Code on your Chromebook, tablet, and laptop with a
13-
consistent dev environment. Develop on a Linux machine and pick up from any
14-
device with a web browser.
15-
- **Server-powered:** Take advantage of large cloud servers to speed up tests,
16-
compilations, downloads, and more. Preserve battery life when you're on the go
17-
since all intensive computation runs on your server.
28+
## Fedora, Red Hat, SUSE
1829

19-
![Example gif](/doc/assets/code-server.gif)
30+
```bash
31+
curl -sSOL https://github.com/cdr/code-server/releases/download/3.3.0/code-server-3.3.0-amd64.rpm
32+
sudo dnf install code-server-3.3.0-amd64.rpm
33+
sudo systemctl enable code-server
34+
sudo systemctl start code-server
35+
# Now visit http://127.0.0.1:8080. Your password is in ~/.config/code-server/config.yaml
36+
```
2037

21-
## Getting Started
38+
### npm
2239

23-
### Requirements
40+
```bash
41+
npm install -g code-server
42+
code-server
43+
```
2444

25-
- 64-bit host.
26-
- At least 1GB of RAM.
27-
- 2 cores or more are recommended (1 core works but not optimally).
28-
- Secure connection over HTTPS or localhost (required for service workers and
29-
clipboard support).
30-
- For Linux: GLIBC 2.17 or later and GLIBCXX 3.4.15 or later.
45+
### macOS
3146

32-
### Run over SSH
47+
```bash
48+
brew install code-server
49+
code-server
50+
```
3351

34-
Use [sshcode](https://github.com/codercom/sshcode) for a simple setup.
52+
### SSH
53+
54+
You can use [sshcode](https://github.com/codercom/sshcode) to start and use code-server on any Linux machine over SSH.
55+
56+
```bash
57+
58+
# Downloads and installs code-server on dev.coder.com and opens it in a new browser window.
59+
```
3560

3661
### Digital Ocean
3762

3863
[![Create a Droplet](./doc/assets/droplet.svg)](https://marketplace.digitalocean.com/apps/code-server)
3964

40-
### Releases
65+
### Docker
66+
67+
```bash
68+
docker run -it -p 127.0.0.1:8080:8080 -v "$PWD:/home/coder/project" -u "$(id -u):$(id -g)" codercom/code-server:latest
69+
```
70+
71+
This will start a code-server container and expose it at http://127.0.0.1:8080. It will also mount
72+
your current directory into the container as `/home/coder/project` and forward your UID/GID so that
73+
all file system operations occur as your user outside the container.
74+
75+
### Self contained releases
76+
77+
We publish self contained archives for every release on [github](https://github.com/cdr/code-server/releases).
78+
They bundle the node binary and node_modules.
79+
80+
1. Download the latest release archive for your system from [github](https://github.com/cdr/code-server/releases)
81+
2. Unpack the release
82+
3. You can run code-server by executing `bin/code-server`
4183

42-
1. [Download a release](https://github.com/cdr/code-server/releases). (Linux and macOS supported. Windows support planned.)
43-
2. Unpack the downloaded release then run the included `code-server` script.
44-
3. In your browser navigate to `localhost:8080`.
84+
Add the code-server `bin` directory to your `$PATH` to easily execute it without the full path every time.
85+
86+
Here is an example script for installing and using a self-contained code-server release on Linux:
87+
88+
```bash
89+
curl -sSL https://github.com/cdr/code-server/releases/download/3.3.0/code-server-3.3.0-linux-amd64.tar.gz | sudo tar -C /opt -xz
90+
PATH="$PATH:/opt/code-server-3.3.0-linux-amd64/bin"
91+
code-server
92+
```
4593

4694
## FAQ
4795

0 commit comments

Comments
 (0)