From 50c33629ab4c83b505bcb3efd3012ab6878dc0f0 Mon Sep 17 00:00:00 2001 From: Johann Rudloff Date: Thu, 23 Jan 2025 11:29:40 +0100 Subject: [PATCH] Ensure all links to udev rules file point to recent version The udev rules file `41-nitrokey.rules` is crucial to the devices' functioning under Linux. The canonical and maintained version of these rules seems to be the one at https://github.com/Nitrokey/nitrokey-udev-rules The documentation contained several links to older, unmaintained versions at different URLs, which are missing some recent fixes, e.g. [nitrokey-udev-rules PR #6](https://github.com/Nitrokey/nitrokey-udev-rules/pull/6). Make sure the documentation always links to the maintained version at https://raw.githubusercontent.com/Nitrokey/nitrokey-udev-rules/main/41-nitrokey.rules --- source/components/nitrokeys/features/fido2/website.rst | 2 +- source/components/nitrokeys/features/u2f/2fa.rst | 2 +- source/components/nitrokeys/features/u2f/desktop-login.rst | 2 +- source/components/nitrokeys/fido2/getting-started.rst | 2 +- source/components/nitrokeys/nitrokey3/firmware-update.rst | 2 +- source/components/nitrokeys/nitrokey3/troubleshooting.rst | 2 +- source/components/nitrokeys/pro/firmware-update.rst | 2 +- source/components/nitrokeys/start/getting-started.rst | 2 +- 8 files changed, 8 insertions(+), 8 deletions(-) diff --git a/source/components/nitrokeys/features/fido2/website.rst b/source/components/nitrokeys/features/fido2/website.rst index d11ecc28f3..b6975c5d04 100644 --- a/source/components/nitrokeys/features/fido2/website.rst +++ b/source/components/nitrokeys/features/fido2/website.rst @@ -168,7 +168,7 @@ Troubleshooting (Linux) - If the Nitrokey is not accepted immediately, you may need to copy this file - `41-nitrokey.rules `__ + `41-nitrokey.rules `__ to ``etc/udev/rules.d/``. In very rare cases, the system will need the `older version `__ diff --git a/source/components/nitrokeys/features/u2f/2fa.rst b/source/components/nitrokeys/features/u2f/2fa.rst index 06804b705e..7b7266c9ad 100644 --- a/source/components/nitrokeys/features/u2f/2fa.rst +++ b/source/components/nitrokeys/features/u2f/2fa.rst @@ -24,7 +24,7 @@ Troubleshooting (Linux) - If the Nitrokey is not accepted immediately, you may need to copy this file - `41-nitrokey.rules `__ + `41-nitrokey.rules `__ to ``etc/udev/rules.d/``. In very rare cases, the system will need the `older version `__ diff --git a/source/components/nitrokeys/features/u2f/desktop-login.rst b/source/components/nitrokeys/features/u2f/desktop-login.rst index 11a073e50b..9eca44b78f 100644 --- a/source/components/nitrokeys/features/u2f/desktop-login.rst +++ b/source/components/nitrokeys/features/u2f/desktop-login.rst @@ -90,7 +90,7 @@ CLI Method .. code-block:: bash $ cd /etc/udev/rules.d/ - $ sudo wget https://raw.githubusercontent.com/Nitrokey/libnitrokey/master/data/41-nitrokey.rules + $ sudo wget https://raw.githubusercontent.com/Nitrokey/nitrokey-udev-rules/main/41-nitrokey.rules And restart ``udev`` service diff --git a/source/components/nitrokeys/fido2/getting-started.rst b/source/components/nitrokeys/fido2/getting-started.rst index 5e08e1384e..10bf244773 100644 --- a/source/components/nitrokeys/fido2/getting-started.rst +++ b/source/components/nitrokeys/fido2/getting-started.rst @@ -182,7 +182,7 @@ Troubleshooting (Linux) If the Nitrokey is not detected, proceed the following: 1. Copy this file - `41-nitrokey.rules `__ + `41-nitrokey.rules `__ to ``/etc/udev/rules.d/``. In very rare cases, the system will need the `older version `__ diff --git a/source/components/nitrokeys/nitrokey3/firmware-update.rst b/source/components/nitrokeys/nitrokey3/firmware-update.rst index 8a4f0442da..102196646e 100644 --- a/source/components/nitrokeys/nitrokey3/firmware-update.rst +++ b/source/components/nitrokeys/nitrokey3/firmware-update.rst @@ -101,4 +101,4 @@ Troubleshooting (Linux): your machine. Afterwards the update should work without the permission issue. -.. _udev-rules: https://raw.githubusercontent.com/Nitrokey/libnitrokey/master/data/41-nitrokey.rules +.. _udev-rules: https://raw.githubusercontent.com/Nitrokey/nitrokey-udev-rules/main/41-nitrokey.rules diff --git a/source/components/nitrokeys/nitrokey3/troubleshooting.rst b/source/components/nitrokeys/nitrokey3/troubleshooting.rst index f74d5df7b7..1aeff04d91 100644 --- a/source/components/nitrokeys/nitrokey3/troubleshooting.rst +++ b/source/components/nitrokeys/nitrokey3/troubleshooting.rst @@ -10,7 +10,7 @@ Nitrokey is Not Detected on Linux If the Nitrokey is not detected, proceed as follows: 1. Copy this file - `41-nitrokey.rules `__ + `41-nitrokey.rules `__ to ``/etc/udev/rules.d/``. 2. Restart udev via ``sudo service udev restart`` or ``udevadm control --reload-rules && udevadm trigger`` if you are using Fedora. diff --git a/source/components/nitrokeys/pro/firmware-update.rst b/source/components/nitrokeys/pro/firmware-update.rst index ff81ce142f..d06b3f3aeb 100644 --- a/source/components/nitrokeys/pro/firmware-update.rst +++ b/source/components/nitrokeys/pro/firmware-update.rst @@ -93,4 +93,4 @@ Linux Permission error your machine. Afterwards the update should work without the permission issue. -.. _udev-rules: https://raw.githubusercontent.com/Nitrokey/libnitrokey/master/data/41-nitrokey.rules +.. _udev-rules: https://raw.githubusercontent.com/Nitrokey/nitrokey-udev-rules/main/41-nitrokey.rules diff --git a/source/components/nitrokeys/start/getting-started.rst b/source/components/nitrokeys/start/getting-started.rst index 86f3df6122..8d85d552b9 100644 --- a/source/components/nitrokeys/start/getting-started.rst +++ b/source/components/nitrokeys/start/getting-started.rst @@ -79,5 +79,5 @@ the UDEV rules: .. code-block:: bash - wget https://raw.githubusercontent.com/Nitrokey/libnitrokey/master/data/41-nitrokey.rules + wget https://raw.githubusercontent.com/Nitrokey/nitrokey-udev-rules/main/41-nitrokey.rules sudo mv 41-nitrokey.rules /etc/udev/rules.d/