Update to use the signed windows installer

vkbo · Sep 18, 2024 · 67db4bf · 67db4bf
1 parent 6f93dd5
commit 67db4bf
Show file tree

Hide file tree

Showing 12 changed files with 43 additions and 49 deletions.
diff --git a/source/download/help_win.rst b/source/download/help_win.rst
@@ -6,10 +6,19 @@ Installing on Windows
 
 .. _GitHub Releases: https://github.com/vkbo/novelWriter/releases
 .. _SHA256: https://en.wikipedia.org/wiki/SHA-2
+.. _SignPath.io: https://about.signpath.io/
+.. _SignPath Foundation: https://signpath.org/
 
-The novelWriter installer is not signed, so you will therefore be presented with security warnings
-when trying to install it on your PC. All this means is that Windows doesn't know who created the
-install file.
+As of release 2.5.2, the novelWriter installer for Windows is signed by the `SignPath Foundation`_.
+Earlier versions were not, and will warn that the installers are not signed.
+
+However, even if the installer is signed, your browser may issue a warning that the application
+isn't commonly downloaded. In for instance Edge, you can click the three dots next to the download
+and select "Keep". You may have to also click "Show more" and "Keep anyway."
+
+.. figure:: ../images/help_win11_dl.png
+
+If you use another browser, you may see a similar warning.
 
 Knowing where you download software from is important, so make sure you **only** download the
 installer from either here on the novelwriter.io website, or directly from the project's
@@ -24,38 +33,6 @@ installer from either here on the novelwriter.io website, or directly from the p
    the :ref:`Home <main_home>` page or the :ref:`main_download` page. You can also download the
    ``.sha256`` file on the `GitHub Releases`_ page alongside the installer.
 
-In order to get rid of the "Unknown Publisher" warnings in Windows, I would have to buy a code
-signing certificate that Microsoft accepts. They cost several hundred US dollars per year -- for
-the cheap ones. This is a free app, and there is nowhere near enough donations made to this project
-to pay for that at this point.
-
-Sometimes, Windows will try to prevent you from installing unknown applications. Below is a quick
-guide on how to disable the block for the novelWriter installer file.
-
-
-Windows 11 and Windows Defender
-===============================
-
-When you've downloaded the installer, and try to run it, Windows Defender may not allow you to run
-it. This is due to the missing signature, as mentioned above.
-
-You can explicitly unblock the installer by going to your Downloads folder, find the novelWriter
-installer file, right click it, and select **"Properties"**.
-
-.. figure:: ../images/help_win11_a.png
-
-In the **"Properties"** window that opens up, make sure you're on the **"General"** tab, and check
-the **"Unblock"** check box at the bottom next to **"Security"**.
-
-.. figure:: ../images/help_win11_b.png
-
-You should now be able to run the installer.
-
-It will still show you this notification when you start the installation, again reminding you that
-the installer is from an **"Unknown Publisher"**. Select **"Yes"** to continue.
-
-.. figure:: ../images/help_win11_c.png
-
 
 .. _main_install_win_content:
 

diff --git a/source/generated/checksum_block.rst b/source/generated/checksum_block.rst
@@ -6,7 +6,7 @@ Sha256 Checksums
 * | **Debian Package:** novelwriter_2.5.2_all.deb
   | Sha256: ``ccb1c82671d1ce53ced1c05efbe1edf21a0b339d65d4ea3291285762c996f06c`` :octicon:`download` `ShaSum File <https://github.com/vkbo/novelWriter/releases/download/v2.5.2/novelwriter_2.5.2_all.deb.sha256>`__
 * | **Windows Installer:** novelwriter-2.5.2-amd64-setup.exe
-  | Sha256: ``2075b5119d16f0a22a662b7006c19887eaccd5b31f26fe6324dc220cd95280c9`` :octicon:`download` `ShaSum File <https://github.com/vkbo/novelWriter/releases/download/v2.5.2/novelwriter-2.5.2-amd64-setup.exe.sha256>`__
+  | Sha256: ``77af1e1220c1fce9571cb3931802e4b479a78e5aa2ceada0a388e3e60c0c8c7d`` :octicon:`download` `ShaSum File <https://github.com/vkbo/novelWriter/releases/download/v2.5.2/novelwriter-2.5.2-amd64-setup.exe.sha256>`__
 * | **MacOS DMG Image (Intel):** novelWriter-2.5.2-x86_64.dmg
   | Sha256: ``8e9dd98896adfdfc30d9222b4798d86ce6ba82e8eccb319b7e52c40d76448652`` :octicon:`download` `ShaSum File <https://github.com/vkbo/novelWriter/releases/download/v2.5.2/novelWriter-2.5.2-x86_64.dmg.sha256>`__
 * | **MacOS DMG Image (M1):** novelWriter-2.5.2-aarch64.dmg

