From 9c50c6cbe606d1ec5fa642ca6d0730cd953d28e1 Mon Sep 17 00:00:00 2001 From: John Parent Date: Wed, 23 Oct 2024 18:04:44 -0400 Subject: [PATCH] gpt4all bespoke installers Adds initial support for bespoke platform specific installers, DragNDrop and InnoSetup on MacOS and Windows respectively. This moves gpt4all away from reliance on the IFW framework installers. DragNDrop produces a dmg, that on mounting, provides the user an interface to drag the gpt4all app bundle into the application directory. InnoSetup provides a traditional Windows installation wizard. To insepct these new behaviors, simply run the gpt4all build and package process as normal, and depending on your platform, either a DragNDorp DMG or InnoSetup exectauble will be produce. On MacOS simply mount or double click the DMG, on Windows, execute or double click the installer. Signed-off-by: John Parent --- gpt4all-chat/CMakeLists.txt | 83 +--------------- gpt4all-chat/cmake/Gpt4allCPack.cmake | 97 +++++++++++++++++++ .../cmake/gpt4allCPackOptions.cmake.in | 37 +++++++ 3 files changed, 135 insertions(+), 82 deletions(-) create mode 100644 gpt4all-chat/cmake/Gpt4allCPack.cmake create mode 100644 gpt4all-chat/cmake/gpt4allCPackOptions.cmake.in diff --git a/gpt4all-chat/CMakeLists.txt b/gpt4all-chat/CMakeLists.txt index f3a6c775..f8c453cd 100644 --- a/gpt4all-chat/CMakeLists.txt +++ b/gpt4all-chat/CMakeLists.txt @@ -444,85 +444,4 @@ if (NOT APPLE) COMPONENT ${COMPONENT_NAME_MAIN}) endif() -set(CPACK_GENERATOR "IFW") -set(CPACK_VERBATIM_VARIABLES YES) -set(CPACK_IFW_VERBOSE ON) - -if(${CMAKE_SYSTEM_NAME} MATCHES Linux) - find_program(LINUXDEPLOYQT linuxdeployqt HINTS "$ENV{HOME}/dev/linuxdeployqt/build/tools/linuxdeployqt" "$ENV{HOME}/project/linuxdeployqt/bin") - configure_file("${CMAKE_CURRENT_SOURCE_DIR}/cmake/deploy-qt-linux.cmake.in" - "${CMAKE_BINARY_DIR}/cmake/deploy-qt-linux.cmake" @ONLY) - set(CPACK_PRE_BUILD_SCRIPTS ${CMAKE_BINARY_DIR}/cmake/deploy-qt-linux.cmake) - set(CPACK_IFW_ROOT "~/Qt/Tools/QtInstallerFramework/4.6") - set(CPACK_PACKAGE_FILE_NAME "${COMPONENT_NAME_MAIN}-installer-linux") - set(CPACK_IFW_TARGET_DIRECTORY "@HomeDir@/${COMPONENT_NAME_MAIN}") -elseif(${CMAKE_SYSTEM_NAME} MATCHES Windows) - find_program(WINDEPLOYQT windeployqt HINTS ${_qt_bin_dir}) - configure_file("${CMAKE_CURRENT_SOURCE_DIR}/cmake/deploy-qt-windows.cmake.in" - "${CMAKE_BINARY_DIR}/cmake/deploy-qt-windows.cmake" @ONLY) - set(CPACK_PRE_BUILD_SCRIPTS ${CMAKE_BINARY_DIR}/cmake/deploy-qt-windows.cmake) - set(CPACK_IFW_ROOT "C:/Qt/Tools/QtInstallerFramework/4.6") - set(CPACK_IFW_PACKAGE_ICON "${CMAKE_CURRENT_SOURCE_DIR}/resources/gpt4all.ico") - set(CPACK_PACKAGE_FILE_NAME "${COMPONENT_NAME_MAIN}-installer-win64") - set(CPACK_IFW_TARGET_DIRECTORY "@HomeDir@\\${COMPONENT_NAME_MAIN}") -elseif(${CMAKE_SYSTEM_NAME} MATCHES Darwin) - find_program(MACDEPLOYQT macdeployqt HINTS ${_qt_bin_dir}) - configure_file("${CMAKE_CURRENT_SOURCE_DIR}/cmake/deploy-qt-mac.cmake.in" - "${CMAKE_BINARY_DIR}/cmake/deploy-qt-mac.cmake" @ONLY) - set(CPACK_PRE_BUILD_SCRIPTS ${CMAKE_BINARY_DIR}/cmake/deploy-qt-mac.cmake) - set(CPACK_IFW_ROOT "~/Qt/Tools/QtInstallerFramework/4.6") - set(CPACK_IFW_PACKAGE_ICON "${CMAKE_CURRENT_SOURCE_DIR}/resources/gpt4all.icns") - set(CPACK_PACKAGE_FILE_NAME "${COMPONENT_NAME_MAIN}-installer-darwin") - set(CPACK_IFW_TARGET_DIRECTORY "@ApplicationsDir@/${COMPONENT_NAME_MAIN}") - set(CPACK_BUNDLE_NAME ${COMPONENT_NAME_MAIN}) - set(CPACK_BUNDLE_ICON "${CMAKE_CURRENT_SOURCE_DIR}/resources/gpt4all.icns") -endif() - -set(CPACK_PACKAGE_INSTALL_DIRECTORY ${COMPONENT_NAME_MAIN}) -set(CPACK_PACKAGE_VERSION_MAJOR ${PROJECT_VERSION_MAJOR}) -set(CPACK_PACKAGE_VERSION_MINOR ${PROJECT_VERSION_MINOR}) -SET(CPACK_PACKAGE_VERSION_PATCH ${PROJECT_VERSION_PATCH}) -set(CPACK_PACKAGE_HOMEPAGE_URL "https://www.nomic.ai/gpt4all") -set(CPACK_PACKAGE_ICON "${CMAKE_CURRENT_SOURCE_DIR}/icons/gpt4all-48.png") -set(CPACK_RESOURCE_FILE_LICENSE ${CMAKE_CURRENT_SOURCE_DIR}/LICENSE) -set(CPACK_RESOURCE_FILE_README ${CMAKE_CURRENT_SOURCE_DIR}/README.md) -set(CPACK_PACKAGE_EXECUTABLES "GPT4All") -set(CPACK_CREATE_DESKTOP_LINKS "GPT4All") -set(CPACK_IFW_PACKAGE_NAME "GPT4All") -set(CPACK_IFW_PACKAGE_TITLE "GPT4All Installer") -set(CPACK_IFW_PACKAGE_PUBLISHER "Nomic, Inc.") -set(CPACK_IFW_PRODUCT_URL "https://www.nomic.ai/gpt4all") -set(CPACK_IFW_PACKAGE_WIZARD_STYLE "Aero") -set(CPACK_IFW_PACKAGE_LOGO "${CMAKE_CURRENT_SOURCE_DIR}/icons/gpt4all-48.png") -set(CPACK_IFW_PACKAGE_WINDOW_ICON "${CMAKE_CURRENT_SOURCE_DIR}/icons/gpt4all-32.png") -set(CPACK_IFW_PACKAGE_WIZARD_SHOW_PAGE_LIST OFF) -set(CPACK_IFW_PACKAGE_CONTROL_SCRIPT "${CMAKE_CURRENT_SOURCE_DIR}/cmake/installer_control.qs") - -include(InstallRequiredSystemLibraries) -include(CPack) -include(CPackIFW) -if(GPT4ALL_OFFLINE_INSTALLER) - cpack_add_component(${COMPONENT_NAME_MAIN}) -else() - cpack_add_component(${COMPONENT_NAME_MAIN} DOWNLOADED) -endif() -cpack_ifw_configure_component(${COMPONENT_NAME_MAIN} ESSENTIAL FORCED_INSTALLATION) -cpack_ifw_configure_component(${COMPONENT_NAME_MAIN} VERSION ${APP_VERSION}) -cpack_ifw_configure_component(${COMPONENT_NAME_MAIN} LICENSES "MIT LICENSE" ${CPACK_RESOURCE_FILE_LICENSE}) -cpack_ifw_configure_component(${COMPONENT_NAME_MAIN} SCRIPT "${CMAKE_CURRENT_SOURCE_DIR}/cmake/installer_component.qs") -cpack_ifw_configure_component(${COMPONENT_NAME_MAIN} REPLACES "gpt4all-chat") #Was used in very earliest prototypes - -if (GPT4ALL_LOCALHOST) - cpack_ifw_add_repository("GPT4AllRepository" URL "http://localhost/repository") -elseif(GPT4ALL_OFFLINE_INSTALLER) - add_compile_definitions(GPT4ALL_OFFLINE_INSTALLER) -else() - if(${CMAKE_SYSTEM_NAME} MATCHES Linux) - cpack_ifw_add_repository("GPT4AllRepository" URL "https://gpt4all.io/installer_repos/linux/repository") - elseif(${CMAKE_SYSTEM_NAME} MATCHES Windows) - #To sign the target on windows have to create a batch script add use it as a custom target and then use CPACK_IFW_EXTRA_TARGETS to set this extra target - cpack_ifw_add_repository("GPT4AllRepository" URL "https://gpt4all.io/installer_repos/windows/repository") - elseif(${CMAKE_SYSTEM_NAME} MATCHES Darwin) - cpack_ifw_add_repository("GPT4AllRepository" URL "https://gpt4all.io/installer_repos/mac/repository") - endif() -endif() +include(Gpt4allCPack) diff --git a/gpt4all-chat/cmake/Gpt4allCPack.cmake b/gpt4all-chat/cmake/Gpt4allCPack.cmake new file mode 100644 index 00000000..3c0ab431 --- /dev/null +++ b/gpt4all-chat/cmake/Gpt4allCPack.cmake @@ -0,0 +1,97 @@ +# Setup Generic CPack options +include(InstallRequiredSystemLibraries) +set(CPACK_VERBATIM_VARIABLES YES) + +set(CPACK_PACKAGE_NAME "gpt4all") +set(CPACK_PACKAGE_VERSION ${APP_VERSION_BASE}) +set(CPACK_PACKAGE_VERSION_MAJOR ) +set(CPACK_PACKAGE_VERSION_MINOR ) +set(CPACK_PACKAGE_VERSION_PATCH ) +set(CPACK_PACKAGE_VENDOR "nomic") +set(CPACK_PACKAGE_DESCRIPTION + "GPT4All runs large language models (LLMs) privately on everyday desktops & laptops.") +set(CPACK_PACKAGE_INSTALL_DIRECTORY ${COMPONENT_NAME_MAIN}) +set(CPACK_PACKAGE_VERSION_MAJOR ${PROJECT_VERSION_MAJOR}) +set(CPACK_PACKAGE_VERSION_MINOR ${PROJECT_VERSION_MINOR}) +set(CPACK_PACKAGE_VERSION_PATCH ${PROJECT_VERSION_PATCH}) +set(CPACK_PACKAGE_HOMEPAGE_URL "https://www.nomic.ai/gpt4all") +set(CPACK_PACKAGE_EXECUTABLES "gpt4all") +set(CPACK_CREATE_DESKTOP_LINKS "gpt4all") +# TODO: Is there another intro message we want? +set(CPACK_RESOURCE_FILE_README "${CMAKE_SOURCE_DIR}/README.md") +set(CPACK_RESOURCE_FILE_LICENSE "${CMAKE_BINARY_DIR}/LICENSE.txt") +# TODO: ask Adam if there's a better email to use here +set(CPACK_PACKAGE_CONTACT "adam@nomic.ai") + +# Why are we creating components here? There's only one... gpt4all is installed monolithically +# unless we want to start vendoring models for the downloaded version? +if(GPT4ALL_OFFLINE_INSTALLER) + cpack_add_component(${COMPONENT_NAME_MAIN}) +else() + cpack_add_component(${COMPONENT_NAME_MAIN} DOWNLOADED) +endif() + +# Setup platform specific CPack options + +if(${CMAKE_SYSTEM_NAME} MATCHES Linux) + find_program(LINUXDEPLOYQT linuxdeployqt HINTS "$ENV{HOME}/dev/linuxdeployqt/build/tools/linuxdeployqt" "$ENV{HOME}/project/linuxdeployqt/bin") + configure_file("${CMAKE_CURRENT_SOURCE_DIR}/cmake/deploy-qt-linux.cmake.in" + "${CMAKE_BINARY_DIR}/cmake/deploy-qt-linux.cmake" @ONLY) + set(CPACK_PRE_BUILD_SCRIPTS ${CMAKE_BINARY_DIR}/cmake/deploy-qt-linux.cmake) + # Still using IFW on Linux + set(CPACK_GENERATOR "IFW") + set(CPACK_IFW_VERBOSE ON) + set(CPACK_IFW_PACKAGE_NAME "GPT4All") + set(CPACK_IFW_PACKAGE_TITLE "GPT4All Installer") + set(CPACK_IFW_PACKAGE_PUBLISHER "Nomic, Inc.") + set(CPACK_IFW_PRODUCT_URL "https://www.nomic.ai/gpt4all") + set(CPACK_IFW_PACKAGE_WIZARD_STYLE "Aero") + set(CPACK_IFW_PACKAGE_LOGO "${CMAKE_CURRENT_SOURCE_DIR}/icons/gpt4all-48.png") + set(CPACK_IFW_PACKAGE_WINDOW_ICON "${CMAKE_CURRENT_SOURCE_DIR}/icons/gpt4all-32.png") + set(CPACK_IFW_PACKAGE_WIZARD_SHOW_PAGE_LIST OFF) + set(CPACK_IFW_PACKAGE_CONTROL_SCRIPT "${CMAKE_CURRENT_SOURCE_DIR}/cmake/installer_control.qs") + set(CPACK_IFW_ROOT "~/Qt/Tools/QtInstallerFramework/4.6") + set(CPACK_PACKAGE_FILE_NAME "${COMPONENT_NAME_MAIN}-installer-linux") + set(CPACK_IFW_TARGET_DIRECTORY "@HomeDir@/${COMPONENT_NAME_MAIN}") +elseif(${CMAKE_SYSTEM_NAME} MATCHES Windows) + find_program(WINDEPLOYQT windeployqt HINTS ${_qt_bin_dir}) + configure_file("${CMAKE_CURRENT_SOURCE_DIR}/cmake/deploy-qt-windows.cmake.in" + "${CMAKE_BINARY_DIR}/cmake/deploy-qt-windows.cmake" @ONLY) + set(CPACK_PRE_BUILD_SCRIPTS ${CMAKE_BINARY_DIR}/cmake/deploy-qt-windows.cmake) + set(CPACK_PACKAGE_FILE_NAME "${COMPONENT_NAME_MAIN}-installer-win64") + set(CPACK_GENERATOR "InnoSetup") + set(CPACK_PACKAGE_ICON "${CMAKE_CURRENT_SOURCE_DIR}/resources/gpt4all.ico") + # Todo - extend this to all languages we want to support + set(GPT4ALL_DIST_LANGUAGES english) + set(GPT4ALL_ICON_FILE "${CMAKE_CURRENT_SOURCE_DIR}/icons/gpt4all-48.png") +elseif(${CMAKE_SYSTEM_NAME} MATCHES Darwin) + find_program(MACDEPLOYQT macdeployqt HINTS ${_qt_bin_dir}) + configure_file("${CMAKE_CURRENT_SOURCE_DIR}/cmake/deploy-qt-mac.cmake.in" + "${CMAKE_BINARY_DIR}/cmake/deploy-qt-mac.cmake" @ONLY) + set(CPACK_PRE_BUILD_SCRIPTS ${CMAKE_BINARY_DIR}/cmake/deploy-qt-mac.cmake) + set(CPACK_PACKAGE_FILE_NAME "${COMPONENT_NAME_MAIN}-installer-darwin") + set(CPACK_BUNDLE_NAME ${COMPONENT_NAME_MAIN}) + set(CPACK_GENERATOR "DragNDrop") + set(CPACK_PACKAGE_ICON "${CMAKE_CURRENT_SOURCE_DIR}/resources/gpt4all.icns") + set(CPACK_BUNDLE_ICON ${CPACK_PACKAGE_ICON}) + set(CPACK_PACKAGING_INSTALL_PREFIX "/Applications/gpt4all") + set(CPACK_INCLUDE_TOPLEVEL_DIRECTORY ON) + set(CPACK_DMG_DISABLE_APPLICATIONS_SYMLINK OFF) +endif() + +# Setup vars for CPack option config + +# Configure CPack options file (this sets up generator specfic behavior) +configure_file(gpt4allCPackOptions.cmake.in ${CMAKE_BINARY_DIR}/gpt4allCPackOptions.cmake) +set(CPACK_PROJECT_CONFIG_FILE ${CMAKE_BINARY_DIR}/gpt4allCPackOPtions.cmake) + +# Setup Cpack +include(CPack) +if(LINUX) + include(CPackIFW) + cpack_ifw_configure_component(${COMPONENT_NAME_MAIN} ESSENTIAL FORCED_INSTALLATION) + cpack_ifw_configure_component(${COMPONENT_NAME_MAIN} VERSION ${APP_VERSION}) + cpack_ifw_configure_component(${COMPONENT_NAME_MAIN} LICENSES "MIT LICENSE" ${CPACK_RESOURCE_FILE_LICENSE}) + cpack_ifw_configure_component(${COMPONENT_NAME_MAIN} SCRIPT "${CMAKE_CURRENT_SOURCE_DIR}/cmake/installer_component.qs") + cpack_ifw_configure_component(${COMPONENT_NAME_MAIN} REPLACES "gpt4all-chat") #Was used in very earliest prototypes +endif() diff --git a/gpt4all-chat/cmake/gpt4allCPackOptions.cmake.in b/gpt4all-chat/cmake/gpt4allCPackOptions.cmake.in new file mode 100644 index 00000000..81316b90 --- /dev/null +++ b/gpt4all-chat/cmake/gpt4allCPackOptions.cmake.in @@ -0,0 +1,37 @@ + + +# Configure Windows Installer Options + +#Setup innosetup +if(CPACK_GENERATOR ) + # Should be one of x86, x64, arm64, ia64 + set(CPACK_INNOSETUP_ARCHITECTURE @GPT4ALL_INSTALLER_ARCH@) + + # TODO (john): ask adam about this + set(CPACK_INNOSETUP_INSTALL_ROOT {%USERPROFILE}) + set(CPACK_INNOSETUP_ALLOW_CUSTOM_DIRECTORY ON) + set(CPACK_INNOSETUP_PROGRAM_MENU_FOLDER "gpt4all") + # ask adam if we want to support all options gpt4all supports + set(CPACK_INNOSETUP_LANGUAGES @GPT4ALL_DIST_LANGUAGES@) + set(CPACK_INNOSETUP_IGNORE_LICENSE_PAGE OFF) + set(CPACK_INNOSETUP_USE_MODERN_WIZARD ON) + set(CPACK_INNOSETUP_ICON_FILE @GPT4ALL_ICON_FILE@) + set(CPACK_INNOSETUP_CREATE_UNINSTALL_LINK ON) + set(CPACK_INNOSETUP_RUN_EXECUTABLES gpt4all) + set(CPACK_INNOSETUP_VERIFY_DOWNLOADS ON) +endif() + +# Configure MacOs installer Options + +# Setup DragNDrop (preferred) +if(CPACK_GENERATOR MATCHES "DragNDrop") + set(CPACK_DMG_FORMAT "UDBZ") + set(VERSION "${CPACK_PACKAGE_VERSION}") + # this also sets the volume name + set(CPACK_PACKAGE_FILE_NAME "${CPACK_PACKAGE_NAME}-installer-darwin") + # set(CPACK_INCLUDE_TOPLEVEL_DIRECTORY ON) + # TODO: uncomment the line below when we have an image + # maybe we want an applescript to mange ths instead? + # set(CPACK_DMG_BACKGROUND_IMAGE @CMAKE_SOURCE_DIR@/icons/) +endif() +