bindings

SSH endpoints that the server listens on. Since SFTP and SCP run over SSH, these endpoints define where clients connect for all SSH-based file transfer and shell access. Each endpoint specifies an IP address, port, and which subsystems (SFTP, Shell/SCP, SSH tunnelling) are available on it.

By default, the server listens on port 22 on all IP addresses with SFTP and Shell/SCP enabled.

For FTP/FTPS endpoint configuration, see ftp.bindings.

# default bindings
bindings:
  - { port: 22, ipAddress: 0.0.0.0, sftp: true, scp: true, sshTunnel: false }
  - { port: 22, ipAddress: "::", sftp: true, scp: true, sshTunnel: false }

bindings[].port

number = 22

Port number to listen on. The default SSH port is 22.

bindings[].ipAddress

string: <IPv4 address> | <IPv6 address> | <hostname>

IP address to listen on. Use 0.0.0.0 to listen on any IPv4 address and :: on any IPv6 address. Hostnames can be used as well; the corresponding IP address(es) will be resolved when the server starts.

Enclose strings containing colons (:), such as IPv6 addresses, in single quotes to avoid YAML parsing errors, for example: '2001:db8::1'.

bindings:
  - ipAddress: '192.168.1.1'
    # ...
  - ipAddress: '::'
    # ...
  - ipAddress: 'test.rebex.net'
    # ...

bindings[].sftp

boolean = true

Enable SFTP subsystem on the endpoint.

bindings[].scp

boolean = true

Enable Shell/SCP subsystem on the endpoint.

SCP is only available when the shell mode is set to none or legacy. When set to terminal, SCP becomes unavailable on the endpoint.

bindings[].sshTunnel

boolean = false

2.17.0+ Enable outgoing SSH tunnel subsystem on the endpoint. Replaces the legacy sshTunneling section.

On this page