You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs-sources/installing.md
+14-15Lines changed: 14 additions & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,4 @@
1
1
2
-
## Installing
3
-
4
2
{$product.name$} can be installed on top of Visual Studio Code or Eclipse Theia.
5
3
6
4
The latest version of {$product.name$} is available on the [Visual Studio Marketplace](https://marketplace.visualstudio.com/items?itemName=secure-dev-ops.code-realtime-ce) and on the [Open VSX Registry](https://open-vsx.org/extension/secure-dev-ops/code-realtime-ce). To install that version into Visual Studio Code or Eclipse Theia follow these steps:
@@ -23,7 +21,7 @@ The screenshot above also shows that an extension for working with C/C++ has bee
23
21
24
22
After you have installed {$product.name$} it's recommended to restart Visual Studio Code or Eclipse Theia, or at least to perform the command `Developer: Reload Window` which is available in the Command Palette (++ctrl+shift+"P"++).
25
23
26
-
###Install from VSIX
24
+
## Install from VSIX
27
25
Another way to install {$product.name$} is to use a .vsix file. This can be useful if you want to install another version than the latest. You can download .vsix files for all released versions of {$product.name$} from both the [Visual Studio Marketplace](https://marketplace.visualstudio.com/items?itemName=secure-dev-ops.code-realtime-ce) and the [Open VSX Registry](https://open-vsx.org/extension/secure-dev-ops/code-realtime-ce) (click "Version History"). Once you have downloaded the .vsix file follow these steps to install it:
28
26
29
27
1) If you already have a version of {$product.name$} installed, you can manually uninstall it first (see [Uninstalling](#uninstalling)). Note that this step is usually not required since the newly installed version of the extension will automatically replace the old one.
@@ -42,18 +40,19 @@ If instead the installation fails, this message will tell you the reason. One co
42
40
43
41
It should also be noted that it's possible to directly install any published version of {$product.name$} by using the "Install Another Version" command that is available in the context menu of an extension shown in the "Installed" section.
44
42
45
-
###Install from Docker Image
46
-
Yet another way to install {$product.name$} is to use the Docker image that is available on [DockerHub](https://hub.docker.com/r/baravich/theia-code-realtime). This image contains Eclipse Theia with the latest version of {$product.name$} installed. Run the docker image using this command:
43
+
## Install from Docker Image
44
+
Yet another way to install {$product.name$} is to use one of the Docker images that are available on DockerHub:
47
45
48
-
`docker run -p <host-port>:<container-port> -e isDocker=true baravich/theia-code-realtime:1.0`
46
+
***{$product.name$} on Visual Studio Code**[https://hub.docker.com/r/baravich/vscode-code-realtime](https://hub.docker.com/r/baravich/vscode-code-realtime)
47
+
***{$product.name$} on Eclipse Theia**[https://hub.docker.com/r/baravich/theia-code-realtime](https://hub.docker.com/r/baravich/theia-code-realtime)
49
48
50
-
Replace `<host-port>` with a port that is available on your computer, and `<container-port>` with the port you want the Docker container to use. For example, if you run this command
49
+
Here is an example of a command to use for running one of these Docker images:
51
50
52
-
`docker run -p 4000:3000 -e isDocker=true baravich/theia-code-realtime:1.0`
51
+
`docker run -p 4000:3000 -e isDocker=true baravich/vscode-code-realtime`
53
52
54
-
then after less than a minute you can access {$product.name$} from a web browser at [http://localhost:4000](http://localhost:4000).
53
+
The first port number should be a port that is available on your computer, and the second port number specifies the port used by the Docker container. With the command used above you can, a couple of minutes later, access {$product.name$} from a web browser at [http://localhost:4000](http://localhost:4000).
55
54
56
-
###Viewing Installation Information
55
+
## Viewing Installation Information
57
56
If you are unsure about which version of {$product.name$} you have installed, you can see the version in the extension's tooltip, and the full build version is available in the page that appears if you double-click the extension:
58
57
59
58

@@ -62,13 +61,13 @@ You can also see the version and the exact date of the installed {$product.name$
62
61
63
62

64
63
65
-
###Portable Mode Installation
64
+
## Portable Mode Installation
66
65
You can install multiple versions of {$product.name$} by using the portable mode of Visual Studio Code. See [Portable Mode](https://code.visualstudio.com/docs/editor/portable) for how to install Visual Studio Code in portable mode, which will allow you to install a version of {$product.name$} that won't affect other Visual Studio Code installations on the machine. Portable mode also allows to move or copy an installation from one machine to another, which makes it useful in scenarios where installs should be centralized in an organization.
67
66
68
-
###Post-Installation Configuration
67
+
## Post-Installation Configuration
69
68
After a successful installation you need to perform a few configuration steps before you can start to use {$product.name$}.
70
69
71
-
####Setup Java
70
+
### Setup Java
72
71
{$product.name$} uses a Java language server and hence needs a Java Virtual Machine (JVM). It's required to use a JVM for Java 17 or newer. If an appropriate JVM cannot be found when the {$product.name$} extension is activated (which for example happens the first time you open an Art file), you will receive an error message.
73
72
74
73
{$product.name$} follows the steps below in priority order when it looks for an appropriate JVM to use:
@@ -93,12 +92,12 @@ When the {$product.name$} extension is activated information about which Java th
93
92
94
93
Here you will also see if the launching of the language server for some reason failed.
95
94
96
-
####Setup C++ Build Tools
95
+
### Setup C++ Build Tools
97
96
When {$product.name$} builds generated C++ code it uses C++ build tools such as a make tool, a C++ compiler, a C++ linker etc. These tools need to be in the path when you start Visual Studio Code or Eclipse Theia. If you have multiple C++ build tools installed, make sure the correct ones are present in the path before launching Visual Studio Code or Eclipse Theia. For example, if you use the Microsoft C++ compiler, it's recommended to launch from a Visual Studio native tools command prompt with the correct version (e.g. 32 bit or 64 bit). Build errors caused by inconsistent versions of C++ build tools being used can be tricky to find.
98
97
99
98
You also need to install an extension for C/C++ development into Visual Studio Code or Eclipse Theia. Even if you can use any such extension, {$product.name$} provides the best integration with either [C/C++ for Visual Studio Code](https://code.visualstudio.com/docs/languages/cpp) or [clangd](https://clangd.llvm.org/).
0 commit comments