Skip to content

Commit e5b3625

Browse files
committed
update README
1 parent f17104c commit e5b3625

2 files changed

Lines changed: 43 additions & 1 deletion

File tree

Config.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -237,7 +237,7 @@ public class SigningConfig : ITomlMetadataProvider
237237

238238
/// <summary>
239239
/// Sign all files embedded in the MSI as well. This includes Program files and DLLs of the App you're shipping unless they are already signed.
240-
/// Note: The signing is performed in place on your source files, so make sure to have backups if needed.
240+
/// Note: The signing is performed in a subdirectory which is not cleaned up automatically. You may want to delete it manually after the build.
241241
/// </summary>
242242
[DataMember(Name = "sign_embedded")]
243243
public bool? SignEmbeddedFiles { get; set; }

README.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -126,6 +126,8 @@ Usage:
126126
Options:
127127
-c, --config <config> Path to configuration file
128128
-vf, --grab-version-from-file <grab-version-from-file> EXE/DLL File to grab Version from
129+
-cn, --certificate-name <certificate-name> Name of the code signing certificate to use
130+
-cp, --certificate-password <certificate-password> Password of the code signing certificate
129131
-v, --version <version> Version of the app
130132
-p, --platform <arm32|arm64|x64|x86> Platform the installer should run on
131133
-o, --output-file <output-file> Output file path
@@ -287,6 +289,46 @@ source_dirs = [".\\app\\*.*"]
287289
# The default is true.
288290
source_dirs_are_recursive = true
289291

292+
# Code signing configuration.
293+
[install.signing]
294+
295+
# The name of the code signing certificate to use.
296+
# This can be the path to a PFX file or the name of a certificate in the Windows Certificate Store.
297+
cert_name = "ExampleCert.pfx"
298+
299+
# The password for the code signing certificate.
300+
# This will be shown in the UAC prompt during installation.
301+
# If this isn't set, the UAC prompt will use the filename instead.
302+
description = "ExampleApp Installer"
303+
304+
# The URL of the timestamp server to use for code signing.
305+
# The example uses Microsoft's free timestamp server.
306+
time_url = "http://timestamp.acs.microsoft.com"
307+
308+
# Type of the certificate store. May be "sha1", "name" or "pfx". Defaults to "pfx".
309+
# pfx is used for PFX files, "name" and "sha1" are used for certificates in the Windows Certificate Store.
310+
# sha1 identifies the certificate by its hash, "name" by its common name.
311+
store_type = "pfx"
312+
313+
# The hashing algorithm to use for code signing. May be "sha1" or "sha256".
314+
# sha256 is recommended for better security and the default.
315+
algorithm = "sha256"
316+
317+
# Whether to sign embedded files as well.
318+
# The default is false.
319+
# This includes Program files and DLLs of the App you're shipping unless they are already signed.
320+
# Note: The signing is performed in a subdirectory which is not cleaned up automatically.
321+
sign_embedded = true
322+
323+
# Folders to search for signtool.exe if not found in PATH.
324+
# This is only required if signtool.exe is not in PATH.
325+
# You can provide multiple locations by splitting them with semicolons (;).
326+
signtool_location = "C:\\Program Files (x86)\\Windows Kits\\10\\bin\\10.0.22621.0\\x64\\"
327+
328+
# Extra arguments to pass to signtool.exe during code signing.
329+
# The provided example selects the machine store instead of the user certificate store.
330+
extra_arguments = "/sm"
331+
290332
# Environment variables to set during installation.
291333
[[install.env_vars]]
292334

0 commit comments

Comments
 (0)