Configuration

Buru SFTP Server is configured through text-based files stored in a single directory. Most files ship with companion *-default files containing the built-in defaults and *-example files with commented configuration examples. The *-default files are regenerated on each server start; do not edit them.

The server resolves the configuration directory at startup by checking in order:
  1. config subfolder in the installation directory (e.g. D:\burusftp\config) — the default for portable installations
  2. C:\ProgramData\Rebex\BuruSftp — the default for installer-based installations
The first path that exists is used.

Configuration files

FileDescription
config.yamlPrimary server configuration — endpoints, SSH host keys and algorithms, FTP/FTPS certificates, IP filtering, account lockout, shell settings, logging, and more. Editable directly or through the Web Administration interface.
webconfig.yamlWeb Administration configuration — listening address/port, HTTPS certificates, and log settings. Edited directly; the Web Administration interface does not modify this file.
aliasesSSH shell command aliases for the legacy shell type.
customization.json5PRO Web Administration UI customization (branding, colors, labels).
license.keyProduct license key. See Apply a License Key.
users.ldbUser database (LiteDB 4 binary format). Managed through Web Administration or the burusftp user CLI.

On this page