Configuration

Configuration file

Configuration is stored in appSettings section of RebexTinySftpServer.exe.config XML file. All configuration keys are case-sensitive. The file must be in the same folder as the Tiny SFTP Server application.

For details see Configuration file format.

Sample configuration file:

<?xml version="1.0" encoding="utf-8"?>
<configuration>
  <appSettings>
    <!-- user credentials and root directory -->
    <add key="userName" value="tester" />
    <add key="userPassword" value="password" />
    <add key="userRootDir" value="data" />
    
    <!-- server port -->
    <add key="sshPort" value="22" />
    
    <!-- comma-separated list of IP addresses the server will be bound to -->
    <add key="sshIPBindings" value="" />
    
    <!-- server host keys -->
    <add key="rsaPrivateKeyFile" value="server-private-key-rsa.ppk" />
    <add key="rsaPrivateKeyPassword" value="my-super-secure-password" />
    <add key="dssPrivateKeyFile" value="server-private-key-dss.ppk" />
    <add key="dssPrivateKeyPassword" value="my-super-secure-password" />
    
    <!-- directory path with user public keys for public key authentication -->
    <add key="userPublicKeyDir" value="" />
    
    <!-- comma-separated list of enabled encryption ciphers -->
    <add key="ciphers" value="" />
    
    <!-- specifies whether the app should start minimized -->
    <add key="minimizeOnStart" value="false" />
    
    <!-- specifies whether the app should minimize to System Tray (Notification Area) -->
    <add key="minimizeToTray" value="false" />
    
    <!-- specifies whether to show login details when the application is launched -->
    <add key="showUserDetailsOnStartup" value="true" />
    
    <!-- specifies whether to start the server when the application is launched -->
    <add key="autoStart" value="false" />
  </appSettings>
</configuration>

All configuration settings

sshPort

Default value: 22

TCP port on which the server runs.

sshIPBindings

Default value: Any

Comma-separated list of IP addresses the server will be bound to. Optional.

In addition to standard IP address format, following values are also supported:

• IPv4Loopback = 127.0.0.1, IPv6Loopback = ::1
• Loopback = IPv4Loopback and IPv6Loopback
• IPv4Any = 0.0.0.0, IPv6Any = ::
• Any = IPv4Any and IPv6Any

userName

Login name of the SFTP user.

See also: Password authentication

userPassword

Password of the SFTP user.

userRootDir

Root data folder. If the folder does not exist, the server creates it and puts some test data there.

userPublicKeyDir

Path to folder with user public keys used for private/public key authentication. Raw or Base-64-encoded SSH2 key format supported. Optional. Leave blank to disable key authentication.

See also: Key authentication

rsaPrivateKeyFile

Path to the server RSA private key file. PKCS #8, OpenSSH/OpenSSL SSLeay and PuTTY formats are supported. A new key file is generated if it does not exist.

rsaPrivateKeyPassword

Password for the server RSA private key file.

dssPrivateKeyFile

Path to the server DSA private key file. PKCS #8, OpenSSH/OpenSSL SSLeay and PuTTY formats are supported. A new key file is generated if it does not exist.

dssPrivateKeyPassword

Password for the server DSA private key file.

ciphers

Comma-separated list of enabled SSH encryption ciphers.

The following ciphers are supported: aes256-gcm@openssh.com, aes128-gcm@openssh.com, chacha20-poly1305@openssh.com, aes256-ctr, aes192-ctr, aes128-ctr, aes256-cbc, aes192-cbc, aes128-cbc, 3des-ctr, 3des-cbc, twofish256-ctr, twofish192-ctr, twofish128-ctr, twofish256-cbc, twofish192-cbc, twofish128-cbc, twofish-cbc

If the value is empty, the following ciphers are enabled by default: aes256-gcm@openssh.com, aes128-gcm@openssh.com, chacha20-poly1305@openssh.com, aes256-ctr, aes192-ctr, aes128-ctr, 3des-ctr

minimizeOnStart

Default value: false

If set to true, the server application starts minimized.

minimizeToTray

Default value: false

If set to true, the application is minimized to System Tray (Notification Area) when the application window is minimized or closed. To exit the application, right-click on the tray icon and select “Exit” from the menu.

showUserDetailsOnStartup

Default value: true

If set to true, user name and password are displayed in the application. Set it to false to prevent this.

autoStart

Default value: false

If set to true, the server starts when application is started. No need to press the button.

Configuration file format

The file uses standard format of .net application XML configuration. Technical details can be found at Microsoft website in Configure apps by using configuration files and <appSettings> element for <configuration>.