diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 7c8274e0cd..aa9ceda755 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -57,6 +57,23 @@ jobs: run: make venv - name: Check hyperlinks run: make check-hyperlinks + check-spelling: + name: Check spelling + runs-on: ubuntu-latest + container: python:3.11 + steps: + - name: Checkout repository + uses: actions/checkout@v6 + - name: Install required packages + run: | + apt update + apt install -y libenchant-2-2 + - name: Create virtual environment + run: make venv + - name: Check spelling + run: | + make check-spelling SKIP_ADD_SPELLINGS=1 + if [ -z "$(find . -name '*.spelling')" ]; then exit 0; else exit 1; fi build-check-foreign: if: ${{ github.event.pull_request.head.repo.owner.login != 'nitrokey' }} name: Check Build for Foreign Repository diff --git a/source/components/nethsm/administration.rst b/source/components/nethsm/administration.rst index 4ea42befa7..50d8c9a61a 100644 --- a/source/components/nethsm/administration.rst +++ b/source/components/nethsm/administration.rst @@ -491,7 +491,7 @@ The current system time can be retrieved as follows. The current system time can be manually adjusted as follows. Note that manually setting the clock is usually not required to set the system time, as it is set during provisioning. If NTP/NTS is configured, the manually set time will be -eventually overriden by the server's time. +eventually overridden by the server's time. .. important:: Make sure to pass the time in UTC timezone. diff --git a/source/components/nethsm/clustering.rst b/source/components/nethsm/clustering.rst index 8353ce3865..6f559c1427 100644 --- a/source/components/nethsm/clustering.rst +++ b/source/components/nethsm/clustering.rst @@ -291,7 +291,7 @@ new member to catch up with the cluster. Once this is done, it can be promoted from learner to full member. .. warning:: - Promoting a node incrases the cluster's quorum threshold (refer to the `API documentation `__ and the `Operational Redundancy `__ section of this document). Ensure this new node has a stable connection to the cluster before promoting it. + Promoting a node increases the cluster's quorum threshold (refer to the `API documentation `__ and the `Operational Redundancy `__ section of this document). Ensure this new node has a stable connection to the cluster before promoting it. You can attempt to promote the new member with a call to ``POST /cluster/members/{MemberID}/promote`` (refer to the `API documentation `__). If the learner hasn't @@ -514,9 +514,9 @@ resolving the underlying condition), you can either: *Operational* state depending on the unattended boot setting. .. note:: - If a node is isolated with ``force-new``, it will now be desynchronized with + If a node is isolated with ``force-new``, it will desynchronized with the cluster: any new writes on it or the cluster cannot be reconciled. The - node can still re-join the cluster, but will lose all its local + node can still rejoin the cluster but will lose all its local modifications. The ``POST /cluster/force-new`` endpoint, which is only available in the diff --git a/source/components/nethsm/pkiproxy-windows-ca.rst b/source/components/nethsm/pkiproxy-windows-ca.rst index 829bd1eee5..119c1f45f9 100644 --- a/source/components/nethsm/pkiproxy-windows-ca.rst +++ b/source/components/nethsm/pkiproxy-windows-ca.rst @@ -1,6 +1,10 @@ Windows Active Directory Certificate Services (ADCS) with PKI Proxy ------------------------------------------------------------------- +.. spelling:word-list:: + + SPN + This document describes the configuration of Windows Active Directory Certificate Services (ADCS) with PKI Proxy and NetHSM. Prerequisites @@ -253,7 +257,7 @@ Windows ADCS Configuration This isn't necessary as the PKI Proxy KSP doesn't require any additional authentication for using the private key. 4. After the configuration wizard has finished, open the **Certification Authority** from the **Start menu** or by pressing **Windows Key + R** on your keyboard and entering ``certsrv.msc``. - You can verify that the certificate authority service started correctly when you see a green dot with a white checkmark icon on the name of the certification authority. + You can verify that the certificate authority service started correctly when you see a green dot with a white check-mark icon on the name of the certification authority. .. important:: The availability of the certification authority depends on the availability of the private key and certificate. diff --git a/source/components/nethsm/system_recovery.rst b/source/components/nethsm/system_recovery.rst index 0a3e6a7dc5..1cdd55a181 100644 --- a/source/components/nethsm/system_recovery.rst +++ b/source/components/nethsm/system_recovery.rst @@ -43,7 +43,7 @@ The system recovery can be performed as follows. Some USB drives are incompatible with the NetHSM. This results in the NetHSM not recognizing them as a boot media. In case the NetHSM does not boot from the connected USB drive, try a different USB drive model. - Best results are achieved with drives that have samller capacities and USB 2.0 interface. + Best results are achieved with drives that have smaller capacities and USB 2.0 interface. 5. Optionally: Connect a keyboard and monitor with the NetHSM. 6. Make sure the system is turned off, but connected to power. diff --git a/source/components/nextbox/faq/generic.rst b/source/components/nextbox/faq/generic.rst index 41289bae55..2cc0a102ac 100644 --- a/source/components/nextbox/faq/generic.rst +++ b/source/components/nextbox/faq/generic.rst @@ -38,7 +38,7 @@ Generic FAQ .. faq:: How secure is the NextBox? Debian with frequent `unattended-upgrades` based security updates, a minimal - attack surface by ensuring that not a single unneccessary port is open + attack surface by ensuring that not a single unnecessary port is open are the main contributors to system security. **Make sure your Nextcloud users and passwords are on a high level, either with long-random passwords or a 2-Factor-Authentification supported login method with e.g., a Nitrokey FIDO2.** diff --git a/source/components/nextbox/gettingstarted.rst b/source/components/nextbox/gettingstarted.rst index 82e86f6a10..f1dcab2802 100644 --- a/source/components/nextbox/gettingstarted.rst +++ b/source/components/nextbox/gettingstarted.rst @@ -53,7 +53,7 @@ Ready To Go ----------- .. note:: - Please make sure your Nextbox is always on and connected to the internet. + Please make sure your NextBox is always on and connected to the internet. A downtime can lead to it missing an update, and that can in the worst case break the device, since some Nextcloud updates don't support updates from older versions. diff --git a/source/components/nitrokeys/features/fido2/nitrophone.rst b/source/components/nitrokeys/features/fido2/nitrophone.rst index 265ff63404..774584a2ba 100644 --- a/source/components/nitrokeys/features/fido2/nitrophone.rst +++ b/source/components/nitrokeys/features/fido2/nitrophone.rst @@ -1,6 +1,10 @@ FIDO2 on Android / NitroPhone ***************************** +.. spelling:word-list:: + + Authnkey + .. Note:: For more information about FIDO2, FIDO2 U2F and Passkeys, check our `blog article `_. @@ -19,4 +23,4 @@ Authnkey also comes with useful features such as: Other apps can also be used, such as: - `Passchain `_ -- `Open Passkey Authenticator `_ \ No newline at end of file +- `Open Passkey Authenticator `_ diff --git a/source/components/nitrokeys/features/fido2/provision-entra.rst b/source/components/nitrokeys/features/fido2/provision-entra.rst index 1f23a58ae3..4b379db857 100644 --- a/source/components/nitrokeys/features/fido2/provision-entra.rst +++ b/source/components/nitrokeys/features/fido2/provision-entra.rst @@ -5,7 +5,7 @@ Nitrokey Provisioning for Entra ID .. contents:: :local: -The Nitrokey 3 and Nitrokey Passkey support provisioning credentials for Microsoft Entra for seamless employee onboarding in enterprise scenarios. +The Nitrokey 3 and Nitrokey Passkey support provisioning credentials for Microsoft Entra for seamless employee on-boarding in enterprise scenarios. Setup ----- diff --git a/source/components/nitrokeys/features/hsm/dnssec.rst b/source/components/nitrokeys/features/hsm/dnssec.rst index e91cb4f729..c796e7eb07 100644 --- a/source/components/nitrokeys/features/hsm/dnssec.rst +++ b/source/components/nitrokeys/features/hsm/dnssec.rst @@ -4,6 +4,7 @@ DNSSEC .. spelling:word-list:: Lisse Piet + Mens .. product-table:: hsm diff --git a/source/components/nitrokeys/features/hsm/ipsec.rst b/source/components/nitrokeys/features/hsm/ipsec.rst index 3dbf1d10a3..6d18e7e401 100644 --- a/source/components/nitrokeys/features/hsm/ipsec.rst +++ b/source/components/nitrokeys/features/hsm/ipsec.rst @@ -1,11 +1,15 @@ IPSec ===== +.. spelling:word-list:: + + strongSwan + .. product-table:: nk3 storage start pro hsm .. contents:: :local: -`Strong Swan `__ works using the `PKCS#11 driver `__. Basically follow these steps: +`strongSwan `__ works using the `PKCS#11 driver `__. Basically follow these steps: 1. Generate a key on Nitrokey via pkcs11-tool. In this example it's a 4096 bit RSA key. @@ -35,7 +39,7 @@ IPSec $ pkcs11-tool --module /usr/lib/x86_64-linux-gnu/pkcs11/opensc-pkcs11.so -l -y cert -w user@email.com-staging-cert.der --id 10 --label 'Staging Access' -6. Configure Strongswan to load opensc-pkcs11 module then to load the certificate on Nitrokey. Edit /etc/strongswan.d/charon/pkcs11.conf and add the following module: +6. Configure strongSwan to load OpenSC's PKCS#11 module then to load the certificate on Nitrokey. Edit ``/etc/strongswan.d/charon/pkcs11.conf`` and add the following module: .. code-block:: text @@ -46,6 +50,6 @@ IPSec } -7. Initiate the VPN connection via IPSec/Strongswan, then prompt for Nitrokey PIN +7. Initiate the VPN connection via IPSec/strongSwan, then prompt for Nitrokey PIN 8. VPN is now connected diff --git a/source/components/nitrokeys/features/misc/ecc.rst b/source/components/nitrokeys/features/misc/ecc.rst index c3ecf0131e..2676fb5c3b 100644 --- a/source/components/nitrokeys/features/misc/ecc.rst +++ b/source/components/nitrokeys/features/misc/ecc.rst @@ -147,7 +147,7 @@ You can install GnuPG 2.1.18 on such system with the commands below. This involves newer Debian packages, which is the easiest option. This approach has been tested successfully on Ubuntu 17.10 and probably works on 16.04 as well. -However, the occurence of problems during usage can't be excluded. +However, the occurrence of problems during usage can't be excluded. .. code-block:: bash diff --git a/source/components/nitrokeys/features/openpgp-card/desktop-login/pam.rst b/source/components/nitrokeys/features/openpgp-card/desktop-login/pam.rst index 5e6cd706cb..c10d2afde6 100644 --- a/source/components/nitrokeys/features/openpgp-card/desktop-login/pam.rst +++ b/source/components/nitrokeys/features/openpgp-card/desktop-login/pam.rst @@ -30,7 +30,7 @@ It is necessary to already have keys generated on the Nitrokey, as the authentic 2. Now you have to add a line to ``/etc/poldi/localdb/users`` which contains the following information `` ``. This could look like ``D00600012401020000000000xxxxxxxx nitrokeyuser``. Now dump the public key from the Nitrokey into Poldi's local database: - This could look like ``D00600012401020000000000xxxxxxxx nitrokeyuser``. Now dump the public key from the Nitrokey into Poldis local db: + This could look like ``D00600012401020000000000xxxxxxxx nitrokeyuser``. Now dump the public key from the Nitrokey into Poldi's local db: .. code-block:: bash diff --git a/source/components/nitrokeys/features/openpgp-card/openpgp-csp.rst b/source/components/nitrokeys/features/openpgp-card/openpgp-csp.rst index 8ed1343361..399e03eac6 100644 --- a/source/components/nitrokeys/features/openpgp-card/openpgp-csp.rst +++ b/source/components/nitrokeys/features/openpgp-card/openpgp-csp.rst @@ -23,7 +23,7 @@ You may want to install the driver on the server as well for being able to enfor Creating Certificate Template on Server Side -------------------------------------------- -On Active Directory Server open certsrv.msc to manage your certificate templates. Right click on **Certificate Templates** and choose **Manage**. +On Active Directory Server open ``certsrv.msc`` to manage your certificate templates. Right click on **Certificate Templates** and choose **Manage**. .. figure:: images/openpgp-csp/1.png :alt: img1 @@ -57,7 +57,7 @@ Then go to *Extensions*, there you edit the applications guideline and add *Secu Request Certificate on Client (Domain Member) --------------------------------------------- -To request a certificate for a domain member, you have to open certmgr.msc. Right click on folder **Personal** -> **Certificates** and click +To request a certificate for a domain member, you have to open ``certmgr.msc``. Right click on folder **Personal** -> **Certificates** and click **All Tasks** -> **Request New Certificate** and choose the template you created on the AD. .. figure:: images/openpgp-csp/8.png diff --git a/source/components/nitrokeys/features/openpgp-card/openpgp-thunderbird.rst b/source/components/nitrokeys/features/openpgp-card/openpgp-thunderbird.rst index d6e228d796..1e5dce2a6c 100644 --- a/source/components/nitrokeys/features/openpgp-card/openpgp-thunderbird.rst +++ b/source/components/nitrokeys/features/openpgp-card/openpgp-thunderbird.rst @@ -141,7 +141,7 @@ To encrypt data and e-mails, a key pair consisting of a public key and a private avoid known prose or lyric. Also, no name or known term should be used. - **Allowed characters**: a-z A-Z 0-9 /.,;:-!?( )%+ (no umlauts ä,ü,ö,Ä,Ü,Ö or ß) + **Allowed characters**: ``a-z``, ``A-Z``, ``0-9``, ``/.,;:-!?( )%+`` (no umlauts ``ä``, ``ü``, ``ö``, ``Ä``, ``Ü``, ``Ö`` or ``ß``) **Poor Passwords**: ``qwerty123``, ``ILoveSusi3``, ``Password`` diff --git a/source/components/nitrokeys/features/openpgp-card/openvpn/easyrsa.rst b/source/components/nitrokeys/features/openpgp-card/openvpn/easyrsa.rst index 260826608a..8e154a261a 100644 --- a/source/components/nitrokeys/features/openpgp-card/openvpn/easyrsa.rst +++ b/source/components/nitrokeys/features/openpgp-card/openvpn/easyrsa.rst @@ -7,7 +7,7 @@ OpenVPN Configuration with Easy-RSA :depth: 2 .. note:: - This guide is work-in-progress, and will be updated accordinlgy. Please take this status into consideration. + This guide is work-in-progress, and will be updated accordingly. Please take this status into consideration. This guide shows how to configure OpenVPN clients to login using a `Nitrokey Pro 2 `__ or a `Nitrokey Storage diff --git a/source/components/nitrokeys/features/openpgp-card/overview.rst b/source/components/nitrokeys/features/openpgp-card/overview.rst index 5a5072f98d..a260f142b8 100644 --- a/source/components/nitrokeys/features/openpgp-card/overview.rst +++ b/source/components/nitrokeys/features/openpgp-card/overview.rst @@ -32,10 +32,10 @@ If you do not have OpenPGP keys yet, you need to generate them first. - `Generate keys locally `_ - Ccopy them to your Nitrokey device - this is the most flexible, expert option, + Copy them to your Nitrokey device - this is the most flexible, expert option, but only secure if your system is not compromised, because you can create a backup key outside your Nitrokey A similar description in - french can be found `here `__. + French can be found `here `__. Importing Existing Keys ----------------------- diff --git a/source/components/nitrokeys/fido2/firmware-update.rst b/source/components/nitrokeys/fido2/firmware-update.rst index 00f29f1f8c..4e62a899d9 100644 --- a/source/components/nitrokeys/fido2/firmware-update.rst +++ b/source/components/nitrokeys/fido2/firmware-update.rst @@ -4,7 +4,8 @@ Firmware Update This guide describes how to update the firmware on the Nitrokey FIDO2. .. important:: - User Data is retained during firmware update. Anyways, be sure to **always** have another device (or login method) registered with your service, if for some reason your data is not retained. + User Data is retained during firmware update. + Anyway, be sure to **always** have another device (or login method) registered with your service, if for some reason your data is not retained. How to Update ------------- diff --git a/source/components/nitrokeys/nitrokey3/firmware-update-qubes.rst b/source/components/nitrokeys/nitrokey3/firmware-update-qubes.rst index 7d5df8ef4a..0c77b92599 100644 --- a/source/components/nitrokeys/nitrokey3/firmware-update-qubes.rst +++ b/source/components/nitrokeys/nitrokey3/firmware-update-qubes.rst @@ -13,7 +13,7 @@ This guide describes how to update Nitrokey 3's firmware with nitropy in Qubes O .. important:: Please read the general `firmware update instructions`_ before! - Since for specifc versions there are limitations regarding what data is possible to migrate to the new version. + Since for specific versions there are limitations regarding what data is possible to migrate to the new version. .. _firmware update instructions: ./firmware-update.html diff --git a/source/components/nitrokeys/nitrokey3/firmware-update.rst b/source/components/nitrokeys/nitrokey3/firmware-update.rst index fb915a5fc6..ea8e7765b7 100644 --- a/source/components/nitrokeys/nitrokey3/firmware-update.rst +++ b/source/components/nitrokeys/nitrokey3/firmware-update.rst @@ -14,7 +14,8 @@ This guide describes how to update the firmware on the Nitrokey 3. applications/services. - **For firmware v1.0.1 and above user data is retained** during the update. Anyways, be sure to always have another device (or login method) registered with your service, if for some reason your data is not retained. + **For firmware v1.0.1 and above user data is retained** during the update. + Anyway, be sure to always have another device (or login method) registered with your service, if for some reason your data is not retained. How to Update ------------- diff --git a/source/components/nitrokeys/nitrokey3/set-pins.rst b/source/components/nitrokeys/nitrokey3/set-pins.rst index 545570ef4e..12d09a3d69 100644 --- a/source/components/nitrokeys/nitrokey3/set-pins.rst +++ b/source/components/nitrokeys/nitrokey3/set-pins.rst @@ -26,7 +26,7 @@ The PIN for FIDO2 can be set with `Nitropy <../../software/nitropy/index.html>`_ .. warning:: The PIN has a retry counter of eight attempts. After eight attempts, the PIN is locked and the FIDO feature must be reset, which deletes all saved FIDO2 credentials. - To prevent accidental lock of the PIN, the device needs to be unplugged and rei-plugged every 3 attempts. + To prevent accidental lock of the PIN, the device needs to be unplugged and re-plugged every 3 attempts. .. note:: The *FIDO2 PIN* must have a minimal length of 4 characters and maximal length of 63 characters. @@ -131,7 +131,7 @@ The factory default for the *Admin PIN* is ``12345678``. .. note:: The *Admin PIN* must have a minimal length of 8 characters and maximal length of 127 characters. - It can contain alphanumeric characters, including special characters such as punctation. + It can contain alphanumeric characters, including special characters such as punctuation. .. warning:: The *Admin PIN* has a PIN retry counter of 3 attempts. @@ -155,7 +155,7 @@ It is useful in situations when the user of the Nitrokey should be able to unblo .. note:: The *Reset Code* must have a minimal length of 8 characters and maximal length of 127 characters. - It can contain alphanumeric characters, including special characters such as punctation. + It can contain alphanumeric characters, including special characters such as punctuation. .. note:: Once the *Reset Code* is set it can not be disabled anymore. Disabling would require a reset of the OpenPGP Card application. @@ -187,7 +187,7 @@ The factory default for the *PIN* is ``123456``. .. note:: The *PIN* must have maximal length of 8 characters. - It can contain alphanumeric characters, including special characters such as punctation. + It can contain alphanumeric characters, including special characters such as punctuation. .. warning:: The *PIN* has a PIN retry counter of 3 attempts. @@ -204,7 +204,7 @@ The factory default for the *PUK* is ``12345678``. .. note:: The *PUK* must have a maximal length of 8 characters. - It can contain alphanumeric characters, including special characters such as punctation. + It can contain alphanumeric characters, including special characters such as punctuation. .. warning:: The *PUK* has a retry counter of 3 attempts. diff --git a/source/components/nitropad-nitropc/faq.rst b/source/components/nitropad-nitropc/faq.rst index 90740cf422..3753e27093 100644 --- a/source/components/nitropad-nitropc/faq.rst +++ b/source/components/nitropad-nitropc/faq.rst @@ -28,5 +28,5 @@ NitroPad, NitroPC FAQ they may have copied the LUKS header, i.e., the encryption key. Using this copy, one might decrypt the hard-disk even with a new password being set. This is why the re-ownership wizard proposes to re-encrypt the hard-disk, - which reencrypts in place ensuring the previously described scenario + which re-encrypts in place ensuring the previously described scenario cannot be applied. diff --git a/source/components/nitropad-nitropc/heads/factory-reset-heads2.rst b/source/components/nitropad-nitropc/heads/factory-reset-heads2.rst index 6d2676d61a..ce12f3af7f 100644 --- a/source/components/nitropad-nitropc/heads/factory-reset-heads2.rst +++ b/source/components/nitropad-nitropc/heads/factory-reset-heads2.rst @@ -23,7 +23,7 @@ Procedure .. tabs:: .. tab:: Heads v2.5+ 1. Connect your Nitrokey to the NitroPad. - 2. Turn on the NitroPad and interupt the automatic boot by pressing any key. + 2. Turn on the NitroPad and interrupt the automatic boot by pressing any key. 3. Select “Options”. .. figure:: /components/nitropad-nitropc/images/factory-reset-heads2/options.jpg @@ -40,7 +40,7 @@ Procedure :alt: confirm 6. The integrity of your setup will be tested. - Deppending on your reason to perform the reset this can fail; continue with "Ok" anyway. + Depending on your reason to perform the reset this can fail; continue with "OK" anyway. .. figure:: /components/nitropad-nitropc/images/factory-reset-heads2/confirm-integrity.jpg :alt: confirm integrity @@ -89,7 +89,7 @@ Procedure .. figure:: /components/nitropad-nitropc/images/factory-reset-heads2/tpm.jpg :alt: tpm password enter - 12. Scan QR code with Phone to inport TOTP Seceret (optional) and hit Enter + 12. Scan QR code with Phone to import TOTP Secret (optional) and hit Enter .. figure:: /components/nitropad-nitropc/images/factory-reset-heads2/totp.jpg :alt: qr code totp diff --git a/source/components/nitropad-nitropc/qubes/index.rst b/source/components/nitropad-nitropc/qubes/index.rst index 2acdc2152c..a4b3246d48 100644 --- a/source/components/nitropad-nitropc/qubes/index.rst +++ b/source/components/nitropad-nitropc/qubes/index.rst @@ -62,7 +62,7 @@ changed by you: To update use the Update Manager as described in the `Qubes Documentation `__. .. note:: - Specifically for NitroPad V54 the Qubes 4.2.3 installation image contains a bug that limits to use the highest screen resoultion only. + Specifically for NitroPad V54 the Qubes 4.2.3 installation image contains a bug that limits to use the highest screen resolution only. This is fixed after you update dom0 and reboot. Behavior After a System Update diff --git a/source/components/nitrophone/hmdm/launcher-app-installation.rst b/source/components/nitrophone/hmdm/launcher-app-installation.rst index 5eb3271477..00eb9a03be 100644 --- a/source/components/nitrophone/hmdm/launcher-app-installation.rst +++ b/source/components/nitrophone/hmdm/launcher-app-installation.rst @@ -8,7 +8,7 @@ Launcher App Installation .. important:: - We recommand to backup your data before installing MDM. + We recommend to backup your data before installing MDM. Your NitroPhone needs to be connected to the internet during the configuration and you also need a PC. diff --git a/source/components/nitrophone/hmdm/server-update.rst b/source/components/nitrophone/hmdm/server-update.rst index 08b8fdef12..322d2b7278 100644 --- a/source/components/nitrophone/hmdm/server-update.rst +++ b/source/components/nitrophone/hmdm/server-update.rst @@ -52,5 +52,5 @@ In case of an update only the WAR file for the application server is required. If you encounter an HTTP error 404, restore the HMDM configuration file from the backup and restart the application server again. .. note:: - If the version number has not been updated in the webpanel "about" section you may need to clear the cache of your browser. + If the version number has not been updated in the web panel *About* section you may need to clear the cache of your browser. diff --git a/source/components/software/nk-app1/index.rst b/source/components/software/nk-app1/index.rst index 41e73c84c0..628446f086 100644 --- a/source/components/software/nk-app1/index.rst +++ b/source/components/software/nk-app1/index.rst @@ -1,6 +1,11 @@ Nitrokey App 1 ============== +.. spelling:word-list:: + + AppImage + scdaemon + The Nitrokey App 1 is a graphical application designed to manage Nitrokey Pro and Nitrokey Storage devices. For Nitrokey 3 devices, please use `Nitrokey App 2 <../nk-app2/>`__. Available languages: English, German, French, Italian, Polish, and Arabic. Language change requires application restart. @@ -22,7 +27,7 @@ Linux .. dropdown:: Arch Linux - The Nitrokey App is included in the official extra repo. + The Nitrokey App is included in the official extra repository. .. code-block:: bash @@ -87,7 +92,7 @@ Linux .. dropdown:: AppImage - AppImage provide everything that is needed to get executed. It works like a .exe on Windows and does not need to be installed. + AppImage provide everything that is needed for execution and does not need to be installed. See `here `__ for our latest Nitrokey-App.AppImage file. After downloading the file, you need to make the file executable. You can do this by right-clicking on the file and choosing "Properties". Look for the option to make the file executable there. @@ -113,7 +118,7 @@ Linux in a terminal and follow the instruction below. The latest Nitrokey App is available as Snap package which is available for many Linux distributions and which ensures that you always have the latest version installed. - Snapd is already installed on Ubuntu, for distros like Arch, Debian, Fedora, or Gentoo you need to `install snapd `__ first. As soon as you have Snap installed you can open a terminal and type + Snap is already installed on Ubuntu, for distributions like Arch, Debian, Fedora, or Gentoo you need to `install snapd `__ first. As soon as you have Snap installed you can open a terminal and type .. code-block:: bash @@ -122,12 +127,12 @@ Linux to install Nitrokey App. You now can use it as usual, e.g. by pressing Alt + F2 and entering "nitrokey-app". **Troubleshooting** - In case you get the error "failed to create user data directory. errmsg: Permission denied" during starting the Nitrokey App, it may is because your home directory is encrypted. In this case, apply one of these fixes `[1] `__ `[2] `__. + In case you get the error ``failed to create user data directory. errmsg: Permission denied`` during starting the Nitrokey App, it may is because your home directory is encrypted. In this case, apply one of these fixes `[1] `__ `[2] `__. Windows ******* -Download .exe file from `here `__. +Download the ``.exe`` file from `here `__. macOS ***** diff --git a/source/components/software/nk-app2/passwords.rst b/source/components/software/nk-app2/passwords.rst index 5541b763cc..776145e561 100644 --- a/source/components/software/nk-app2/passwords.rst +++ b/source/components/software/nk-app2/passwords.rst @@ -100,14 +100,16 @@ The dialog lists the results in three columns: .. important:: - The export is encrypted by default. The "Cleartext" option disables the encryption and stores all credentials unprotected in the file. Only use it for compatibility with other password managers. + The export is encrypted by default. + The clear-text option disables the encryption and stores all credentials unprotected in the file. + Only use it for compatibility with other password managers. Import ^^^^^^ 1. Insert your Nitrokey and click on the "Passwords" tab. 2. Click on the "Import" button and select the previously exported file. -3. Enter the passphrase of the file (This is not needed for a file that was exported with the "Cleartext" option) +3. Enter the passphrase of the file (This is not needed for a file that was exported with the clear-text option) 4. Click on "Begin". You are asked for the device PIN, unless it has already been entered earlier in this session. While the operation is running, the status shows "Working... Press your Nitrokey if it blinks." The dialog lists the results in three columns: diff --git a/source/index.rst b/source/index.rst index 4caec96b66..c41f6a7113 100644 --- a/source/index.rst +++ b/source/index.rst @@ -35,13 +35,13 @@ Nitrokey Documentation :link: components/nitrowall/index :link-type: doc - Network PCs for firwalls, routing and a more secure home network + Network PCs for firewalls, routing and a more secure home network .. card:: NitroWall NW750 :link: components/nitrowall/nw750/index :link-type: doc - Never use open WiFis again, just get your own mobile Wifi + Never use open WiFis again; just get your own mobile WiFi .. card:: Software :link: components/software/index diff --git a/wordlist.txt b/wordlist.txt index 45ffeb8d48..79521c32d1 100644 --- a/wordlist.txt +++ b/wordlist.txt @@ -48,6 +48,7 @@ decrypt decrypted decrypting DER +desynchronized dev dialogs discoverable @@ -279,6 +280,7 @@ TPM TRNG ubuntu udev +Uncheck uncomment Uncomment Undersupply