diff --git a/source/generated/download_block.rst b/source/generated/download_block.rst
@@ -46,7 +46,7 @@ Latest Release
             :columns: 7
 
             | **Download**
-            | :octicon:`download` `Setup Installer <https://github.com/vkbo/novelWriter/releases/download/v2.5.2/novelwriter-2.5.2-amd64-setup.exe>`__
+            | :octicon:`download` `Setup Installer <https://github.com/vkbo/novelWriter/releases/download/v2.5.2/novelwriter-2.5.2-amd64-setup.exe>`__\*
             | :octicon:`light-bulb` :ref:`Install Help <main_install_windows>`
 
          .. grid-item::

diff --git a/source/generated/download_release.rst b/source/generated/download_release.rst
@@ -3,6 +3,8 @@
 .. _Debian: https://www.debian.org/
 .. _Linux Mint: https://linuxmint.com/
 .. _novelWriter Repository: https://github.com/vkbo/novelWriter/
+.. _SignPath.io: https://about.signpath.io/
+.. _SignPath Foundation: https://signpath.org/
 
 | **Release Version:** Version 2.5.2
 | **Release Date:** September 17, 2024
@@ -13,11 +15,13 @@ Linux
 -----
 
 **AppImage**
-   The AppImage should run on any recent Linux distro. See the `AppImage website`_ for more info.
+   The AppImage should run on any recent Linux distro. See the 
 
    | **Download:** :octicon:`download` `novelWriter-2.5.2.AppImage <https://github.com/vkbo/novelWriter/releases/download/v2.5.2/novelWriter-2.5.2.AppImage>`__ [ 93.9 MB ]
    | **Checksum:** :octicon:`hash` ``0448282b3404f1e31bc7e79cf9aa1329758b8352ff8d1729e41b1ae20d8d1703`` :octicon:`download` `ShaSum File <https://github.com/vkbo/novelWriter/releases/download/v2.5.2/novelWriter-2.5.2.AppImage.sha256>`__
 
+   `AppImage website`_ for more info.
+
 **Debian Package**
    The package is built for Debian_, but should also work for Ubuntu_ and `Linux Mint`_.
 
@@ -32,7 +36,9 @@ Windows
    This is a standard setup installer for Windows. It is made for Windows 10 or newer.
 
    | **Download:** :octicon:`download` `novelwriter-2.5.2-amd64-setup.exe <https://github.com/vkbo/novelWriter/releases/download/v2.5.2/novelwriter-2.5.2-amd64-setup.exe>`__ [ 46.1 MB ]
-   | **Checksum:** :octicon:`hash` ``2075b5119d16f0a22a662b7006c19887eaccd5b31f26fe6324dc220cd95280c9`` :octicon:`download` `ShaSum File <https://github.com/vkbo/novelWriter/releases/download/v2.5.2/novelwriter-2.5.2-amd64-setup.exe.sha256>`__
+   | **Checksum:** :octicon:`hash` ``77af1e1220c1fce9571cb3931802e4b479a78e5aa2ceada0a388e3e60c0c8c7d`` :octicon:`download` `ShaSum File <https://github.com/vkbo/novelWriter/releases/download/v2.5.2/novelwriter-2.5.2-amd64-setup.exe.sha256>`__
+
+   Free code signing provided by `SignPath.io`_, certificate by `SignPath Foundation`_.
 
 
 MacOS

diff --git a/source/images/help_win11_a.png b/source/images/help_win11_a.png
diff --git a/source/images/help_win11_b.png b/source/images/help_win11_b.png
diff --git a/source/images/help_win11_c.png b/source/images/help_win11_c.png
diff --git a/source/images/help_win11_dl.png b/source/images/help_win11_dl.png
diff --git a/source/index.rst b/source/index.rst
@@ -1,12 +1,15 @@
 :html_theme.sidebar_secondary.remove:
 
