On Windows, the regular PowerShell can be used. On macOS and Linux, you need PowerShell Core 6.0:
- PowerShell Core 6.0
To launch a PowerShell Core terminal, use the pwsh
command.
The Wayk Den PowerShell module is available on PSGallery.
Install-Module -Name WaykNow
Import-Module WaykNow
If you encounter issues with the Install-Module
command, you may have to install or update PowerShellGet.
You can then list all commands exported from the WaykNow
module:
Get-Command -Module WaykNow
From PowerShell, clone the WaykNow-ps git repository, then import the module from the "WaykNow" directory.
git clone https://github.com/Devolutions/WaykNow-ps
Import-Module "./WaykNow-ps/WaykNow" -Force
The Install-WaykNow
and Uninstall-WaykNow
commands can be used to install, update and uninstall Wayk Now on all platforms. On Windows, the PowerShell console must have elevated rights to perform the installation. On macOS and Linux, sudo will be called to elevate permissions when necessary.
Here is a sample installation, update check and uninstall for macOS:
PS ~/WaykNow-ps> Install-WaykNow
Installing Wayk Now 3.3.2
Downloading https://cdn.devolutions.net/download/Mac/Wayk/3.3.2.0/Wayk.Mac.3.3.2.0.dmg
Password:
PS ~/WaykNow-ps> Install-WaykNow
Wayk Now is already up to date
PS ~/WaykNow-ps> Uninstall-WaykNow
By default, the Install-WaykNow
skips the installation if the local Wayk Now version is the same as the latest one available, unless the -Force
parameter is used.
The -Version
optional parameter can be used to force using a specific version of Wayk Now instead of the latest one.
The Get-WaykNowVersion
command detects the current Wayk Now installation version number.
PS ~/WaykNow-ps> Get-WaykNowVersion
3.3.2
The Get-WaykNowPackage
command discovers the latest Wayk Now version available and the corresponding download URL.
An optional parameter -Version
is available if you want to see an older version of Wayk Now.
PS ~/WaykNow-ps> Get-WaykNowPackage
Url Version
--- -------
https://cdn.devolutions.net/download/Mac/Wayk/3.3.2.0/Wayk.Mac.3.3.2.0.dmg 3.3.2
The Start-WaykNow
, Stop-WaykNow
and Restart-WaykNow
commands can be used to start, stop and restart all Wayk Now executables and services correctly. This can be particularly useful with the Windows system service.
This is an experimental feature for Windows that has been prototyped as part of this PowerShell cmdlet. It will likely be rewritten and integrated directly in the main Wayk Now software at some point in the future.
Starting from a regular Windows boot environment (not safe mode), open an administrative PowerShell console and use the Set-WaykNowSafeMode
command. This will create a copy of the current boot entry, rename it to "Wayk Now Safe Mode", and set it as the default. A copy of the original boot entry name is saved in the registry to allow reverting to the original state.
You can not reboot the system (Restart-Computer
or shutdown /r
), and it will automatically select the "Wayk Now Safe Mode" boot entry. Once the system is booted, you should be able to connect to it with Wayk Now.
To revert to the original state, open a PowerShell console again, but use the Reset-WaykNowSafeMode
command. This will set the original boot entry as the default, and delete the special "Wayk Now Safe Mode". You can now restart the computer again and it will boot in its regular state.
The Get-WaykNowInfo
command returns information about the differents WaykNow paths
PS ~/WaykNow-ps> Get-WaykNowInfo
DataPath : C:/Users/User/AppData/Roaming/Wayk
GlobalDataPath : C:/ProgramData/Wayk/WaykNow.cfg
ConfigFile : C:/Users/User/AppData/Roaming/Wayk/WaykNow.cfg
LogPath : C:/Users/User/AppData/Roaming/Wayk/logs
CertificateFile : C:/Users/User/AppData/Roaming/Wayk/WaykNow.crt
PrivateKeyFile : C:/Users/User/AppData/Roaming/Wayk/WaykNow.key
PasswordVault : C:/Users/User/AppData/Roaming/Wayk/WaykNow.vault
KnownHostsFile : C:/Users/User/AppData/Roaming/Wayk/known_hosts
BookmarksFile : C:/Users/User/AppData/Roaming/Wayk/bookmarks
The Set-WaykNowConfig
command, is used for modfy multiple settings from WaykNow.
Here is a list of properties that you can modify:
With Windows you can set the global settings or the local settings, by default the local setting is used, if you want to use the global settings in you command add this flag:
PS ~/WaykNow-ps> Set-WaykNowConfig -Global
The Get-WaykNowConfig
command returns the list of configurations from WaykNow
PS ~/WaykNow-ps> Get-WaykNowConfig
FriendlyName : david
Language : en
ControlMode : AllowRemoteControlSeverOnly
AutoLaunchOnUserLogon : False
ShowMainWindowOnLaunch : True
MinimizeToNotificationArea : False
ElevationPrompt : False
AllowPersonalPassword : True
AllowSystemAuth : True
AllowNoPassword : True
PersonalPasswordType : Generated
PersonalPassword : 52gk8z
GeneratedPasswordLength : 6
GeneratedPasswordCharSet : Alphanumeric
DenEnabled : True
DenUrl : wss://den.wayk.net
QualityMode : High
LoggingLevel : Off
LoggingFilter :
AccessControlViewing : Disable
AccessControlInteract : Confirm
AccessControlClipboard : Disable
AccessControlFileTransfer : Confirm
AccessControlExec : Allow
AccessControlChat : Allow
The Friendly Name is used for Prompt For Permission (PFP) authentication. It should be easily recognized by your peers.
Type: string
DefaultValue: Username of the local user
Example:
PS ~/WaykNow-ps> Set-WaykNowConfig -FriendlyName david
Specifies the language of the application, "en" for English, "fr" for French, "de" German, "zh-CN" for Chinese Simplified, "zh-TW" for Chinese Traditional.
Type: string
DefaultValue: Language of the system
Accepted values: "en", "fr", "de", "zh-CN", "zh-TW"
Example:
PS ~/WaykNow-ps> Set-WaykNowConfig -Language en
Specifies the Remote Control Mode of WaykNow, AllRemoteControlMode: Both sides are displayed, TakeRemoteControlClientOnly: Only the client side is displayed and AllowRemoteControlSeverOnly: Only the server side is displayed.
Type: ControlMode
DefaultValue: AllRemoteControlMode
Accepted values: AllRemoteControlMode, TakeRemoteControlClientOnly, AllowRemoteControlSeverOnly
Example:
PS ~/WaykNow-ps> Set-WaykNowConfig -ControlMode AllRemoteControlMode
Select this option if you wish to launch Wayk Now when you log on.
Type: boolean
DefaultValue: false
Example:
PS ~/WaykNow-ps> Set-WaykNowConfig -AutoLaunchOnUserLogon false
this option is to prevent the main application window from showing when Wayk Now starts. It can be quite useful when the application is automatically launched.
Type: boolean
DefaultValue: true
Example:
PS ~/WaykNow-ps> Set-WaykNowConfig -ShowMainWindowOnLaunch true
This option is to hide Wayk Now from the taskbar when minimized.
Type: boolean
DefaultValue: false
Example:
PS ~/WaykNow-ps> Set-WaykNowConfig -MinimizeToNotificationArea false
Setting to enabled/disabled SRP: When Secure Remote Password is disabled, the password options are disabled as well.
Type: boolean
DefaultValue: true
Example:
PS ~/WaykNow-ps> Set-WaykNowConfig -AllowPersonalPassword true
Setting to enabled/disabled SRD: Secure Remote Delegation is the method used for system authentication in the case of unattended remote access. On Windows, remote access is restricted to members of the built-in Administrators or Remote Desktop Users groups.
Type: boolean
DefaultValue: true
Example:
PS ~/WaykNow-ps> Set-WaykNowConfig -AllowSystemAuth true
Setting to enabled/disabled PFP: Prompt for Permission authentication requests explicit consent from the remote user without the need for a password.
Type: boolean
DefaultValue: true
Example:
PS ~/WaykNow-ps> Set-WaykNowConfig -AllowNoPassword true
Setting to select your password type:
-
Generated Password
Generate a strong, random password with our password generator which can be configured with the -GeneratedPasswordLength and -GeneratedPasswordCharSet section. -
Custom Password
Create a custom password of your own choosing.
Type: PersonalPasswordType
Accepted values: Generated, Custom
DefaultValue: Generated
Example:
PS ~/WaykNow-ps> Set-WaykNowConfig -PersonalPasswordType Generated
Create a custom password of your own choosing.
Type: string
Example:
PS ~/WaykNow-ps> Set-WaykNowConfig -PersonalPassword password
The generated password length
Type: int
Accepted values: Between 3 and 9
DefaultValue: 6
Example:
PS ~/WaykNow-ps> Set-WaykNowConfig -GeneratedPasswordLength 6
The parameter used by the password generator: The alphanumeric character set contains numbers and letters, excluding 0, O, 1, I for a total of 32 characters. This choice was made to avoid any possible confusion when communicating the password to the other user.
Type: GeneratedPasswordCharSet
Accepted values: Numeric, Alphanumeric
DefaultValue: Alphanumeric
Example:
PS ~/WaykNow-ps> Set-WaykNowConfig -GeneratedPasswordCharSet Alphanumeric
Connect to Wayk Den to enable simplified peer-to-peer connectivity with a 6-digit ID.
Type: boolean
DefaultValue: true
Example:
PS ~/WaykNow-ps> Set-WaykNowConfig -DenEnabled true
The quality mode allow to adjust the quality of the render to optimize performance.
Type: QualityMode
Accepted values: Low, Medium, High
DefaultValue: Medium
Example:
PS ~/WaykNow-ps> Set-WaykNowConfig -QualityMode Medium
This Logging level option affects the verbosity of the logging messages.
Type: LoggingLevel
Accepted values: Trace, Debug, Info, Warn, Error, Fatal, Off
DefaultValue: Off
Example:
PS ~/WaykNow-ps> Set-WaykNowConfig -LoggingLevel Off
The Access Control section allows you to restrict access to certain resources shared by the server. In other words, access control defines what can be done to your machine when someone else is connected. You can set each feature independently.
-
Allow: The feature is enabled.
-
Confirm: The feature is disabled, but can be enabled after user confirmation during the session.
-
Disable: The feature is disabled. For security reasons or to enforce company policies, you may want to disable specific features.
The viewing access control
Type: AccessControl
Accepted values: Allow, Confirm, Disable
DefaultValue: Allow
Example:
PS ~/WaykNow-ps> Set-WaykNowConfig -AccessControlViewing Allow
The interaction access control
Type: AccessControl
Accepted values: Allow, Confirm, Disable
DefaultValue: Allow
Example:
PS ~/WaykNow-ps> Set-WaykNowConfig -AccessControlInteract Allow
The clipboard access control
Type: AccessControl
Accepted values: Allow, Confirm, Disable
DefaultValue: Allow
Example:
PS ~/WaykNow-ps> Set-WaykNowConfig -AccessControlClipboard Allow
The file transfer access control
Type: AccessControl
Accepted values: Allow, Confirm, Disable
DefaultValue: Allow
Example:
PS ~/WaykNow-ps> Set-WaykNowConfig -AccessControlFileTransfer Allow
The execution access control
Type: AccessControl
Accepted values: Allow, Confirm, Disable
DefaultValue: Allow
Example:
PS ~/WaykNow-ps> Set-WaykNowConfig -AccessControlExec Allow
For more information about White Labeling:
https://helpwayk.devolutions.net/index.html?advanced_whitelabelbranding.htm
The Test-WaykNowBranding
command with the parameter BrandingPath
will inform you if the branding.7z
is in a correct format, if the json file is correct, and if the encoding of the json file is correct.
PS ~/WaykNow-ps> Test-WaykNowBranding -BrandingPath https://cdn.devolutions.net/download/Documents/help-content/branding.7z
PS ~/WaykNow-ps> Test-WaykNowBranding -BrandingPath C:\Devolutions\BrandingFolder\branding.7z
The Set-WaykNowBranding
command with the parameter BrandingPath
will copy your archive branding.7z
to the correct path of WaykNow, you can use an url, or a local path.
The Sample
flag downloads and installs a sample branding.7z file for a fictional company that you can use as a reference or starting point.
PS ~/WaykNow-ps> Set-WaykNowBranding -BrandingPath https://cdn.devolutions.net/download/Documents/help-content/branding.7z
PS ~/WaykNow-ps> Set-WaykNowBranding -BrandingPath C:\Devolutions\BrandingFolder\branding.7z
PS ~/WaykNow-ps> Set-WaykNowBranding -Sample
The Set-WaykNowLicense
command with the parameter License
, sets your Wayk Now license.
PS ~/WaykNow-ps> Set-WaykNowLicense -License XXXXX-XXXXX-XXXXX-XXXXX-XXXXX
The Get-WaykNowLicense
command returns your license from Wayk Now.
PS ~/WaykNow-ps> Get-WaykNowLicense
XXXXX-XXXXX-XXXXX-XXXXX-XXXXX
The command Connect-WaykNowDen
will start a connection to the WaykDen set on WaykNow, you can use the parameter -Force to force reconnect the actual session.
PS ~/WaykNow-ps> Connect-WaykNowDen
"name" is now connected
The command Disconnect-WaykNowDen
will logout your connection with WaykDen.
PS ~/WaykNow-ps> Disconnect-WaykNowDen
To use this feature, WaykNow need to be installed on Windows with the unattended mode, you need to be connected to WaykDen (you can refer to "Connection with Wayk Den" section), and Powershell need to be run as administrator.
The command Register-WaykNowMachine
register your WaykNow client to WaykDen, with the unique ID of WaykNow.
PS ~/WaykNow-ps> Register-WaykNowMachine
Machine Registered: 4133d6bb-6eb6-be1a-30fd-f6be391d5aci
The command Unregister-WaykNowMachine
Unregister your WaykNow client to WaykDen, with the unique ID of WaykNow.
PS ~/WaykNow-ps> Unregister-WaykNowMachine
The command Get-WaykNowMachine
show the registered machine on your WaykDen.
You need to be logged with WaykDen before use this command, you can refer to "Connect WaykNowDen"
PS ~/WaykNow-ps> Get-WaykNowDenMachine
MachineName DenID State UserAgent
----------- ----- ----- ---------
DEVOLUTIONS146W 616529 ONLINE WaykNow/3.3.2 (Windows; Windows 10 Pro 1809)
DEVOLUTIONS147W 619181 OFFLINE WaykNow/3.3.2 (Windows; Windows 10 Pro 1809)
The command Enable-WaykNowLog
will enable the logs on WaykNow with the Logging Level Debug
by default, you can choose this one with the parameter LoggingLevel
and you can choose to restart WaykNow with the command -Restart
, because the changes will only be applied after an application restart.
PS ~/WaykNow-ps> Enable-WaykNowLog -Restart -LoggingLevel Info
The command Disable-WaykNowLog
will disable the logs on WaykNow, you can choose to restart WaykNow with the command -Restart
, because the changes will only be applied after an application restart.
PS ~/WaykNow-ps> Disable-WaykNowLog -Restart
The command Export-WaykNowLog
will export the logs from WaykNow, you need to set the parameter -ExportPath
to choose the destination of the logs
PS ~/WaykNow-ps> Export-WaykNowLog -ExportPath C:\Users\user\Desktop