Update README.md
This commit is contained in:
parent
84158c89b7
commit
0f96b898c8
79
README.md
79
README.md
|
@ -6,80 +6,5 @@ the Multi Editor Support built into Coder Enterprise.
|
|||
Each directory contains examples for how to setup your images
|
||||
with different IDEs.
|
||||
|
||||
## Multi Editor Support
|
||||
|
||||
*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
|
||||
environment and rendered directly in the browser. The multi editor support is
|
||||
bundled with a window management system to give the application the look
|
||||
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 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
|
||||
- eclipse
|
||||
- goland
|
||||
- pycharm
|
||||
- phpstorm
|
||||
- clion
|
||||
- rider
|
||||
- rubymine
|
||||
- datagrip
|
||||
- oni
|
||||
- monodevelop
|
||||
- emacs
|
||||
- jupyter
|
||||
|
||||
### Required Packages
|
||||
The `which` utility is required in your image in order for code-server to search
|
||||
for installed editors within your image.
|
||||
|
||||
The following additional packages are required in your image if you're using an IDE other
|
||||
than VSCode or Jupyter to ensure proper communication 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 |
|
||||
|
||||
### 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
|
||||
- Eclipse - [GTK Based](#known-issues)
|
||||
- PyCharm
|
||||
- GoLand
|
||||
- PhpStorm
|
||||
- RubyMine
|
||||
- CLion
|
||||
- Rider
|
||||
- DataGrip
|
||||
- Emacs
|
||||
- Vim
|
||||
- Oni
|
||||
- MonoDevelop
|
||||
- Jupyter
|
||||
|
||||
### Known Issues
|
||||
|
||||
- Currently, there are periodic latencies and performance dips
|
||||
See our [documentation at our Enterprise Hub](https://enterprise.coder.com/docs/multi-editor) for additional information
|
||||
about supported editors and known issues.
|
||||
|
|
Loading…
Reference in New Issue