Update multi-editor feature status

As of 1.6.0, multi-editor was promoted from alpha to beta and many of
the aforementioned known issues have been addressed.

Further changes:

* A few md syntax style adjustments
This commit is contained in:
G r e y 2020-04-30 15:03:02 -05:00
parent 480d54105e
commit 0acabadd01
No known key found for this signature in database
GPG Key ID: 1B933BA64CF808BD
1 changed files with 18 additions and 19 deletions

View File

@ -7,7 +7,8 @@ Each directory contains examples for how to setup your images
with different IDEs.
## Multi Editor Support
*Multi Editor Support is currently in alpha, see [known issues](#known-issues) for more details.*
*Multi Editor Support is currently in beta, see [known issues](#known-issues) for more details.*
Coder Enterprise has full support for a wide range of editors including VSCode,
the JetBrains suite, Eclipse, and many more. These editors are run in the remote
@ -17,10 +18,12 @@ and feel of a native local application. This provides the best of both
worlds -- the security and productivity of remote infrastructure with the native look
and feel of the local machine.
### Installing an IDE into your docker image:
### Installing an IDE into your docker image
Installing an IDE into your image can be done using the same methods that you would
normally use when installing the IDE onto your local machine. Code-server is able to
find and start the following IDEs if their binaries exist in your PATH:
- intellij-idea-ultimate
- intellij-idea-community
- webstorm
@ -37,23 +40,26 @@ find and start the following IDEs if their binaries exist in your PATH:
- emacs
### Required Packages
The following packages are required in your image if you're using an IDE other than VSCode
to ensure that it can communicate properly with code-server.
| Deb Package | Rpm Package | Package Description |
|---|---|---|
| openssl | openssl | Secure Sockets Layer Toolkit |
| libxtst6 | libXtst | X11 Testing Library |
| libxrender1 | libXrender | X Rendering Extension Client Library |
| libfontconfig1 | fontconfig | Generic Font Configuration Library |
| libxi6 | libXi | X11 Input Extension Library |
| libgtk-3-0 | gtk3 | GTK+ Graphical User Interface Library |
| Deb Package | Rpm Package | Package Description |
| -------------- | ----------- | ------------------------------------- |
| openssl | openssl | Secure Sockets Layer Toolkit |
| libxtst6 | libXtst | X11 Testing Library |
| libxrender1 | libXrender | X Rendering Extension Client Library |
| libfontconfig1 | fontconfig | Generic Font Configuration Library |
| libxi6 | libXi | X11 Input Extension Library |
| libgtk-3-0 | gtk3 | GTK+ Graphical User Interface Library |
### How does IDE licensing work?
Licensing for IDEs running via code-server are licensed in the same way that they are
when running them on your local machine. If your IDE requires a license for use locally,
it will still require one when running it through code-server.
### What editors are known to work?
- VSCode
- IntelliJ IDEA Ultimate and Community editions
- WebStorm
@ -71,12 +77,5 @@ it will still require one when running it through code-server.
- MonoDevelop
### Known Issues
- Reconnects dont currently work, if your internet connection is unstable or goes out,
we recommend using the built in VSCode IDE until we can resolve this issue.
- Opening and closing an application many times can cause code-server to get into a broken
state. We recommend minimizing the opens and closes of a single application until were able
to resolve this.
- Resizing the application window too quickly can cause it to enter into an unexpected state.
Please resize slowly to ensure things work as expected.
- GTK based applications are not registering keyboard input successfully. We recommend using
non GTK based IDEs until we can resolve this issue.
- Currently, there are periodic latencies and performance dips