customization.json5

Web Administration customization is available in Pro edition only.

The customization.json5 file controls the appearance and branding of the Web Administration interface. All fields are optional. The server accepts both customization.json5 (JSON5 format) and customization.json (plain JSON). The file is located in the configuration directory. A sample file (customization-sample.json5) is included for reference.

{
    header: {
        // Title displayed in the header
        title: "Buru SFTP Server Administration",

        // Logo image URL (public URL or path relative to the Web Administration root)
        logoUrl: "/logo.png",
        logoAltText: "Buru SFTP Server Administration logo"
    },

    theme: {
        palette: {
            // Dark text on light background (light) or light text on dark background (dark)
            type: 'dark',

            // Colors used in header and navigation panel
            header: { main: '#f06292' },

            // Colors used for hyperlinks and form controls
            primary: { main: '#f06292' }
        }
    },
}

object

Branding elements displayed at the top of the Web Administration interface.

header.title

string

Text displayed in the header bar.

header.logoUrl

string

URL of the logo image in the top-left corner. Can be an absolute URL or a path relative to the Web Administration root. To host the logo locally, place the file in the ClientApp directory under the Web Administration installation directory (e.g. C:\Program Files\Rebex Buru SFTP Server\ClientApp\logo.png) and reference it as "/logo.png".

header.logoAltText

string

Alt text for the logo image (accessibility).

theme.palette

object

Color theme for the Web Administration interface.

2.14.0+ Only the properties listed below are supported. Earlier versions accepted a full Material-UI palette schema; secondary and other palette keys are no longer recognized.

theme.palette.type

"light" | "dark"

Dark text on light background (light) or light text on dark background (dark).

theme.palette.header.main

string

Background color of the header and navigation panel. Uses hexadecimal format (#rrggbb or #rgb).

theme.palette.primary.main

string

Color of hyperlinks and form controls. Uses hexadecimal format (#rrggbb or #rgb).

On this page