Skip to content

Commit

Permalink
Ensure all links to udev rules file point to recent version
Browse files Browse the repository at this point in the history
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 Nitrokey#6](Nitrokey/nitrokey-udev-rules#6).

Make sure the documentation always links to the maintained version at
https://raw.githubusercontent.com/Nitrokey/nitrokey-udev-rules/main/41-nitrokey.rules
  • Loading branch information
cypheon committed Jan 23, 2025
1 parent 0528470 commit 5f562c3
Show file tree
Hide file tree
Showing 8 changed files with 8 additions and 8 deletions.
2 changes: 1 addition & 1 deletion source/components/nitrokeys/features/fido2/website.rst
Original file line number Diff line number Diff line change
Expand Up @@ -168,7 +168,7 @@ Troubleshooting (Linux)

- If the Nitrokey is not accepted immediately, you may need to copy
this file
`41-nitrokey.rules <https://www.nitrokey.com/sites/default/files/41-nitrokey.rules>`__
`41-nitrokey.rules <https://raw.githubusercontent.com/Nitrokey/nitrokey-udev-rules/main/41-nitrokey.rules>`__
to ``etc/udev/rules.d/``. In very rare cases, the system will need
the `older
version <https://raw.githubusercontent.com/Nitrokey/libnitrokey/master/data/41-nitrokey_old.rules>`__
Expand Down
2 changes: 1 addition & 1 deletion source/components/nitrokeys/features/u2f/2fa.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Troubleshooting (Linux)

- If the Nitrokey is not accepted immediately, you may need to copy
this file
`41-nitrokey.rules <https://www.nitrokey.com/sites/default/files/41-nitrokey.rules>`__
`41-nitrokey.rules <https://raw.githubusercontent.com/Nitrokey/nitrokey-udev-rules/main/41-nitrokey.rules>`__
to ``etc/udev/rules.d/``. In very rare cases, the system will need
the `older
version <https://raw.githubusercontent.com/Nitrokey/libnitrokey/master/data/41-nitrokey_old.rules>`__
Expand Down
2 changes: 1 addition & 1 deletion source/components/nitrokeys/features/u2f/desktop-login.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion source/components/nitrokeys/fido2/getting-started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -182,7 +182,7 @@ Troubleshooting (Linux)
If the Nitrokey is not detected, proceed the following:

1. Copy this file
`41-nitrokey.rules <https://www.nitrokey.com/sites/default/files/41-nitrokey.rules>`__
`41-nitrokey.rules <https://raw.githubusercontent.com/Nitrokey/nitrokey-udev-rules/main/41-nitrokey.rules>`__
to ``/etc/udev/rules.d/``. In very rare cases, the system will need
the `older
version <https://raw.githubusercontent.com/Nitrokey/libnitrokey/master/data/41-nitrokey_old.rules>`__
Expand Down
2 changes: 1 addition & 1 deletion source/components/nitrokeys/nitrokey3/firmware-update.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
2 changes: 1 addition & 1 deletion source/components/nitrokeys/nitrokey3/troubleshooting.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://www.nitrokey.com/sites/default/files/41-nitrokey.rules>`__
`41-nitrokey.rules <https://raw.githubusercontent.com/Nitrokey/nitrokey-udev-rules/main/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.

Expand Down
2 changes: 1 addition & 1 deletion source/components/nitrokeys/pro/firmware-update.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
2 changes: 1 addition & 1 deletion source/components/nitrokeys/start/getting-started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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/refs/heads/main/41-nitrokey.rules
sudo mv 41-nitrokey.rules /etc/udev/rules.d/

0 comments on commit 5f562c3

Please sign in to comment.