Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 28 additions & 5 deletions docs/docs/v2/dashboardAnatomy/040-statusIndicators.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,16 +9,39 @@ description: "Summary of sudoSignals status indicators"

Below is a summary of all statuses available in the sudoSignals client and dashboard.

## Installation Indicators

| Indicator | Status | Description |
|:------------------------|:----------------| :---------------|
|![Status Initializing](/img/status-indicators/v2-status-initializing.png) | Initializing |Initial status for clients/machines that have yet to be connected to the sudoSignals web dashboard, and installations that do not have any machines.|
|![Status Running](/img/status-indicators/v2-status-running.png) | Running |For processes that are being successfully being controlled by sudoSignals, but that are not using a plugin.|
|![Status Disconnected](/img/status-indicators/v2-status-disconnected.png) | Disconnected |Initial status for sudoSignals clients have yet to be connected to the sudoSignals web dashboard. |
|![Status Connected](/img/status-indicators/v2-status-connected.png) | Connected |Status to show that the sudoSignals desktop client is connected to the web dashbaord. |


## Installation Indicators

| Indicator | Status | Description |
|:------------------------|:----------------| :---------------|
|![Status Initializing](/img/status-indicators/v2-status-initializing.png) | Initializing |Initial status for installations that do not have any machines.|
|![Status Installation Online](/img/status-indicators/v2-status-installation-online.png) | Installation Online |Indicates that an installation is online and connected to the sudoSignals client. Installations with online status indicate that all sub-processes and machines are also `online`.|
|![Status Machine Online](/img/status-indicators/v2-status-machine-online.png) | Machine Online |Indicates that the machine is online and connected to the sudoSignals client. |
|![Status Process Online](/img/status-indicators/v2-status-online.png) | Process Online |Indicates that the process is online and connected to the sudoSignals client. |
|![Status Installation Warning](/img/status-indicators/v2-status-installation-warning.png) | Installation Warning | Indicates that some of an installation's machines or it's processes may be offline.|
|![Status Machine Warning](/img/status-indicators/v2-status-machine-warning.png) | Machine Warning |For machines, a `warning` status indicates that some of it's processes may be offline. |
|![Status Installation Offline](/img/status-indicators/v2-status-installation-offline.png) | Installation Offline |Indicates that an installation is disconnected. For installations, the `offline` status means that all sub-processes are offline.|
|![Status Unknown](/img/status-indicators/v2-status-unknown.png) | Unknown |For unspecified behavior in processes, machines or installations.|

## Machine Indicators

| Indicator | Status | Description |
|:------------------------|:----------------| :---------------|
|![Status Initializing](/img/status-indicators/v2-status-initializing.png) | Initializing |Initial status for machines that have yet to be connected to the sudoSignals web dashboard.|
|![Status Machine Online](/img/status-indicators/v2-status-machine-online.png) | Machine Online |Indicates that the machine is online and connected to the sudoSignals client. |
|![Status Machine Warning](/img/status-indicators/v2-status-machine-warning.png) | Machine Warning |For machines, a `warning` status indicates that some of it's processes may be offline. |
|![Status Machine Offline](/img/status-indicators/v2-status-machine-offline.png) | Machine Offline |Indicates that the machine may be disconnected. |
|![Status Unknown](/img/status-indicators/v2-status-unknown.png) | Unknown |For unspecified behavior in processes, machines or installations.|

## Process Indicators

| Indicator | Status | Description |
|:------------------------|:----------------| :---------------|
|![Status Running](/img/status-indicators/v2-status-running.png) | Running |For processes that are being successfully being controlled by sudoSignals, but that are not using a plugin.|
|![Status Process Online](/img/status-indicators/v2-status-online.png) | Process Online |Indicates that the process is online and connected to the sudoSignals client. |
|![Status Process Offline](/img/status-indicators/v2-status-offline.png) | Process Offline |Indicates that the process may be disconnected. |
|![Status Unknown](/img/status-indicators/v2-status-unknown.png) | Unknown |For unspecified behavior in processes, machines or installations.|
14 changes: 7 additions & 7 deletions docs/docs/v2/gettingStarted/030-installSignals.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,19 +41,19 @@ First click the link for **More info**, and then click **Run anyway**

You should then see the Welcome window of the Setup Wizard; begin the installation process by clicking `Next.`

![Install Signals 003](/img/windows-installer/install-signals-003.png)
![Install Signals 003](/img/windows-installer/v2-install-signals-003.png)

### Accept the EULA

Signals has an end user licensing agreement, mark that you accept the agreement and then click `Next.`

![Install Signals 004](/img/windows-installer/install-signals-004.png)
![Install Signals 004](/img/windows-installer/v2-install-signals-004.png)

### Select Installation Location

By default sudoSignals is installed in `Program Files(x86)\SudoSignals`

![Install Signals 005](/img/windows-installer/install-signals-005.png)
![Install Signals 005](/img/windows-installer/v2-install-signals-005.png)

### Additional Settings

Expand All @@ -64,20 +64,20 @@ There are some additional settings you can adjust when installing sudoSignals.
- [ ] Remove beta config files - if you were a beta tester it is important to check this box
- [ ] Remove old configuration files - if you're installing a major Signals release this is an important box to check

![Install Signals 006](/img/windows-installer/install-signals-006.png)
![Install Signals 006](/img/windows-installer/v2-install-signals-006.png)


### Install

Review the installer's settings and if everything looks correct, you can begin the installation process by clicking `Install`.

![Install Signals 007](/img/windows-installer/install-signals-007.png)
![Install Signals 007](/img/windows-installer/v2-install-signals-007.png)

### Finish

You can complete the Setup Wizard by clicking `Finish`. By default sudoSignals is configured to launch when installation is complete.

![Install Signals 008](/img/windows-installer/install-signals-008.png)
![Install Signals 008](/img/windows-installer/v2-install-signals-008.png)


## Finding Signals
Expand All @@ -86,4 +86,4 @@ If you've selected the `Create a desktop shortcut` option during setup, you can

sudoSignals also includes a system tray icon. When sudoSignals is running you should see a system tray icon.

![Sys tray icon 009](/img/windows-installer/install-signals-009.png)
![Sys tray icon 009](/img/windows-installer/v2-install-signals-009.png)
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,8 @@ Advanced process options are optional and not required for sudoSignals to monito

:::

## Working Directory File
## Working Directory
The Working Directory field allows you to specify the execution directory for your selected file and program. This may be especially important if you are launching a project that's written in Python or NodeJS.

## Command Line Preview

Expand Down
Binary file modified docs/static/img/client-configuration/v2-client-config-001.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/static/img/client-configuration/v2-client-config-002.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/static/img/client-configuration/v2-client-config-003.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/static/img/client-configuration/v2-client-config-004.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/static/img/client-configuration/v2-client-profile-001.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/static/img/client-configuration/v2-client-profile-002.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/static/img/client-configuration/v2-client-profile-003.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/static/img/client-configuration/v2-client-profile-004.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/static/img/client-configuration/v2-client-profile-004A.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/static/img/client-configuration/v2-client-profile-005.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.