Hyperlinks nightly (#478)

* Add hyperlink check for nightly runs

* Add nightly CI pipeline

* Fix hyperlinks in NetHSM docs

* Fix hyperlinks in NextBox docs

* Fix hyperlinks in Nitrokey docs

* Fix hyperlinks in software docs

* Add error exceptions for urls

Author: mmerklinger

.github/workflows/ci_nightly.yml

@@ -0,0 +1,17 @@
+name: CI - Nightly
+on:
+  schedule:
+    - cron: '0 2 * * *'
+
+jobs:
+  check-hyperlinks:
+    name: Check hyperlinks
+    runs-on: ubuntu-latest
+    container: python:3.11
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v3
+      - name: Create virtual environment
+        run: make venv
+      - name: Check hyperlinks
+        run: make check-hyperlinks-nightly

Makefile

@@ -26,6 +26,10 @@ check-syntax: venv
 check-hyperlinks: venv docs
 	venv/bin/linkchecker -f linkcheckerrc dist/en/index.html
 
+.PHONE: check-hyperlinks-nightly
+check-hyperlinks-nightly: venv docs
+	venv/bin/linkchecker -f linkcheckerrc_nightly dist/en/index.html
+
 .PHONY: pkg
 pkg: venv docs
 	mv dist/en/_images dist/_images

linkcheckerrc_nightly

@@ -0,0 +1,21 @@
+[filtering]
+checkextern=1
+ignore=
+  (?m)/(de|fr|es|nl|it|ja|ru|el|da|bg|et|fi|lv|lt|pl|pt|ro|sv|sk|sl|cs|hu|zh_CN)+/
+
+[checking]
+threads=1
+
+[output]
+warnings=0
+ignoreerrors=
+  ^http://nextbox\.local$
+  ^http[s]{0,1}://localhost
+  ^http[s]{0,1}://localhost:[1-9][0-9]*
+  ^http[s]{0,1}://192\.168\.[0-9]+\.[1-9]+
+  # expects the HTTP header "Accept: text/html", otherwise returns an HTTP error 404
+  # https://github.com/rust-lang/crates.io/issues/788
+  ^https://crates.io/
+  # return a HTTP error 403 for cli access, browser works
+  ^https://www.raspberrypi.com/documentation
+

source/components/nethsm/container/production-image.rst

@@ -10,7 +10,7 @@ The image is subject to some feature restrictions in comparison to the NetHSM ha
 Please refer to chapter `Image Feature Restrictions <image-feature-restrictions.html>`__ to learn more.
 
 The NetHSM production container is a product for paying customers only and can be purchased `here <https://www.nitrokey.com/contact>`__.
-The image can be obtained from `Nitrokey NetHSM registry <https://registry.git.nitrokey.com/distribution/nethsm>`_ using the credentials provided after purchase.
+The image can be obtained from Nitrokey NetHSM registry ``https://registry.git.nitrokey.com/distribution/nethsm>`` using the credentials provided after purchase.
 
 .. warning::
    The security of the NetHSM software container strongly depends on the platform's security.

source/components/nethsm/opendnssec.rst

@@ -3,7 +3,7 @@ OpenDNSSEC
 
 `OpenDNSSEC <https://www.opendnssec.org/>`__ is a tool suite for managing the security of domain names. It can directly load a PKCS#11 module and manage the keys.
 
-To install and setup OpenDNSSEC, you can follow the `OpenDNSSEC Quick Start Guide <https://wiki.opendnssec.org/display/DOCS20/Quick+start+guide>`__. You don't need to install ``SoftHSM``, the NetHSM PKCS#11 module will be used instead.
+To install and setup OpenDNSSEC, you can follow the `OpenDNSSEC Quick Start Guide <https://opendnssec.readthedocs.io/en/latest/quickstart/>`__. You don't need to install ``SoftHSM``, the NetHSM PKCS#11 module will be used instead.
 
 As OpenDNSSEC needs access to manage the keys and then use them, you will need to configure both administrator and operator account in the PKCS#11 module configuration file.
 

source/components/nextbox/faq/hardware.rst

@@ -7,7 +7,8 @@ Hardware FAQ
 .. faq:: Why must I not connect external hard-drives without an external power-supply to my NextBox?
 
   The Raspberry Pi 4 Model B can only supply 1.2A of power through USB (see
-  `RPi Power Supply`_). The internal hard-drive is already connected and powered
+  `RPi Power Supply <https://www.raspberrypi.com/documentation/computers/raspberry-pi.html#typical-power-requirements>`__).
+  The internal hard-drive is already connected and powered
   via USB and pulls ~1.0A. Thus connecting another hard-drive without an
   external power supply can lead to an unreliable power supply for the internal
   hard-drive, thus potential data loss.
