Documentation
    Preparing search index...

    Interface MakerSquirrelConfig

    interface MakerSquirrelConfig {
        authors?: string;
        certificateFile?: string;
        certificatePassword?: string;
        copyright?: string;
        description?: string;
        exe?: string;
        fixUpPaths?: boolean;
        frameworkVersion?: string;
        iconUrl?: string;
        loadingGif?: string;
        name?: string;
        noDelta?: boolean;
        noMsi?: boolean;
        nuspecTemplate?: string;
        owners?: string;
        remoteReleases?: string;
        remoteToken?: string;
        setupExe?: string;
        setupIcon?: string;
        setupMsi?: string;
        signWithParams?: string;
        skipUpdateIcon?: boolean;
        title?: string;
        usePackageJson?: boolean;
        vendorDirectory?: string;
        version?: string;
        windowsSign?: SignToolOptions;
    }

    Hierarchy

    • Omit<ElectronWinstallerOptions, "appDirectory" | "outputDirectory">
      • MakerSquirrelConfig
    Index

    Properties

    authors? certificateFile? certificatePassword? copyright? description? exe? fixUpPaths? frameworkVersion? iconUrl? loadingGif? name? noDelta? noMsi? nuspecTemplate? owners? remoteReleases? remoteToken? setupExe? setupIcon? setupMsi? signWithParams? skipUpdateIcon? title? usePackageJson? vendorDirectory? version? windowsSign?

    Properties

    authors?: string

    The authors value for the NuGet package metadata.

    the author field from your app's package.json file unless usePackageJson is false.

    the Microsoft .nuspec reference.

    certificateFile?: string

    The path to an Authenticode Code Signing Certificate.

    This is a legacy parameter provided for backwards compatibility. For more comprehensive support of various codesigning scenarios like EV certificates, see the windowsSign parameter.

    certificatePassword?: string

    The password to decrypt the certificate given in certificateFile

    This is a legacy parameter provided for backwards compatibility. For more comprehensive support of various codesigning scenarios like EV certificates, see the windowsSign parameter.

    copyright?: string

    The copyright value for the NuGet package metadata.

    a generated copyright with authors or owners.

    the Microsoft .nuspec reference.

    description?: string

    The description value for the NuGet package metadata.

    the description field from your app's package.json file unless usePackageJson is false.

    the Microsoft .nuspec reference.

    exe?: string

    The name of your app's main .exe file.

    the name field in your app's package.json file with an added .exe extension unless usePackageJson is false.

    fixUpPaths?: boolean

    Attempt to create more descriptive installer names using metadata parameters.

    false
    frameworkVersion?: string

    Set the required .NET framework version (e.g. net461).

    iconUrl?: string

    A publicly accessible, fully qualified HTTP(S) URL to an ICO file, used as the application icon displayed in Control Panel ➡ Programs and Features. The icon is retrieved at install time. Example: http://example.com/favicon.ico

    Does not accept file: URLs.

    the Electron icon.
    loadingGif?: string

    The local path to a .gif file to display during install.

    the bundled install-spinner.gif

    name?: string

    Windows Application Model ID (appId).

    the name field in your app's package.json file unless usePackageJson is false.

    Microsoft's Application User Model IDs documentation.

    noDelta?: boolean

    Enable this flag to prevent Squirrel.Windows from creating delta packages (disable only if necessary, they are a Good Thing).

    false
    noMsi?: boolean

    Enable this flag to prevent Squirrel.Windows from creating an MSI installer.

    false
    nuspecTemplate?: string

    The path to the .nuspectemplate file used by Squirrel.exe.

    the bundled template.nuspectemplate.

    owners?: string

    The owners value for the NuGet package metadata.

    the authors field from your app's package.json file unless usePackageJson is false.

    the Microsoft .nuspec reference.

    remoteReleases?: string

    A URL to your existing updates. If given, these will be downloaded to create delta updates.

    remoteToken?: string

    Authentication token for remote updates using remoteReleases

    setupExe?: string

    The name to use for the generated Setup.exe file

    the productName field from your app's package.json file unless usePackageJson is false.

    setupIcon?: string

    The ICO file to use as the icon for the generated Setup.exe

    setupMsi?: string

    The name to use for the generated Setup.msi file

    the productName field from your app's package.json file unless usePackageJson is false.

    signWithParams?: string

    Params to pass to signtool.

    Overrides certificateFile and certificatePassword`.

    This is a legacy parameter provided for backwards compatibility. For more comprehensive support of various codesigning scenarios like EV certificates, see the windowsSign parameter.

    skipUpdateIcon?: boolean

    Enable this flag to skip setting a custom icon for Update.exe

    false
    title?: string

    The title value for the nuget package metadata.

    the productName field and then the name field from your app's package.json file unless usePackageJson is false.

    the Microsoft .nuspec reference.

    usePackageJson?: boolean

    Whether or not to infer metadata options from your app's package.json file.

    true
    vendorDirectory?: string

    The folder path of Squirrel windows

    version?: string

    The version value for the Nuget package metadata.

    the version field from your app's package.json file unless usePackageJson is false.

    the Microsoft .nuspec reference.

    windowsSign?: SignToolOptions

    Requires Node.js 18 or newer.

    Sign your app with @electron/windows-sign, allowing for full customization of the code-signing process - and supports more complicated scenarios like cloud-hosted EV certificates, custom sign pipelines, and per-file overrides. It also supports all existing "simple" codesigning scenarios, including just passing a certificate file and password.

    @electron/windows-sign documentation for all possible configuration options.

    Settings

    Member Visibility

    On This Page

    Properties