44remote server, accessible through the browser.
55
66Try it out:
7+
78``` bash
89docker run -it -p 127.0.0.1:8080:8080 -v " ${HOME} /.local/share/code-server:/home/coder/.local/share/code-server" -v " $PWD :/home/coder/project" codercom/code-server:v2
910```
@@ -18,10 +19,21 @@ docker run -it -p 127.0.0.1:8080:8080 -v "${HOME}/.local/share/code-server:/home
1819![ Screenshot] ( /doc/assets/ide.gif )
1920
2021## Getting Started
22+
23+ ### Requirements
24+
25+ - Minimum GLIBC version of 2.17 and a minimum version of GLIBCXX of 3.4.15.
26+ - This is the main requirement for building Visual Studio Code. We cannot go lower than this.
27+ - A 64-bit host with at least 1GB RAM and 2 cores.
28+ - 1 core hosts would work but not optimally.
29+ - Docker (for Docker versions of ` code-server ` ).
30+
2131### Run over SSH
32+
2233Use [ sshcode] ( https://github.com/codercom/sshcode ) for a simple setup.
2334
2435### Docker
36+
2537See the Docker one-liner mentioned above. Dockerfile is at [ /Dockerfile] ( /Dockerfile ) .
2638
2739To debug Golang using the
@@ -31,18 +43,21 @@ arguments when launching code-server with Docker. See
3143[ #725 ] ( https://github.com/cdr/code-server/issues/725 ) for details.
3244
3345### Digital Ocean
46+
3447[ ![ Create a Droplet] ( ./doc/assets/droplet.svg )] ( https://marketplace.digitalocean.com/apps/code-server?action=deploy )
3548
3649### Binaries
50+
37511 . [ Download a binary] ( https://github.com/cdr/code-server/releases ) . (Linux and
38- OS X supported. Windows coming soon)
52+ OS X supported. Windows coming soon)
39532 . Unpack the downloaded file then run the binary.
40543 . In your browser navigate to ` localhost:8080 ` .
4155
4256- For self-hosting and other information see [ doc/quickstart.md] ( doc/quickstart.md ) .
4357- For hosting on cloud platforms see [ doc/deploy.md] ( doc/deploy.md ) .
4458
4559### Build
60+
4661- If you also plan on developing, set the ` OUT ` environment variable. Otherwise
4762 it will build in this directory which will cause issues because ` yarn watch `
4863 will try to compile the build directory as well.
@@ -56,29 +71,41 @@ arguments when launching code-server with Docker. See
5671 code into a single binary.
5772
5873## Known Issues
74+
5975- Creating custom VS Code extensions and debugging them doesn't work.
6076- Extension profiling and tips are currently disabled.
6177
6278## Future
79+
6380- ** Stay up to date!** Get notified about new releases of code-server.
6481 ![ Screenshot] ( /doc/assets/release.gif )
6582- Windows support.
6683- Electron and Chrome OS applications to bridge the gap between local<->remote.
6784- Run VS Code unit tests against our builds to ensure features work as expected.
6885
6986## Extensions
70- At the moment we can't use the official VS Code Marketplace. We've created a
71- custom extension marketplace focused around open-sourced extensions. However,
72- you can manually download the extension to your extensions directory. It's also
73- possible to set your own marketplace URLs by setting the ` SERVICE_URL ` and
74- ` ITEM_URL ` environment variables.
87+
88+ code-server does not provide access to the official
89+ [ Visual Studio Marketplace] ( https://marketplace.visualstudio.com/vscode ) . Instead,
90+ Coder has created a custom extension marketplace that we manage for open-source
91+ extensions. If you want to use an extension with code-server that we do not have
92+ in our marketplace please look for a release in the extension’s repository,
93+ contact us to see if we have one in the works or, if you build an extension
94+ locally from open source, you can copy it to the ` extensions ` folder. If you
95+ build one locally from open-source please contribute it to the project and let
96+ us know so we can give you props! If you have your own custom marketplace, it is
97+ possible to point code-server to it by setting the ` SERVICE_URL ` and ` ITEM_URL `
98+ environment variables.
7599
76100## Telemetry
101+
77102Use the ` --disable-telemetry ` flag to completely disable telemetry. We use the
78103data collected to improve code-server.
79104
80105## Contributing
106+
81107### Development
108+
82109``` shell
83110git clone https://github.com/microsoft/vscode
84111cd vscode
@@ -99,6 +126,7 @@ If you run into issues about a different version of Node being used, try running
99126` vscode-ripgrep ` .
100127
101128### Upgrading VS Code
129+
102130We patch VS Code to provide and fix some functionality. As the web portion of VS
103131Code matures, we'll be able to shrink and maybe even entirely eliminate our
104132patch. In the meantime, however, upgrading the VS Code version requires ensuring
@@ -109,6 +137,7 @@ the patch in the VS Code source, then run `yarn patch:generate` in this
109137directory.
110138
111139Our changes include:
140+
112141- Change the remote schema to ` code-server ` .
113142- Allow multiple extension directories (both user and built-in).
114143- Modify the loader, websocket, webview, service worker, and asset requests to
@@ -123,12 +152,15 @@ Our changes include:
123152- Modify the build process to include our code.
124153
125154## License
155+
126156[ MIT] ( LICENSE )
127157
128158## Enterprise
159+
129160Visit [ our enterprise page] ( https://coder.com/enterprise ) for more information
130161about our enterprise offering.
131162
132163## Commercialization
164+
133165If you would like to commercialize code-server, please contact
134166contact@coder.com .
0 commit comments