Qt 5.8 | Deploying Qt Applications

Qt 5.8.0 Reference Documentation

# Deploying Qt Applications

Deploying an Qt application does not require any C++ programming. All you need to do is to build Qt and your application in release mode, following the procedures described in this documentation.

## Static vs. Shared Libraries

There are two ways of deploying an application:

- Static Linking
- Shared Libraries (Frameworks on Mac)

Static linking results in a stand-alone executable. The advantage is that you will only have a few files to deploy. The disadvantages are that the executables are large and with no flexibility (i.e a new version of the application, or of Qt, will require that the deployment process is repeated), and that you cannot deploy plugins.

To deploy plugin-based applications, you can use the shared library approach. Shared libraries also provide smaller, more flexible executables. For example, using the shared library approach, the user is able to independently upgrade the Qt library used by the application.

Another reason why you might want to use the shared library approach, is if you want to use the same Qt libraries for a family of applications. In fact, if you download the binary installation of Qt, you get Qt as a shared library.

The disadvantage with the shared library approach is that you will get more files to deploy. For more information, see Creating Shared Libraries.

## Deploying Qt's Libraries

Unless Qt is part of the system libraries it must be redistributed with your application. The minimum is to redistribute the run-time of the libraries used by the application. However, with static linking, the Qt run-times can be compiled into the executable.

In general, you should deploy all plugins that your Qt build uses, excluding those that you have identified as unnecessary for your application and its users.

For instance, you may need to deploy plugins for JPEG support and SQL drivers, but you should also deploy plugins that your users may require, including those for accessibility. For more information about plugins, see How to Create Qt Plugins.

Applications using Qt QML also need to ship the QML modules they use.

While deploying an application using the shared library approach, you must ensure that the Qt libraries use the correct path to find the Qt plugins, documentation, translation, and so on. To do this, you can use a `qt.conf` file. For more information, see Using qt.conf.

Depending on configuration, compiler-specific libraries must be redistributed as well. For more information, see the platform-specific application dependencies for X11, Windows, and macOS.

## Licensing

Some of Qt's libraries are based on third party libraries that are not licensed using the same dual-license model as Qt. As a result, care must be taken when deploying applications that use these libraries, particularly when the application is statically linked to them.

The following table summarizes a few issues that you should be aware of.

Qt Library | Dependency | Licensing Issue
--- | --- | ---
QtHelp | CLucene | The version of clucene distributed with Qt is licensed under the GNU LGPL version 2.1 or later. This has implications for developers of closed source applications. Please see the Qt Help documentation for more information.
QtNetwork | OpenSSL | Some configurations of QtNetwork use OpenSSL at run-time. Deployment of OpenSSL libraries is subject to both licensing and export restrictions. More information can be found in the Secure Sockets Layer (SSL) Classes documentation.

For more information, see Third-Party Licenses Used in Qt.

## Platform-Specific Notes

The procedure of deploying Qt applications is different for the various platforms:

- Qt for X11 Platforms
- Qt for Windows
- Qt for macOS
- Qt for Android

See also Deploying Translations.