How to enable SSH/SFTP

Serving SSH/SFTP requires two things: at least one SSH endpoint (a port and IP address the server listens on) and a set of SSH host keys the server uses to prove its identity to clients. The installer configures both automatically using sensible defaults — this page describes how to set them up manually.

Endpoints

Buru SFTP Server listens for SSH connections on one or more endpoints. Each endpoint defines a port, an IP address (or hostname), and which subsystems are active — SFTP, SCP, and SSH tunnel (2.17.0+). By default, the server binds to port 22 on all IPv4 (0.0.0.0) and IPv6 (::) interfaces. Endpoints can be configured through the Web Admin or directly in config.yaml.

Configure via the Web Admin

  1. Log in to the Web Administration and navigate to the Server ConfigurationSSH endpoints section.
  2. Add or modify the SSH endpoints and toggle subsystems as needed.
  3. Click the Save and restart button.

Configure via config.yaml

Endpoints are defined in the bindings section of your config.yaml. Each entry specifies a port, an IP address, and the active subsystems.

Example
bindings:
  # SFTP and SCP on all IPv4 addresses
  - ipAddress: 0.0.0.0
    port: 22
    sftp: true
    scp: true
    sshTunnel: false

  # SFTP and SCP on all IPv6 addresses
  - ipAddress: '::'
    port: 22
    sftp: true
    scp: true
    sshTunnel: false

  # SSH tunnelling only, bound to a hostname
  - ipAddress: 'tunnel.rebex.net'
    port: 2202
    sftp: false
    scp: false
    sshTunnel: true

Restart the service

Restart the Buru SFTP service for the changes to take effect:

Press ⊞ Win + R, type services.msc, find Rebex Buru SFTP Server, right-click and select Restart.
burusftp svc restart
net stop RebexBuruSftp && net start RebexBuruSftp
Restart-Service RebexBuruSftp

SSH is always enabled. By default, only a minimal shell is presented to the logged-in user, with functionality limited to the user's virtual path mappings. The shell mode is configurable globally or per user — when set to terminal, SCP becomes unavailable on that endpoint.

Host keys

SSH host keys identify the server to connecting clients. The installer generates a default set of keys and registers them in config.yaml, so a fresh installation works out of the box. You only need to act manually when rotating keys, adding a key of a specific type, or restoring a server from backup.

Keys are listed in the keys section of config.yaml:

keys:
  - 'C:\ProgramData\Rebex\BuruSftp\keys\ed25519.key'
  - 'C:\ProgramData\Rebex\BuruSftp\keys\rsa_4096.ppk'

See Generate SSH Server Keys (CLI) for details on creating and replacing host keys with the burusftp keygen utility.

See also

On this page