MaxBack
by

Getting Started with MaxBack

This guide walks you through installing MaxBack and connecting it to your MaxDB database.

Prerequisites

Before installing, verify your environment meets these requirements:

  • Windows Server (x64) — Windows Server 2019, 2022, or 2025 (Windows 10 or higher).

    Windows Server 2016

    Windows Server 2016 is no longer tested. It may work, but we cannot guarantee full compatibility.

  • Software — .NET Desktop Runtime 10.0 and Visual C++ Runtime (installed automatically by the setup).

  • MaxDB — Version 7.8.2 or higher is required. MaxDB 7.9.08.39 or higher is recommended.

    CacheMemorySize

    The database parameter CacheMemorySize has to be large enough to create snapshots. See SAP note 2324249 for sizing recommendations.

  • Backup product — Any VSS backup product that supports component selection mode and snapshot backup. See Supported Backup Tools for tested products.

Installation

  1. Install binaries — Download and run the MaxBack setup package from the downloads page.

  2. Install the license — Copy the activation license file you received from our sales team to the database host, then run from an elevated command prompt:

    maxback.vssclient license install -f <path to the license file>

    If the host has internet access, the instance license will be activated automatically via the dbosoft license server.

    Trial License

    To activate a trial license, add the --temp option to the command.

    For hosts without internet access or if activation fails, see License Installation for offline activation and other options.

  3. Connect to the database — Create the writer instance from an elevated command prompt:

    maxback.vssclient db connect

    This will:

    • Create a Windows service for the VSS Writer
    • Create a database user vsswriter with a random password
    • Ask for a log media name (the log medium must already exist in MaxDB)

    Log Media

    It is recommended to use a separate disk for log backups. See Log Management for recommendations.

  4. Enable a configuration set (recommended) — Apply a best-practices configuration for your backup tool:

    maxback.vssclient options configset

    The command will prompt you to select the appropriate configuration set for your backup tool.

    Veeam & Azure Backup

    If you use Veeam or Azure Backup, enabling the corresponding configuration set is required for correct operation.

    See Configuration for all available options.

  5. Set up notifications (optional) — Configure email or webhook notifications to get alerted about failed backups, stopped services, expiring licenses, or low disk space. See Watchdog Notifications for setup instructions.

Upgrading from MaxBack 3.x

If you are upgrading from a MaxBack 3.x installation, run maxback.vssclient options upgrade -d <dbname> to migrate your existing XML configuration to the new JSON format. See Configuration — Upgrading from MaxBack 3.x for details.

Next steps