Install with the Gluesync kit

Start at Get Gluesync and follow the setup wizard. The resulting kit installer is the supported default for a self-managed deployment: it validates the host, prepares the container runtime where supported, downloads the licensed services, and starts the Control Plane.

You do not need to install Docker or write a Compose file before starting the wizard. The manual Docker guides are only for system administrators whose infrastructure policies require a DIY deployment.

Before you run it

  1. Check system requirements.

  2. Request the Gluesync kit for the required source and target.

  3. Keep the kit ID from the download email available.

  4. If you need a fresh copy of an installer or lifecycle tool, validate your licence under Installation kits & tools.

  5. Make sure the host can reach the endpoints in System requirements.

The installer changes container-runtime and logging configuration. Use a dedicated host for production, take a backup of existing runtime configuration, and run the installer with the administrative privileges requested for the platform.

Linux

  1. Copy the downloaded installer to the target host.

  2. Make it executable.

  3. Run the installer and enter the kit ID when prompted.

  4. When installation completes, note the Control Plane URL printed by the installer.

Gluesync is installed under /opt/gluesync. To start it again from that directory:

./run.sh

Supported distributions and current runtime requirements are listed in System requirements.

Windows Server

  1. Open an elevated PowerShell session.

  2. Run the PowerShell installer from the kit.

  3. Allow the installer to enable the required Windows container features.

  4. If Windows requests a restart, restart the host and resume the installer.

  5. When installation completes, use the generated shortcut or the printed Control Plane URL.

Gluesync is installed under C:\Program Files\Gluesync. To start it manually:

.\run.ps1

For Windows-specific prerequisites and the manual fallback, see Windows Server installation.

macOS

  1. Install and start Docker Desktop.

  2. Extract the kit ZIP.

  3. In the extracted directory, run:

    ./run.sh

  4. Open the Control Plane URL printed by the script.

macOS is appropriate for evaluation and local development, not a production deployment.

Verify the installation

  1. Open the Control Plane.

  2. Sign in with admin / admin.

  3. Set a new password when prompted.

  4. Confirm that Pipelines loads without a Core Hub connection error.

  5. Open the notifications menu and resolve any startup error before creating a pipeline.

Continue with Build your first pipeline.

Manage the installation

Use the tools supplied with the kit instead of raw Docker Compose lifecycle commands. If a tool is missing or outdated, download it again from Installation kits & tools after validating your licence.

Task Linux and macOS Windows Server What the tool does

Start or restart

./run.sh

.\run.ps1

Finds the supplied Compose file, prepares required environment settings, pulls images during initial setup, and starts the stack with orphan handling.

Stop

./stop.sh

.\stop.ps1

Finds the supplied Compose file and stops the complete Gluesync stack with orphan handling.

Update

./update.sh

.\update.ps1

Checks the selected release channel, updates managed image references, and restarts the stack when required.

Run them from the Gluesync installation directory. They preserve the required environment, Compose selection, validation, and lifecycle sequence.

Do not replace these tools with docker compose up, down, stop, or pull. Raw Compose commands bypass the Gluesync lifecycle checks and can select the wrong files or remove persistent state.

Remove an installation

Before uninstalling, take a configuration backup and copy any required data volumes.

Linux

Run ./docker-uninstaller.sh. Add --purge-runtime only if the container runtime and all of its data should also be removed.

Windows Server

Run .\docker-uninstaller-windows.ps1 from an elevated PowerShell session. Use -Force to skip confirmation or -NoRestart to suppress an automatic restart.

Uninstalling can remove Gluesync containers and volumes. Purging the runtime can also affect workloads unrelated to Gluesync.

When the kit installer is not suitable