Skip to content

Commit 134040f

Browse files
committed
Update extensions section of readme
1 parent 65caa26 commit 134040f

File tree

1 file changed

+30
-7
lines changed

1 file changed

+30
-7
lines changed

README.md

+30-7
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
remote server, accessible through the browser.
55

66
Try it out:
7+
78
```bash
89
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
910
```
@@ -24,13 +25,15 @@ docker run -it -p 127.0.0.1:8080:8080 -v "${HOME}/.local/share/code-server:/home
2425
- Minimum GLIBC version of 2.17 and a minimum version of GLIBCXX of 3.4.15.
2526
- This is the main requirement for building Visual Studio Code. We cannot go lower than this.
2627
- 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.
2829
- Docker (for Docker versions of `code-server`).
2930

3031
### Run over SSH
32+
3133
Use [sshcode](https://github.com/codercom/sshcode) for a simple setup.
3234

3335
### Docker
36+
3437
See the Docker one-liner mentioned above. Dockerfile is at [/Dockerfile](/Dockerfile).
3538

3639
To debug Golang using the
@@ -40,18 +43,21 @@ arguments when launching code-server with Docker. See
4043
[#725](https://github.com/cdr/code-server/issues/725) for details.
4144

4245
### Digital Ocean
46+
4347
[![Create a Droplet](./doc/assets/droplet.svg)](https://marketplace.digitalocean.com/apps/code-server?action=deploy)
4448

4549
### Binaries
50+
4651
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)
4853
2. Unpack the downloaded file then run the binary.
4954
3. In your browser navigate to `localhost:8080`.
5055

5156
- For self-hosting and other information see [doc/quickstart.md](doc/quickstart.md).
5257
- For hosting on cloud platforms see [doc/deploy.md](doc/deploy.md).
5358

5459
### Build
60+
5561
- If you also plan on developing, set the `OUT` environment variable. Otherwise
5662
it will build in this directory which will cause issues because `yarn watch`
5763
will try to compile the build directory as well.
@@ -65,29 +71,41 @@ arguments when launching code-server with Docker. See
6571
code into a single binary.
6672

6773
## Known Issues
74+
6875
- Creating custom VS Code extensions and debugging them doesn't work.
6976
- Extension profiling and tips are currently disabled.
7077

7178
## Future
79+
7280
- **Stay up to date!** Get notified about new releases of code-server.
7381
![Screenshot](/doc/assets/release.gif)
7482
- Windows support.
7583
- Electron and Chrome OS applications to bridge the gap between local<->remote.
7684
- Run VS Code unit tests against our builds to ensure features work as expected.
7785

7886
## 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.
8499

85100
## Telemetry
101+
86102
Use the `--disable-telemetry` flag to completely disable telemetry. We use the
87103
data collected to improve code-server.
88104

89105
## Contributing
106+
90107
### Development
108+
91109
```shell
92110
git clone https://github.com/microsoft/vscode
93111
cd vscode
@@ -108,6 +126,7 @@ If you run into issues about a different version of Node being used, try running
108126
`vscode-ripgrep`.
109127

110128
### Upgrading VS Code
129+
111130
We patch VS Code to provide and fix some functionality. As the web portion of VS
112131
Code matures, we'll be able to shrink and maybe even entirely eliminate our
113132
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
118137
directory.
119138

120139
Our changes include:
140+
121141
- Change the remote schema to `code-server`.
122142
- Allow multiple extension directories (both user and built-in).
123143
- Modify the loader, websocket, webview, service worker, and asset requests to
@@ -132,12 +152,15 @@ Our changes include:
132152
- Modify the build process to include our code.
133153

134154
## License
155+
135156
[MIT](LICENSE)
136157

137158
## Enterprise
159+
138160
Visit [our enterprise page](https://coder.com/enterprise) for more information
139161
about our enterprise offering.
140162

141163
## Commercialization
164+
142165
If you would like to commercialize code-server, please contact
143166

0 commit comments

Comments
 (0)