Deployment

We believe software installation should be as simple as possible. That's why we've opted not to use traditional installers. Instead, we ship ready-to-run binaries directly to you.

Simply unpack the ZIP file (Windows) or TAR.GZ file (Linux) and OmniLoader is ready to use immediately. No complex setup. No configuration required.

We ship native binaries for
Windows and Linux

Running an agent on a different machine is no more complex than copying binaries to the new machine and running a single executable file.

Deployment in Standalone Mode

To launch Omni Loader in standalone mode, simply run the executable.

  • On Windows, the file is named OmniLoader.exe.
  • On Linux, it’s just OmniLoader.

Omni Loader includes a built-in web server that powers its browser-based user interface. To start it, you only need to specify one parameter: the port number you want the server to use.

For convenience, we provide a batch file (run-standalone.bat) that automatically starts Omni Loader on the default port 5000. Once running, open your browser and go to http://localhost:5000. You'll be greeted with a clean, modern interface that lets you configure and control every part of your database migration.

When you're finished, you can shut down Omni Loader by stopping the console process you started earlier.

Deployment in Cluster Mode

Cluster Mode works much like Standalone Mode, but adds support for running multiple agents across different machines. In this setup, Omni Loader acts as the orchestrator, managing agents that handle the actual migration tasks.

You can run a single agent on the same machine as the orchestrator. However, running multiple agents on one machine won't improve performance. For best results, deploy agents across as many machines as you have available.

To run Omni Loader as an orchestrator is the same as running it in Standalone Mode, but you need to supply an additional --cluster parameter.

To add agents on other machines:

  • Run the agent executable: OmniLoaderAgent.exe on Windows or OmniLoaderAgent on Linux.
  • Provide the IP and port of the orchestrator as the only parameter.

That's it. The agents will connect and begin participating in the migration process.

Running in the Console Mode

To run Omni Loader in Console Mode, simply supply the --job parameter. This parameter should specify the full or relative path to the JSON job descriptor file. Omni Loader will run through the whole migration. After that, you can examine the logs to ensure that everything went as expected.

One of the log files is a detailed JSON log file that's designed for machine consumption.

Learn more
right pointing arrow
graphic icon
Sisyphus

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Mauris imperdiet egestas blandit. Suspendisse rhoncus congue lorem ut malesuada.

Avatar image
Candice Doe
Product Manager, Sisyphus
Save time, increase efficiency.

Ready to get started?

FAQ

Frequently asked questions

By clicking “Accept All Cookies”, you agree to the storing of cookies on your device to enhance site navigation, analyze site usage, and assist in our marketing efforts. View our Privacy Policy for more information.