-.. _main_home:
+.. _SignPath.io: https://about.signpath.io/
+.. _SignPath Foundation: https://signpath.org/
 
 .. div:: main-page-icon
 
    .. image:: _static/novelwriter-icon.svg
       :class: dark-light
 
+.. _main_home:
+
 ***********
 novelWriter
 ***********
@@ -52,6 +55,8 @@ novelWriter
 
 .. include:: generated/download_block.rst
 
+\* Free code signing on Windows is provided by `SignPath.io`_, certificate by `SignPath Foundation`_.
+
 
 Other Install Options
 ---------------------

diff --git a/templates/download_block.rst b/templates/download_block.rst
@@ -46,7 +46,7 @@ Latest Release
             :columns: 7
 
             | **Download**
-            | :octicon:`download` `Setup Installer <{winexe_download}>`__
+            | :octicon:`download` `Setup Installer <{winexe_download}>`__\*
             | :octicon:`light-bulb` :ref:`Install Help <main_install_windows>`
 
          .. grid-item::

diff --git a/templates/download_release.rst b/templates/download_release.rst
@@ -3,6 +3,8 @@
 .. _Debian: https://www.debian.org/
 .. _Linux Mint: https://linuxmint.com/
 .. _novelWriter Repository: https://github.com/vkbo/novelWriter/
+.. _SignPath.io: https://about.signpath.io/
+.. _SignPath Foundation: https://signpath.org/
 
 | **Release Version:** {release_version}
 | **Release Date:** {release_date}

diff --git a/tools/assets.py b/tools/assets.py
@@ -34,35 +34,36 @@ class AssetOS(Enum):
 # END Enum AssetOS
 
 
-ASSET_TEXT = {
+ASSET_TEXT: dict[AssetType, tuple[str, ...]] = {
     AssetType.APP_IMAGE: (
         "AppImage",
-        "The AppImage should run on any recent Linux distro. See the "
+        "The AppImage should run on any recent Linux distro. See the ",
         "`AppImage website`_ for more info."
     ),
     AssetType.APP_IMAGE_OLD: (
         "AppImage (Legacy)",
-        "For older Linux distros you may need to download this AppImage instead."
+        "For older Linux distros you may need to download this AppImage instead.",
     ),
     AssetType.DEBIAN: (
         "Debian Package",
-        "The package is built for Debian_, but should also work for Ubuntu_ and `Linux Mint`_."
+        "The package is built for Debian_, but should also work for Ubuntu_ and `Linux Mint`_.",
     ),
     AssetType.WINDOWS_EXE: (
         "Setup Installer",
-        "This is a standard setup installer for Windows. It is made for Windows 10 or newer."
+        "This is a standard setup installer for Windows. It is made for Windows 10 or newer.",
+        "Free code signing is provided by `SignPath.io`_, certificate by `SignPath Foundation`_.",
     ),
     AssetType.MAC_DMG_INTEL: (
         "DMG Image for Intel",
-        "This is a DMG image for MacOS with x86_64 architecture. It is built on MacOS 12."
+        "This is a DMG image for MacOS with x86_64 architecture. It is built on MacOS 12.",
     ),
     AssetType.MAC_DMG_ARM: (
         "DMG Image for Apple Silicon (M1)",
-        "This is a DMG image for MacOS with aarch64 architecture. It is built on MacOS 14."
+        "This is a DMG image for MacOS with aarch64 architecture. It is built on MacOS 14.",
     ),
     AssetType.PYTHON_WHEEL: (
         "Python Wheel",
-        "The Wheel package can be installed with ``pip install <file_path>``."
+        "The Wheel package can be installed with ``pip install <file_path>``.",
     ),
 }
 
@@ -231,6 +232,9 @@ def appendType(aType, target):
                 f":octicon:`download` `ShaSum File <{asset.assetShaSumUrl}>`__"
             )
             target.append("")
+            if len(ASSET_TEXT[aType]) > 2:
+                target.append(f"   {ASSET_TEXT[aType][2]}")
+                target.append("")
             return
 
         buffer = []