Update extensions section of readme
This commit is contained in:
parent
65caa26d40
commit
134040fea3
33
README.md
33
README.md
|
@ -4,6 +4,7 @@
|
||||||
remote server, accessible through the browser.
|
remote server, accessible through the browser.
|
||||||
|
|
||||||
Try it out:
|
Try it out:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
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
|
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
|
||||||
```
|
```
|
||||||
|
@ -28,9 +29,11 @@ docker run -it -p 127.0.0.1:8080:8080 -v "${HOME}/.local/share/code-server:/home
|
||||||
- Docker (for Docker versions of `code-server`).
|
- Docker (for Docker versions of `code-server`).
|
||||||
|
|
||||||
### Run over SSH
|
### Run over SSH
|
||||||
|
|
||||||
Use [sshcode](https://github.com/codercom/sshcode) for a simple setup.
|
Use [sshcode](https://github.com/codercom/sshcode) for a simple setup.
|
||||||
|
|
||||||
### Docker
|
### Docker
|
||||||
|
|
||||||
See the Docker one-liner mentioned above. Dockerfile is at [/Dockerfile](/Dockerfile).
|
See the Docker one-liner mentioned above. Dockerfile is at [/Dockerfile](/Dockerfile).
|
||||||
|
|
||||||
To debug Golang using the
|
To debug Golang using the
|
||||||
|
@ -40,9 +43,11 @@ arguments when launching code-server with Docker. See
|
||||||
[#725](https://github.com/cdr/code-server/issues/725) for details.
|
[#725](https://github.com/cdr/code-server/issues/725) for details.
|
||||||
|
|
||||||
### Digital Ocean
|
### Digital Ocean
|
||||||
|
|
||||||
[![Create a Droplet](./doc/assets/droplet.svg)](https://marketplace.digitalocean.com/apps/code-server?action=deploy)
|
[![Create a Droplet](./doc/assets/droplet.svg)](https://marketplace.digitalocean.com/apps/code-server?action=deploy)
|
||||||
|
|
||||||
### Binaries
|
### Binaries
|
||||||
|
|
||||||
1. [Download a binary](https://github.com/cdr/code-server/releases). (Linux and
|
1. [Download a binary](https://github.com/cdr/code-server/releases). (Linux and
|
||||||
OS X supported. Windows coming soon)
|
OS X supported. Windows coming soon)
|
||||||
2. Unpack the downloaded file then run the binary.
|
2. Unpack the downloaded file then run the binary.
|
||||||
|
@ -52,6 +57,7 @@ arguments when launching code-server with Docker. See
|
||||||
- For hosting on cloud platforms see [doc/deploy.md](doc/deploy.md).
|
- For hosting on cloud platforms see [doc/deploy.md](doc/deploy.md).
|
||||||
|
|
||||||
### Build
|
### Build
|
||||||
|
|
||||||
- If you also plan on developing, set the `OUT` environment variable. Otherwise
|
- If you also plan on developing, set the `OUT` environment variable. Otherwise
|
||||||
it will build in this directory which will cause issues because `yarn watch`
|
it will build in this directory which will cause issues because `yarn watch`
|
||||||
will try to compile the build directory as well.
|
will try to compile the build directory as well.
|
||||||
|
@ -65,10 +71,12 @@ arguments when launching code-server with Docker. See
|
||||||
code into a single binary.
|
code into a single binary.
|
||||||
|
|
||||||
## Known Issues
|
## Known Issues
|
||||||
|
|
||||||
- Creating custom VS Code extensions and debugging them doesn't work.
|
- Creating custom VS Code extensions and debugging them doesn't work.
|
||||||
- Extension profiling and tips are currently disabled.
|
- Extension profiling and tips are currently disabled.
|
||||||
|
|
||||||
## Future
|
## Future
|
||||||
|
|
||||||
- **Stay up to date!** Get notified about new releases of code-server.
|
- **Stay up to date!** Get notified about new releases of code-server.
|
||||||
![Screenshot](/doc/assets/release.gif)
|
![Screenshot](/doc/assets/release.gif)
|
||||||
- Windows support.
|
- Windows support.
|
||||||
|
@ -76,18 +84,28 @@ arguments when launching code-server with Docker. See
|
||||||
- Run VS Code unit tests against our builds to ensure features work as expected.
|
- Run VS Code unit tests against our builds to ensure features work as expected.
|
||||||
|
|
||||||
## Extensions
|
## Extensions
|
||||||
At the moment we can't use the official VS Code Marketplace. We've created a
|
|
||||||
custom extension marketplace focused around open-sourced extensions. However,
|
code-server does not provide access to the official
|
||||||
you can manually download the extension to your extensions directory. It's also
|
[Visual Studio Marketplace](https://marketplace.visualstudio.com/vscode). Instead,
|
||||||
possible to set your own marketplace URLs by setting the `SERVICE_URL` and
|
Coder has created a custom extension marketplace that we manage for open-source
|
||||||
`ITEM_URL` environment variables.
|
extensions. If you want to use an extension with code-server that we do not have
|
||||||
|
in our marketplace please look for a release in the extension’s repository,
|
||||||
|
contact us to see if we have one in the works or, if you build an extension
|
||||||
|
locally from open source, you can copy it to the `extensions` folder. If you
|
||||||
|
build one locally from open-source please contribute it to the project and let
|
||||||
|
us know so we can give you props! If you have your own custom marketplace, it is
|
||||||
|
possible to point code-server to it by setting the `SERVICE_URL` and `ITEM_URL`
|
||||||
|
environment variables.
|
||||||
|
|
||||||
## Telemetry
|
## Telemetry
|
||||||
|
|
||||||
Use the `--disable-telemetry` flag to completely disable telemetry. We use the
|
Use the `--disable-telemetry` flag to completely disable telemetry. We use the
|
||||||
data collected to improve code-server.
|
data collected to improve code-server.
|
||||||
|
|
||||||
## Contributing
|
## Contributing
|
||||||
|
|
||||||
### Development
|
### Development
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
git clone https://github.com/microsoft/vscode
|
git clone https://github.com/microsoft/vscode
|
||||||
cd vscode
|
cd vscode
|
||||||
|
@ -108,6 +126,7 @@ If you run into issues about a different version of Node being used, try running
|
||||||
`vscode-ripgrep`.
|
`vscode-ripgrep`.
|
||||||
|
|
||||||
### Upgrading VS Code
|
### Upgrading VS Code
|
||||||
|
|
||||||
We patch VS Code to provide and fix some functionality. As the web portion of VS
|
We patch VS Code to provide and fix some functionality. As the web portion of VS
|
||||||
Code matures, we'll be able to shrink and maybe even entirely eliminate our
|
Code matures, we'll be able to shrink and maybe even entirely eliminate our
|
||||||
patch. In the meantime, however, upgrading the VS Code version requires ensuring
|
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
|
||||||
directory.
|
directory.
|
||||||
|
|
||||||
Our changes include:
|
Our changes include:
|
||||||
|
|
||||||
- Change the remote schema to `code-server`.
|
- Change the remote schema to `code-server`.
|
||||||
- Allow multiple extension directories (both user and built-in).
|
- Allow multiple extension directories (both user and built-in).
|
||||||
- Modify the loader, websocket, webview, service worker, and asset requests to
|
- Modify the loader, websocket, webview, service worker, and asset requests to
|
||||||
|
@ -132,12 +152,15 @@ Our changes include:
|
||||||
- Modify the build process to include our code.
|
- Modify the build process to include our code.
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
[MIT](LICENSE)
|
[MIT](LICENSE)
|
||||||
|
|
||||||
## Enterprise
|
## Enterprise
|
||||||
|
|
||||||
Visit [our enterprise page](https://coder.com/enterprise) for more information
|
Visit [our enterprise page](https://coder.com/enterprise) for more information
|
||||||
about our enterprise offering.
|
about our enterprise offering.
|
||||||
|
|
||||||
## Commercialization
|
## Commercialization
|
||||||
|
|
||||||
If you would like to commercialize code-server, please contact
|
If you would like to commercialize code-server, please contact
|
||||||
contact@coder.com.
|
contact@coder.com.
|
||||||
|
|
Loading…
Reference in New Issue