Skip to content
Snippets Groups Projects
Commit 5d230712 authored by Hampölz, Rene's avatar Hampölz, Rene
Browse files

docs(devcontainer): Add guide for connecting to the gui

parent 7ab74090
No related branches found
No related tags found
No related merge requests found
...@@ -12,6 +12,7 @@ ...@@ -12,6 +12,7 @@
- [File and function headers](#file-and-function-headers) - [File and function headers](#file-and-function-headers)
- [Building and debugging](#building-and-debugging) - [Building and debugging](#building-and-debugging)
- [Setting environment variables](#setting-environment-variables) - [Setting environment variables](#setting-environment-variables)
- [Connecting to Imhotep GUI](#connecting-to-imhotep-gui)
## Setup the dev container ## Setup the dev container
...@@ -122,3 +123,18 @@ RAND_SEED=1234 ...@@ -122,3 +123,18 @@ RAND_SEED=1234
``` ```
Now all random functions should return the same "random" value every time you debug your program. Now all random functions should return the same "random" value every time you debug your program.
### Connecting to Imhotep GUI
By default, the dev container forwards the port 50500 of your imhotep server to the host system so that the imhotep GUI can access your server. In most cases, the correct port number will be forwarded and the connection should work without any additional configuration.
However, if the standard port _(50500)_ is already in use by another process, the dev container will forward the imhotep server to a different port. In such cases, you will need to identify the correct port to establish a connection between server and GUI:
1. Make sure that your imhotep server is started and running in the dev container.
1. Open the "Ports View" by using the [command pallette](https://code.visualstudio.com/docs/getstarted/userinterface#_command-palette) _(Windows/Linux: <kbd>⌃ Ctrl</kbd>+<kbd>⇧ Shift</kbd>+<kbd>P</kbd>, MacOS: <kbd>⌘ Command</kbd>+<kbd>⇧ Shift</kbd>+<kbd>P</kbd>)_ and enter the command `Ports: Focus on Ports View`.
2. In the ports view, look for an entry under the "Running Process" column that contains a path to your `imhotep_server` program. This indicates that your imhotep server is running and that the port is being forwarded.
3. Within the same entry, you will find an address such as `localhost:62621` in the "Forwarded Address" column. The number after the colon (e.g. `62621`) is the correct port that you should use.
After opening the imhotep GUI, simply click on the port number "50500" and change it to the correct port.
> Note: The forwarded port may change over time depending on your system. If this happens, you may need to repeat the above steps to find the new port in order to establish a connection.
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment