diff --git a/content/en/docs/workstation/client/wks-client-autostart.md b/content/en/docs/workstation/client/wks-client-autostart.md index 9a72da2c939..8f1de60fda9 100644 --- a/content/en/docs/workstation/client/wks-client-autostart.md +++ b/content/en/docs/workstation/client/wks-client-autostart.md @@ -21,6 +21,6 @@ For more information, refer to the documentation of your operating system, such ## Stopping the Workstation Client Manually {#stop-client} -The **Close** button closes the Client window but does not terminate the application; it continues to run in the background. To completely quit the Client, right-click its icon in the Windows systray and select **Quit**. This action is only available in [Developer Mode](/mendix-workstation/management-stations/#developer-mode). +The **Close** button closes the Client window but does not terminate the application. It continues to run in the background. To completely quit the Client, right-click its icon in the Windows systray and select **Quit**. This action is only available in [Developer Mode](/mendix-workstation/management-stations/#developer-mode). Alternatively, you can stop the Workstation Client process by using Windows Task Manager. diff --git a/content/en/docs/workstation/client/wks-client-installation.md b/content/en/docs/workstation/client/wks-client-installation.md index 8acb380878f..f2b1ada5361 100644 --- a/content/en/docs/workstation/client/wks-client-installation.md +++ b/content/en/docs/workstation/client/wks-client-installation.md @@ -60,7 +60,9 @@ If you have administrator rights for your Windows computer, install the Workstat For a silent installation, you can also run the installer as an administrator with the `/S` argument, that is, `MendixWorkstationX.Y.Z.exe /S`. -The default installation folder is *C:\Program Files\Mendix Workstation*. The app data folder can be found at *C:\ProgramData\Mendix Workstation*. The client runs automatically after the installation is completed. + The default installation folder is *C:\Program Files\Mendix Workstation*. The app data folder can be found at *C:\ProgramData\Mendix Workstation*. The client runs automatically after the installation is completed. + +4. After the installation finishes, start the Workstation Client. ### Windows Portable @@ -69,6 +71,7 @@ If you do not have administrator rights for your Windows computer, create a port 1. Download the [portable Microsoft Windows version of the installer](https://marketplace.mendix.com/link/component/247456). 2. As a best practice, create a new folder for the Client (for example, in your *Documents* folder). 3. Extract the Client to the target folder, and then click the *.exe* file to run the Client. +4. After the installation finishes, start the Workstation Client. ### Linux @@ -101,4 +104,19 @@ To install the Workstation Client on a Linux machine, perform the following step sudo capsh --user=$(whoami) --iab="^cap_net_raw" -- -c "'/opt/Mendix Workstation/Mendix Workstation'" ``` -The Workstation Client runs automatically at system startup. To modify this behavior, see [Autostart Configuration for the Workstation Client](/mendix-workstation/network-configuration/). \ No newline at end of file +6. After the installation finishes, start the Workstation Client. + +### MacOS + +To configure the Workstation Client on a macOS machine, perform the following steps: + +1. Download the [macOS version of the installer](https://marketplace.mendix.com/link/component/253905). +2. Double-click the installer to start the installation process. + + The macOS version of the Workstation Client is not yet notarized by Apple, so you will see a warning during the installation. For information about resolving the issue, see [Open a Mac app from an unknown developer](https://support.apple.com/guide/mac-help/open-a-mac-app-from-an-unknown-developer-mh40616/mac) in the macOS documentation. + +3. After the installation finishes, start the Workstation Client. + +## Stopping the Workstation Client + +The Workstation Client sets up the required auto-start settings during the first start. Afterward, it runs automatically on system startup. To change this behavior, see [Autostart Configuration for the Workstation Client](/mendix-workstation/autostart-configuration/) diff --git a/content/en/docs/workstation/client/wks-client-usage.md b/content/en/docs/workstation/client/wks-client-usage.md new file mode 100644 index 00000000000..8a889a383bf --- /dev/null +++ b/content/en/docs/workstation/client/wks-client-usage.md @@ -0,0 +1,40 @@ +--- +title: "Using the Workstation Client" +url: /mendix-workstation/use-client/ +description: "Describes how to use the Mendix Workstation Client." +weight: 30 +--- + +## Introduction + +This reference guide provides information about the menus and functionalities of the Workstation Client. + +## Overview + +The Workstation Client is an application installed on computers which you want to register as stations in Mendix Workstation. + +{{< figure src="/attachments/workstation/wks-client-use1.png" class="no-border" >}} + +## Basic Information + +The top section of the Workstation Client shows the following information: + +* The name and ID of the workspace where the Client is registered +* The ID of the computer where the Client is installed +* The ID of the station created for this computer in Workstation Management +* The date and time of the last update of this Workstation Client's configuration (for example, the list of devices associated with the Client) +* The currently installed version of the Client + +## Devices + +The **Devices** section shows a list of all devices currently associated with the station through this Workstation Client. For each device, the section shows the availability, connection status, and any errors captured for this device. You can also expand each device to see more information about its connection parameters (for example, the host or port of a TCP/IP server). + +## Additional Actions + +Click the **three dots** menu in the top right corner of the Workstation Client to perform any of the following actions: + +* **Refresh** - By default, the Workstation Client operates in auto-refresh mode. That is, any changes made to the configuration in Workstation Management are immediately reflected in the Client. If you [disabled the Client's auto-refresh in Workstation Management](/mendix-workstation/management-settings/#auto-refresh), you can use the **Refresh** option to manually refresh the Client's configuration. +* **Deregister** - When [Developer Mode](/mendix-workstation/management-stations/#developer-mode) is enabled, you can select this option to deregister the Client from Workstation Management. +* **Management** - Selecting this option opens the **Workstation Management** portal in your browser. +* **Logs** - This option shows the Workstation Client logs, which you can use to help you troubleshoot any issues. For more information, see [Troubleshooting the Workstation Client](/mendix-workstation/troubleshooting-workstation-client/). +* **Diagnostics** - When [Developer Mode](/mendix-workstation/management-stations/#developer-mode) is enabled, you can select this option to view information about the available devices, credentials, station configuration, system info, and log levels, which you can use to help you troubleshoot any issues. For more information, see [Troubleshooting the Workstation Client](/mendix-workstation/troubleshooting-workstation-client/). diff --git a/content/en/docs/workstation/management/wks-management-settings.md b/content/en/docs/workstation/management/wks-management-settings.md index 8f45eb640b5..28ed38e854a 100644 --- a/content/en/docs/workstation/management/wks-management-settings.md +++ b/content/en/docs/workstation/management/wks-management-settings.md @@ -43,7 +43,7 @@ Auto-refresh settings are available in Workstation Management at **Settings > Cl By default, the Workstation Client operates in auto-refresh mode. That is, any changes made to the configuration in Workstation Management are immediately reflected in the Client. -To change this behavior, set the **Auto-Refresh Mode** toggle to **Off**. You can then force the configuration to refresh by clicking **Refresh on Computer** in Workstation Management, or by clicking **Refresh** in the Workstation Client. +To change this behavior, change the **Auto-Refresh Mode** setting to **Off**. You can then force the configuration to refresh by clicking **Refresh on Computer** in Workstation Management, or by clicking **Refresh** in the Workstation Client. The **Check Interval** setting is only available when the auto-refresh mode is enabled. It specifies how often a Workstation Client that is disconnected due to a web socket failure should automatically refresh its configuration by polling Workstation Management. By default, this happens every 60 minutes. diff --git a/content/en/docs/workstation/troubleshooting/wks-troubleshooting-client.md b/content/en/docs/workstation/troubleshooting/wks-troubleshooting-client.md index 7f13f4f2872..780a7a34dcc 100644 --- a/content/en/docs/workstation/troubleshooting/wks-troubleshooting-client.md +++ b/content/en/docs/workstation/troubleshooting/wks-troubleshooting-client.md @@ -12,7 +12,7 @@ This document provides troubleshooting instructions for some potential issues re ### Logs -By default, the Client retains logs of up to 10 MB for the past seven days locally on your computer. Access logs by clicking the **Logs** button on the Client UI, then optionally selecting the level of logs you want to see. Opening the Client's console through the browser developer tools (**Ctrl + Shift + I**) can also provide additional information about encountered errors in the UI of the Client. +By default, the Client retains logs of up to 10 MB for the past seven days locally on your computer. To access the logs, open the Client and select the **Logs** option from the **three dots** menu in the top right corner, then optionally select the level of logs you want to see. Log files are also available by day in the Client's app data folder. On Windows, press **Win + R** and enter: @@ -92,4 +92,4 @@ The Client cannot resolve the URL to Workstation Management. This can have sever ### Solution -First, verify you have a working internet connection. Then verify you can access [Workstation Management](https://workstation.home.mendix.com/) from your browser. If your browser cannot resolve that address, there may be an issue with your DNS server or configuration. On Windows, verify your DNS settings for your Ethernet or wireless LAN adapter using the command prompt and entering `ipconfig`. The command `nslookup www.mendix.com` provides further information about the IP address your DNS server resolved for the Mendix domain. \ No newline at end of file +First, verify you have a working internet connection. Then verify you can access [Workstation Management](https://workstation.home.mendix.com/) from your browser. If your browser cannot resolve that address, there may be an issue with your DNS server or configuration. On Windows, verify your DNS settings for your Ethernet or wireless LAN adapter using the command prompt and entering `ipconfig`. The command `nslookup www.mendix.com` provides further information about the IP address your DNS server resolved for the Mendix domain. diff --git a/static/attachments/workstation/wks-client-use1.png b/static/attachments/workstation/wks-client-use1.png new file mode 100644 index 00000000000..176e92d7a2f Binary files /dev/null and b/static/attachments/workstation/wks-client-use1.png differ