sshShell
SSH shell behavior configuration. Most of these settings can be overridden per user.
These settings only apply to SSH bindings with Shell/SCP subsystem enabled.
# example
sshShell:
allowSystemAccount: false
defaultShellType: terminal
defaultShellPath: 'C:\Windows\System32\WindowsPowerShell\v1.0\powershell.exe'
defaultHomeDirectory: 'C:\'
sshShell.allowSystemAccount
boolean = false
Allow system account to spawn terminal and other processes.
sshShell.defaultShellType
string: "none" | "legacy" | "terminal" = "none"
Shell type | Description |
---|---|
none |
Minimal shell restricted to user’s path mappings with SCP will be available. |
legacy |
Minimal shell restricted to user’s path mappings with SCP and SSH aliases will be available. |
terminal |
Full shell (e.g. cmd.exe, PowerShell, etc.) will be presented, not restricting the user to their path mappings. Only available on Windows 10 version 1809 and newer, Windows Server 2019 and newer. |
sshShell.defaultShellPath
Enclose strings containing backslashes (
\
) or whitespace (
), such as Windows paths, in single quotes to avoid YAML parsing errors, for example: 'C:\Program Files\Rebex Buru SFTP Server'
.
string = "cmd.exe"
Path to default shell executable. Only applicable for terminal
shell.
sshShell.defaultHomeDirectory
Enclose strings containing backslashes (
\
) or whitespace (
), such as Windows paths, in single quotes to avoid YAML parsing errors, for example: 'C:\Program Files\Rebex Buru SFTP Server'
.
string = <Buru SFTP Server installation directory>
Path to default home directory. Only applicable for terminal
shell.
Feedback
Was this page helpful?
Glad to hear it! Please tell us how we can improve.
Sorry to hear that. Please tell us how we can improve.