Installation and getting started

Installation

You can either use the .exe installer (recommended) or install the product manually using the .zip package.

The executables mentioned on this page (burusftp.exe, burusftpwa.exe) can be found in the server’s installation directory.

Using the .exe installer - recommended

Download and run the installer.

Using the .zip package

Download and extract the zip package to desired installation location. Then continue with one of the following:

Interactive setup - recommended

Run burusftp.exe install. This will initialize the server SSH keys, configuration files and optionally install the server as a Windows service and create a web administration user. The command will not copy the application to another location.

Manual setup

Run burusftp.exe init to initialize the server SSH keys and configuration files.

Running the server in the console (optional)

Run burusftp.exe run to start the server in interactive mode.
Run burusftpwa.exe run to start the web administration in interactive mode.

Running the server as a Windows service (optional)

Run burusftp.exe svc install to register SFTP Server as a Windows service, burusftp.exe svc start to start it.
Run burusftpwa.exe svc install to register Web administration as a Windows service, burusftpwa.exe svc start to start it.

Creating your first user

You can create SFTP users using burusftp.exe user add command, for example:

burusftp.exe user add myuser -p --root-dir c:\Users\myuser

Add --web-admin enable to allow the user to manage the server using Web administration, for example:

burusftp.exe user add myuser -p --root-dir c:\Users\myuser --web-admin enable

Accessing the Web administration

If installed, the Web administration can be accessed by default at http://localhost:8880.

Accessing the SFTP server

The server listens on port 22 by default and can be accessed by a SSH/SFTP client.

Next steps

The configuration files can be found in the config folder.

SFTP Server configuration

The SFTP server can be configured either using the Web administration (if installed) or by editing the configuration file config.yaml.

See the documentation for more details.

Web administration configuration

The Web administration can be configured by editing the configuration file webconfig.yaml.

See the documentation for more details.

User management

Users can be managed either using the Web administration or using the command line commands, such as burusftp user add.

See the documentation for more details.