4
4
remote server, accessible through the browser.
5
5
6
6
Try it out:
7
+
7
8
``` bash
8
9
docker 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
9
10
```
@@ -24,13 +25,15 @@ docker run -it -p 127.0.0.1:8080:8080 -v "${HOME}/.local/share/code-server:/home
24
25
- Minimum GLIBC version of 2.17 and a minimum version of GLIBCXX of 3.4.15.
25
26
- This is the main requirement for building Visual Studio Code. We cannot go lower than this.
26
27
- A 64-bit host with at least 1GB RAM and 2 cores.
27
- - 1 core hosts would work but not optimally.
28
+ - 1 core hosts would work but not optimally.
28
29
- Docker (for Docker versions of ` code-server ` ).
29
30
30
31
### Run over SSH
32
+
31
33
Use [ sshcode] ( https://github.com/codercom/sshcode ) for a simple setup.
32
34
33
35
### Docker
36
+
34
37
See the Docker one-liner mentioned above. Dockerfile is at [ /Dockerfile] ( /Dockerfile ) .
35
38
36
39
To debug Golang using the
@@ -40,18 +43,21 @@ arguments when launching code-server with Docker. See
40
43
[ #725 ] ( https://github.com/cdr/code-server/issues/725 ) for details.
41
44
42
45
### Digital Ocean
46
+
43
47
[ ![ Create a Droplet] ( ./doc/assets/droplet.svg )] ( https://marketplace.digitalocean.com/apps/code-server?action=deploy )
44
48
45
49
### Binaries
50
+
46
51
1 . [ Download a binary] ( https://github.com/cdr/code-server/releases ) . (Linux and
47
- OS X supported. Windows coming soon)
52
+ OS X supported. Windows coming soon)
48
53
2 . Unpack the downloaded file then run the binary.
49
54
3 . In your browser navigate to ` localhost:8080 ` .
50
55
51
56
- For self-hosting and other information see [ doc/quickstart.md] ( doc/quickstart.md ) .
52
57
- For hosting on cloud platforms see [ doc/deploy.md] ( doc/deploy.md ) .
53
58
54
59
### Build
60
+
55
61
- If you also plan on developing, set the ` OUT ` environment variable. Otherwise
56
62
it will build in this directory which will cause issues because ` yarn watch `
57
63
will try to compile the build directory as well.
@@ -65,29 +71,41 @@ arguments when launching code-server with Docker. See
65
71
code into a single binary.
66
72
67
73
## Known Issues
74
+
68
75
- Creating custom VS Code extensions and debugging them doesn't work.
69
76
- Extension profiling and tips are currently disabled.
70
77
71
78
## Future
79
+
72
80
- ** Stay up to date!** Get notified about new releases of code-server.
73
81
![ Screenshot] ( /doc/assets/release.gif )
74
82
- Windows support.
75
83
- Electron and Chrome OS applications to bridge the gap between local<->remote.
76
84
- Run VS Code unit tests against our builds to ensure features work as expected.
77
85
78
86
## Extensions
79
- At the moment we can't use the official VS Code Marketplace. We've created a
80
- custom extension marketplace focused around open-sourced extensions. However,
81
- you can manually download the extension to your extensions directory. It's also
82
- possible to set your own marketplace URLs by setting the ` SERVICE_URL ` and
83
- ` 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.
84
99
85
100
## Telemetry
101
+
86
102
Use the ` --disable-telemetry ` flag to completely disable telemetry. We use the
87
103
data collected to improve code-server.
88
104
89
105
## Contributing
106
+
90
107
### Development
108
+
91
109
``` shell
92
110
git clone https://github.com/microsoft/vscode
93
111
cd vscode
@@ -108,6 +126,7 @@ If you run into issues about a different version of Node being used, try running
108
126
` vscode-ripgrep ` .
109
127
110
128
### Upgrading VS Code
129
+
111
130
We patch VS Code to provide and fix some functionality. As the web portion of VS
112
131
Code matures, we'll be able to shrink and maybe even entirely eliminate our
113
132
patch. In the meantime, however, upgrading the VS Code version requires ensuring
@@ -118,6 +137,7 @@ the patch in the VS Code source, then run `yarn patch:generate` in this
118
137
directory.
119
138
120
139
Our changes include:
140
+
121
141
- Change the remote schema to ` code-server ` .
122
142
- Allow multiple extension directories (both user and built-in).
123
143
- Modify the loader, websocket, webview, service worker, and asset requests to
@@ -132,12 +152,15 @@ Our changes include:
132
152
- Modify the build process to include our code.
133
153
134
154
## License
155
+
135
156
[ MIT] ( LICENSE )
136
157
137
158
## Enterprise
159
+
138
160
Visit [ our enterprise page] ( https://coder.com/enterprise ) for more information
139
161
about our enterprise offering.
140
162
141
163
## Commercialization
164
+
142
165
If you would like to commercialize code-server, please contact
143
166
0 commit comments