1- # code-server & middot ; [ ![ MIT license ] ( https://img.shields.io/badge/license-MIT-blue.svg )] ( https://github.com/cdr/code-server/blob/master/LICENSE ) [ ![ "Latest Release" ] ( https://img.shields.io/github/release/cdr/code-server.svg )] ( https://github.com/cdr/code-server/releases/latest ) [ ![ Build Status ] ( https://img.shields.io/travis/com/cdr/code-server/master )] ( https://github.com/cdr/code-server )
1+ # code-server
22
33` code-server ` is [ VS Code] ( https://github.com/Microsoft/vscode ) running on a
44remote server, accessible through the browser.
@@ -16,12 +16,7 @@ docker run -it -p 127.0.0.1:8080:8080 -v "$PWD:/home/coder/project" codercom/cod
1616 compilations, downloads, and more. Preserve battery life when you're on the go
1717 since all intensive computation runs on your server.
1818
19- ![ Screenshot] ( /doc/assets/ide.gif )
20-
21- ## VS Code
22-
23- - See [ our VS Code readme] ( ./src/vscode ) for more information about how
24- code-server and VS Code work together.
19+ ![ Example gif] ( /doc/assets/ide.gif )
2520
2621## Getting Started
2722
@@ -33,16 +28,11 @@ docker run -it -p 127.0.0.1:8080:8080 -v "$PWD:/home/coder/project" codercom/cod
3328- Secure connection over HTTPS or localhost (required for service workers and
3429 clipboard support).
3530- For Linux: GLIBC 2.17 or later and GLIBCXX 3.4.15 or later.
36- - Docker (for Docker versions of ` code-server ` ).
3731
3832### Run over SSH
3933
4034Use [ sshcode] ( https://github.com/codercom/sshcode ) for a simple setup.
4135
42- ### Docker
43-
44- See the Docker one-liner mentioned above. Dockerfile is at [ /Dockerfile] ( /Dockerfile ) .
45-
4636### Digital Ocean
4737
4838[ ![ Create a Droplet] ( ./doc/assets/droplet.svg )] ( https://marketplace.digitalocean.com/apps/code-server?action=deploy )
@@ -57,87 +47,11 @@ See the Docker one-liner mentioned above. Dockerfile is at [/Dockerfile](/Docker
5747- For self-hosting and other information see [ doc/quickstart.md] ( doc/quickstart.md ) .
5848- For hosting on cloud platforms see [ doc/deploy.md] ( doc/deploy.md ) .
5949
60- ### Build
61-
62- - [ VS Code prerequisites] ( https://github.com/Microsoft/vscode/wiki/How-to-Contribute#prerequisites )
63-
64- ``` shell
65- yarn
66- yarn build
67- node build/out/entry.js # You can run the built JavaScript with Node.
68- yarn binary # Or you can package it into a binary.
69- ```
70-
71- If changes are made to the patch and you've built previously you must manually
72- reset VS Code then run ` yarn patch:apply ` .
73-
74- ## Security
75-
76- ### Authentication
77-
78- By default ` code-server ` enables password authentication using a randomly
79- generated password. You can set the ` PASSWORD ` environment variable to use your
80- own instead or use ` --auth none ` to disable password authentication.
81-
82- Do not expose ` code-server ` to the open internet without some form of
83- authentication.
84-
85- ### Encrypting traffic with HTTPS
86-
87- If you aren't doing SSL termination elsewhere you can directly give
88- ` code-server ` a certificate with ` code-server --cert ` followed by the path to
89- your certificate. Additionally, you can use certificate keys with ` --cert-key `
90- followed by the path to your key. If you pass ` --cert ` without any path
91- ` code-server ` will generate a self-signed certificate.
92-
93- If ` code-server ` has been passed a certificate it will also respond to HTTPS
94- requests and will redirect all HTTP requests to HTTPS. Otherwise it will respond
95- only to HTTP requests.
96-
97- You can use [ Let's Encrypt] ( https://letsencrypt.org/ ) to get an SSL certificate
98- for free.
50+ ## FAQ
9951
100- Do not expose ` code-server ` to the open internet without SSL, whether built-in
101- or through a proxy.
102-
103- ## Future
104-
105- - ** Stay up to date!** Get notified about new releases of ` code-server ` .
106- ![ Screenshot] ( /doc/assets/release.gif )
107- - Electron and Chrome OS applications to bridge the gap between local<->remote.
108-
109- ## Telemetry
110-
111- Use the ` --disable-telemetry ` flag to completely disable telemetry. We use the
112- data collected to improve code-server.
113-
114- ## Contributing
115-
116- ### Development
117-
118- - [ VS Code prerequisites] ( https://github.com/Microsoft/vscode/wiki/How-to-Contribute#prerequisites )
119-
120- ``` shell
121- yarn
122- yarn watch # Visit http://localhost:8080 once completed.
123- ```
124-
125- If you run into issues about a different version of Node being used, try running
126- ` npm rebuild ` in the VS Code directory.
127-
128- If changes are made to the patch and you've built previously you must manually
129- reset VS Code then run ` yarn patch:apply ` .
130-
131- ## License
132-
133- [ MIT] ( LICENSE )
52+ See [ ./doc/FAQ.md] ( ./doc/FAQ.md ) .
13453
13554## Enterprise
13655
13756Visit [ our enterprise page] ( https://coder.com ) for more information about our
138- enterprise offering.
139-
140- ## Commercialization
141-
142- If you would like to commercialize code-server, please contact
143- 57+ enterprise offerings.
0 commit comments