@@ -74,5 +75,4 @@ Hardware FAQ
 .. _USB Documentation: https://www.raspberrypi.com/documentation/computers/raspberry-pi.html#universal-serial-bus-usb
 .. _NextBox' GitHub: https://github.com/Nitrokey/nextbox-board
 .. _External storage support: https://docs.nextcloud.com/server/20/admin_manual/configuration_files/external_storage_configuration_gui.html
-.. _RPi Power Supply: https://www.raspberrypi.com/documentation/computers/raspberry-pi.html#power-supply
 

source/components/nextbox/remote/dynamic-dns.rst

@@ -49,9 +49,8 @@ using `ddclient`_, which can be directly configured here or via the *Guided
 DNS* method described before.
 
 In this configuration you need the provide the *domain* this configuration is
-enabling and the contents of the `ddclient.conf` used by `ddclient`_. Various
-examples can be found at the `official documentation`_, the one used for the
-guided DNS configuration uses the following template:
+enabling and the contents of the `ddclient.conf` used by `ddclient`_.
+The one used for the guided DNS configuration uses the following template:
 
 .. code-block:: none
 
@@ -84,7 +83,6 @@ just click **Enable TLS** to acquire your TLS certificate.
 .. _reset password: https://desec.io/reset-password
 .. _token management: https://desec.io/tokens
 .. _ddclient: https://ddclient.net/
-.. _official documentation: https://ddclient.net/usage.html
 
 
 .. There are several ways to enable remote access to the NextBox. The easiest way is to use the "Quickstart Configuration".

source/components/nitrokeys/features/hsm/n-of-m-schemes.rst

@@ -38,7 +38,7 @@ Nitrokey HSM's M-of-N Threshold Scheme:
 N-of-m for public key authentication
 ''''''''''''''''''''''''''''''''''''
 
-So far n-of-m authentication is only supported in OpenSCDP. `The blog post <https://www.smartcard-hsm.com/2015/10/10/Shared_Control_over_Key_Usage.html>`__ gives an overview and a how-to `here <https://devnet.cardcontact.de/documents/7>`__ (CDN access required) is shown the process step by step in the Smart Card Shell.
+So far n-of-m authentication is only supported in OpenSCDP. `The blog post <https://www.smartcard-hsm.com/2015/10/10/Shared_Control_over_Key_Usage.html>`__ gives an overview and a how-to `here <https://www.cardcontact.de/download/n-of-m_Authentication_HowTo_V1_2015-09-07.pdf>`__ is shown the process step by step in the Smart Card Shell.
 
 N-of-m authentication is also supported in the `PKI-as-a-Service Portal <https://www.smartcard-hsm.com/2018/02/13/pki-as-a-service.html>`__ for locally and remote connected HSMs. The PKI-as-a-Service Portal is based on OpenSCDP.
 

source/components/nitrokeys/features/openpgp-card/hard-disk-encryption/index.rst

@@ -51,7 +51,7 @@ For setting up LUKS Disk Encryption follow our guide:
 	Full-Disk Encryption With cryptsetup/LUKS <luks>
 
 
-Purism has created a `simple script <https://docs.puri.sm/PureBoot/LibremKeyLUKS.html>`__ to add the Nitrokey/LibremKey as a way to unlock LUKS partitions (not tested by Nitrokey yet).
+Purism has created a `simple script <https://docs.puri.sm/Hardware/Librem_Key/LUKS.html>`__ to add the Nitrokey/LibremKey as a way to unlock LUKS partitions (not tested by Nitrokey yet).
 
 `This project <https://github.com/artosan/nitroluks/>`__ aims to ease the use of LUKS with the Nitrokey Pro or Storage based on the Password Safe (not tested by Nitrokey yet). A description on how to use it on Gentoo can be found `here <https://amedeos.github.io/gentoo/nitrokey/2019/01/21/gentoo-nitrokey-luks.html>`__.
 

source/components/nitrokeys/fido2/firmware-update.rst

@@ -33,6 +33,5 @@ In case of any errors please take the logs from ``/tmp`` directory (``/tmp/nitro
 
 
 
-.. _installation instructions: /software/nitropy/all-platforms/installation.html
-
+.. _installation instructions: ../../software/nitropy/all-platforms/installation.html