diff --git a/.gitignore b/.gitignore index c9429a55fd..0a4eeab00c 100644 --- a/.gitignore +++ b/.gitignore @@ -3,3 +3,7 @@ dist venv nitrokey-sdk-py* *.pyc + +# editor detritus +.*sw? +*~ diff --git a/Makefile b/Makefile index 4e8e4d7837..67e9ac7d6c 100644 --- a/Makefile +++ b/Makefile @@ -1,42 +1,135 @@ NITROKEY_SDK_PY_VERSION ?= v0.4.1 NITROKEY_SDK_PY_CHECKSUM ?= 3e6410a037c95d14fce1a5021422f510b47d1b2f0a78cf88d07798b9d24974ea - NITROKEY_SDK_PY_URL := https://github.com/Nitrokey/nitrokey-sdk-py/archive/refs/tags/$(NITROKEY_SDK_PY_VERSION).tar.gz NITROKEY_SDK_PY := nitrokey-sdk-py-$(NITROKEY_SDK_PY_VERSION) NITROKEY_SDK_PY_ARCHIVE := $(NITROKEY_SDK_PY).tar.gz NITROKEY_SDK_PY_LINK := source/components/software/nitrokey-sdk-py FMT ?= html +EDITOR ?= vim +BUILD_LANG = en +ACCEPTED_WORD_LIST = wordlist.txt +CANDIDATE_WORD_LIST = build/$(BUILD_LANG)/spelling/candidates.txt +VIM_SPELLFILE = spellfile.utf-8.add .PHONY: docs docs: venv - venv/bin/sphinx-build -j auto -b $(FMT) -D language=en -d build/en/doctrees source dist/en + venv/bin/sphinx-build -j auto -b $(FMT) -D language=en -d build/$(BUILD_LANG)/doctrees source dist/$(BUILD_LANG) .PHONY: venv -venv: $(NITROKEY_SDK_PY) - python -m venv venv +venv: venv/lib/python*/site-packages/nitrokey/__init__.py +venv/lib/python*/site-packages/nitrokey/__init__.py: $(NITROKEY_SDK_PY) + python3 -m venv venv venv/bin/pip3 install -r requirements.txt venv/bin/pip3 install ./$(NITROKEY_SDK_PY) +define CLEAN_WORD_LIST +sort -u $(1) | sed -e '/^[[:space:]][[:space:]]*$$/d' -e '/^#/d' +endef +.PHONY: spell check-spelling +spell: check-spelling +check-spelling: venv + @# sphinxcontrib-spelling doesn't seem to overwrite its previous .spelling + @# files (which could be a bug), so clean those up now… + -find build/$(BUILD_LANG)/spelling -name "*.spelling" -delete + + # building a list of candidate words to add to '$(CANDIDATE_WORD_LIST)' + venv/bin/sphinx-build -b spelling source build/$(BUILD_LANG)/spelling + @echo '# lines KEPT in this file will be treated as CORRECT spellings' \ + > $(CANDIDATE_WORD_LIST) + find . -name "*.spelling" -exec cat {} \; | awk -F '[()]' '{print $$2}' \ + | sort -u >> $(CANDIDATE_WORD_LIST) + +ifneq ($(SKIP_ADD_SPELLINGS),1) + @printf '\nEdit the candidate word list to add new spellings now? [y/N] '; \ + read REPLY; \ + if [ -z "$$REPLY" ] || ! echo "$$REPLY" | grep -qi ^y; then \ + printf '\nOK, not updating the word list.\n'; \ + printf "You can run 'make fix-spelling' to fix misspellings in your editor.\n\n"; \ + exit 1; \ + fi + $(EDITOR) $(CANDIDATE_WORD_LIST) + + # cleaning and re-sorting the wordlists… + $(call CLEAN_WORD_LIST,$(ACCEPTED_WORD_LIST)) > $(ACCEPTED_WORD_LIST).new + mv $(ACCEPTED_WORD_LIST).new $(ACCEPTED_WORD_LIST) + $(call CLEAN_WORD_LIST,$(CANDIDATE_WORD_LIST)) > $(CANDIDATE_WORD_LIST).new + mv $(CANDIDATE_WORD_LIST).new $(CANDIDATE_WORD_LIST) + + @echo + # showing differences between existing wordlist (left) and candidates (right)… + # these two files will be merged together if you continue + @if type sdiff >/dev/null 2>&1; then \ + sdiff --suppress-common-lines $(ACCEPTED_WORD_LIST) $(CANDIDATE_WORD_LIST); \ + else \ + diff -u $(ACCEPTED_WORD_LIST) $(CANDIDATE_WORD_LIST); \ + fi; \ + printf '\nAbout to update '$(ACCEPTED_WORD_LIST)'. Do the above changes look okay? [Y/n] '; \ + read REPLY; \ + if [ -n "$$REPLY" ] && ! echo "$$REPLY" | grep -qi ^y; then \ + printf '\nOK, not updating the word list.\n\n'; \ + printf "You can run 'make fix-spelling' to fix misspellings in your editor.\n\n"; \ + exit 1; \ + fi + + @echo + # updating wordlist with the new spellings… + cat $(ACCEPTED_WORD_LIST) $(CANDIDATE_WORD_LIST) \ + | $(CLEAN_WORD_LIST) > $(ACCEPTED_WORD_LIST).new + mv $(ACCEPTED_WORD_LIST).new $(ACCEPTED_WORD_LIST) +endif + @printf "\nYou can now run 'make fix-spelling' to correct any identified misspellings.\n\n" + +.PHONY: fix correct fix-spelling +fix: fix-spelling +correct: fix-spelling +fix-spelling: + # opening your $$EDITOR to correct spelling in all misspelled files… + @exec 3 "$$patterns"; \ + rm $(VIM_SPELLFILE)* 2>/dev/null || true; \ + ln -s $(ACCEPTED_WORD_LIST) $(VIM_SPELLFILE); \ + $(EDITOR) \ + -c 'set spellfile=$(VIM_SPELLFILE)' -c 'silent mkspell $(VIM_SPELLFILE)' \ + -c 'set spelllang=$(BUILD_LANG)' -c 'setlocal spell' \ + -c "let patterns=readfile('$$patterns')" \ + -c "let @/=join(patterns, '\\|')" \ + -c "let &errorformat='%f:%l: %m'" -c "cfile $$misspelled" \ + -c 'set hlsearch' -c copen "$$dirname/$$source" <&3; \ + rm $(VIM_SPELLFILE)* "$$patterns" 2>/dev/null || true; \ + else \ + $(EDITOR) "$$dirname/$$source" "$$misspelled" <&3; \ + fi; \ + done; \ + exec 3<&- + .PHONY: check-syntax check-syntax: venv venv/bin/rstcheck --config rstcheck.toml --recursive source .PHONY: check-hyperlinks check-hyperlinks: venv docs - venv/bin/linkchecker -f linkcheckerrc dist/en/index.html + venv/bin/linkchecker -f linkcheckerrc dist/$(BUILD_LANG)/index.html .PHONE: check-hyperlinks-nightly check-hyperlinks-nightly: venv docs - venv/bin/linkchecker -f linkcheckerrc_nightly dist/en/index.html + venv/bin/linkchecker -f linkcheckerrc_nightly dist/$(BUILD_LANG)/index.html .PHONY: pkg pkg: venv docs - mv dist/en/_images dist/_images + mv dist/$(BUILD_LANG)/_images dist/_images rm -rf dist/*/_sources dist/*/_images cp redirects/.htaccess dist - clean: rm -rf dist build nitrokey-sdk-py* $(NITROKEY_SDK_PY_LINK) @@ -44,7 +137,7 @@ cleaner: clean rm -rf venv $(NITROKEY_SDK_PY): $(NITROKEY_SDK_PY_ARCHIVE) - mkdir "$@" + if [ ! -d "$@" ]; then mkdir "$@"; fi tar --directory "$@" --extract --strip-components 1 --file "$<" rm -f $(NITROKEY_SDK_PY_LINK) ln -s ../../../$(NITROKEY_SDK_PY)/docs $(NITROKEY_SDK_PY_LINK) diff --git a/requirements.txt b/requirements.txt index fa7d8d09cb..bf45530669 100644 --- a/requirements.txt +++ b/requirements.txt @@ -32,3 +32,4 @@ setuptools==75.6.0 docutils==0.21.2 sphinx-design==0.6.1 LinkChecker==10.5.0 +sphinxcontrib-spelling==8.0.2 diff --git a/source/components/nethsm/administration.rst b/source/components/nethsm/administration.rst index d4477a3557..1df8353acd 100644 --- a/source/components/nethsm/administration.rst +++ b/source/components/nethsm/administration.rst @@ -428,13 +428,13 @@ Set the network configuration as follows. **Optional Options** - +---------------------------+-----------------------------------------------+ - | Option | Description | - +===========================+===============================================+ - | ``--ipv6-cidr`` ``TEXT`` | The IPv6 address in CIDR notation (optional) | - +---------------------------+-----------------------------------------------+ - | ``--ipv6-gateway`` ``TEXT`` | The IPv6 gateway address (optional) | - +---------------------------+-----------------------------------------------+ + +-----------------------------+-----------------------------------------------+ + | Option | Description | + +=============================+===============================================+ + | ``--ipv6-cidr`` ``TEXT`` | The IPv6 address in CIDR notation (optional) | + +-----------------------------+-----------------------------------------------+ + | ``--ipv6-gateway`` ``TEXT`` | The IPv6 gateway address (optional) | + +-----------------------------+-----------------------------------------------+ **Example** @@ -1040,7 +1040,7 @@ Each user account configured on the NetHSM has one of the following *Roles* assi | | required to initiate a system backup only. | +-----------------+-------------------------------------------------------------+ -See `Namespaces `__ and `Tags `__ for more fine-grained access restricions. +See `Namespaces `__ and `Tags `__ for more fine-grained access restrictions. .. note:: In a future release, additional *Roles* may be introduced. diff --git a/source/components/nethsm/compatible/apache.rst b/source/components/nethsm/compatible/apache.rst index 96ab3b56b0..769b7e5cb4 100644 --- a/source/components/nethsm/compatible/apache.rst +++ b/source/components/nethsm/compatible/apache.rst @@ -1,6 +1,10 @@ Apache ====== +.. spelling:word-list:: + + libnethsm_pkcs11 + You can configure `Apache httpd `__ to use NetHSM via the OpenSSL engine which then uses NetHSM's PKCS#11 module. The certificate file has to be on the disk but the private key can be used from the NetHSM. diff --git a/source/components/nethsm/compatible/ejbca.rst b/source/components/nethsm/compatible/ejbca.rst index 973544d2db..596891c6fd 100644 --- a/source/components/nethsm/compatible/ejbca.rst +++ b/source/components/nethsm/compatible/ejbca.rst @@ -1,6 +1,10 @@ EJBCA ===== +.. spelling:word-list:: + EJBCA + ng + .. note:: EJBCA requires at least NetHSM v3 and nethsm-pkcs11 v2. diff --git a/source/components/nethsm/compatible/knotdns.rst b/source/components/nethsm/compatible/knotdns.rst index b61e4c8b32..35c74e0945 100644 --- a/source/components/nethsm/compatible/knotdns.rst +++ b/source/components/nethsm/compatible/knotdns.rst @@ -1,6 +1,10 @@ Knot DNS ======== +.. spelling:word-list:: + + KnotDNS + `Knot DNS `__ is an open source authoritative DNS server that can be used for DNSSEC. To use KnotDNS with the NetHSM please install and configure the PKCS#11 module as `described here <../pkcs11-setup.html>`__. Manual Mode diff --git a/source/components/nethsm/integration.rst b/source/components/nethsm/integration.rst index 0fc3978c71..38754ecf8a 100644 --- a/source/components/nethsm/integration.rst +++ b/source/components/nethsm/integration.rst @@ -17,7 +17,7 @@ PKCS#11 The NetHSM supports the PKCS#11 standard. The required driver is available from the `repository `__. -The repository containes the source code and libraries, for different operating systems. +The repository contains the source code and libraries, for different operating systems. The `PKCS#11 guide `_ describes the usage in detail. Development and Testing @@ -27,7 +27,7 @@ Demo Instance ^^^^^^^^^^^^^ A public NetHSM demo instance is available at `nethsmdemo.nitrokey.com `_. -It will be reset every eight hours (CET 6:00, 14:00, 22:00). User "admin", password "adminadmin", unlock password "unlockunlock". +It will be reset every eight hours (CET 6:00, 14:00, 22:00). User ``admin`", password ``adminadmin``, unlock password ``unlockunlock``. Container Image ^^^^^^^^^^^^^^^ @@ -72,7 +72,7 @@ This folder also contains the necessary documentation how to use it. If Podman is used with enforcing SELinux, a labeling to the volume mount might be required. The mode of SELinux can be requested with ``sestatus |grep "Current mode"``. If the mode is set to ``enforcing``, a change to the context is required. - In this case the volume mount must be postfixed with ``:z``, resulting in ``-v "${PWD}/out:/out:z"``. + In this case the volume mount must be suffixed with ``:z``, resulting in ``-v "${PWD}/out:/out:z"``. Command-line interface ---------------------- diff --git a/source/components/nethsm/metrics.rst b/source/components/nethsm/metrics.rst index 22dc6c4582..8b5d7b6f77 100644 --- a/source/components/nethsm/metrics.rst +++ b/source/components/nethsm/metrics.rst @@ -1,3 +1,10 @@ +.. spelling:word-list:: + + kv + gc + compactions + rcvd + :orphan: Metrics diff --git a/source/components/nethsm/pkcs11-setup.rst b/source/components/nethsm/pkcs11-setup.rst index 361a3bb363..ea96c09a21 100644 --- a/source/components/nethsm/pkcs11-setup.rst +++ b/source/components/nethsm/pkcs11-setup.rst @@ -32,12 +32,12 @@ By default the module searches for configuration files in: If multiple files are present the configurations will be merged so that the slots of all the config files will be used by the module. -You can manually set the config file location (only this one will be read) with the env variable ``P11NETHSM_CONFIG_FILE`` (e.g. ``P11NETHSM_CONFIG_FILE=./p11nethsm.conf``). +You can manually set the config file location (only this one will be read) with the environment variable ``P11NETHSM_CONFIG_FILE`` (e.g. ``P11NETHSM_CONFIG_FILE=./p11nethsm.conf``). Configuration File Format ~~~~~~~~~~~~~~~~~~~~~~~~~ -The configuration is yaml-formatted: +The configuration is YAML-formatted: .. tabs:: .. tab:: All platforms @@ -196,7 +196,7 @@ The password can be provided by multiple means: - In plain text in the configuration ``password: "mypassword"`` - In an environment variable read by the module with the ``env:`` prefix: ``env:ENV_STORING_THE_PASSWORD`` - Via the login function of pkcs11, example for pcks11-tool: ``pkcs11-tool --module libnethsm_pkcs11.so -p opPassphrase`` - To provide the the admin password you need to use ``--so-pin`` instead: ``pkcs11-tool --module libnethsm_pkcs11.so --login --login-type so --so-pin Administrator`` + To provide the admin password you need to use ``--so-pin`` instead: ``pkcs11-tool --module libnethsm_pkcs11.so --login --login-type so --so-pin Administrator`` If the password of an user is not set in the configuration file a login will be required to provide the password (3rd method). diff --git a/source/components/nethsm/pkcs11-tool.rst b/source/components/nethsm/pkcs11-tool.rst index 802a406090..0168aa9e3b 100644 --- a/source/components/nethsm/pkcs11-tool.rst +++ b/source/components/nethsm/pkcs11-tool.rst @@ -81,7 +81,7 @@ Generate a Key Generate a key-pair and store it on the NetHSM. .. note:: - The slot you want to use needs to have an andministrator user in the configuration file. Otherwise you will get a `CKR_USER_NOT_LOGGED_IN` error. + The slot you want to use needs to have an administrator user in the configuration file. Otherwise you will get a `CKR_USER_NOT_LOGGED_IN` error. RSA ~~~ diff --git a/source/components/nethsm/pkiproxy.rst b/source/components/nethsm/pkiproxy.rst index 3921ca0248..b722e71158 100644 --- a/source/components/nethsm/pkiproxy.rst +++ b/source/components/nethsm/pkiproxy.rst @@ -27,8 +27,8 @@ Possible use cases of this setup are: .. tip:: Please also refer to the official `PKI Proxy documentation `__ for more information. -Prerequisits -============ +Prerequisites +============= - NetHSM (hardware or containerized) - Provisioned @@ -69,7 +69,7 @@ The instructions below configure the PKI Proxy. 1. Open the PKI Proxy main window. 2. Change to the **Settings** tab. -3. Make sure the checkbox **Enable TLS** is checked and an apropriate certificate is used. +3. Make sure the checkbox **Enable TLS** is checked and an appropriate certificate is used. 4. Change to the **Users** tab. 5. Create a new user by clicking on the **New...** button. Choose an authentication type which is supported by all clients. diff --git a/source/components/nethsm/system_recovery.rst b/source/components/nethsm/system_recovery.rst index 51d8c103e0..ca115e4059 100644 --- a/source/components/nethsm/system_recovery.rst +++ b/source/components/nethsm/system_recovery.rst @@ -4,7 +4,7 @@ System Recovery The following describes the recovery process for the NetHSM system software. These instructions are only applicable if the API is inoperable, e.g. not responding to API requests. In the case of an operable API perform a `factory reset `__ instead. -Follow the instructions precicsely to prevent any accidential deletion of data. +Follow the instructions precisely to prevent any accidental deletion of data. .. important:: The system recovery only works if the GUID partition table (GPT) and the partitions itself on the disk are not corrupted. diff --git a/source/components/nextbox/backup-restore.rst b/source/components/nextbox/backup-restore.rst index 46e7bb3419..cf8bbb0ca3 100644 --- a/source/components/nextbox/backup-restore.rst +++ b/source/components/nextbox/backup-restore.rst @@ -1,10 +1,12 @@ Backup and Restore ================== -.. contents:: :local: +.. spelling:word-list:: + Storages +.. contents:: :local: -The NextBox can be backupped and restored from within the NextBox Nextcloud App. In order to +The NextBox can be backed up and restored from within the NextBox Nextcloud App. In order to execute a backup or restore operation you need to have a storage device attached to your NextBox. To enable backup and restore onto a storage device please follow these steps: @@ -55,7 +57,7 @@ Restore 3. Click "Start Restoring now", the restore process will begin immediately. -Depending on the backupped Nextcloud version after the restore process you will be asked to run +Depending on the backed-up Nextcloud version, after the restore process you will be asked to run the upgrade process for Nextcloud. @@ -63,7 +65,3 @@ the upgrade process for Nextcloud. All configurations and settings of the NextBox and the Nextcloud instance will be restored, thus there might be changes on how you access your NextBox, if the restored Remote Access configuration is not identical to the current one. - - - - diff --git a/source/components/nextbox/clients/android.rst b/source/components/nextbox/clients/android.rst index dabfd480e9..dca0ad9043 100644 --- a/source/components/nextbox/clients/android.rst +++ b/source/components/nextbox/clients/android.rst @@ -11,7 +11,7 @@ Connect the NextBox with your smartphone :alt: imgsp1 :scale: 30 % -2. Cick on "Sign in". +2. Click on "Sign in". .. figure:: /components/nextbox/images/gettingstarted/sp_2.jpg :alt: imgsp2 diff --git a/source/components/nextbox/clients/linux.rst b/source/components/nextbox/clients/linux.rst index 5e60a160cc..ac0bc9ceb0 100644 --- a/source/components/nextbox/clients/linux.rst +++ b/source/components/nextbox/clients/linux.rst @@ -14,7 +14,7 @@ Connect using the Nextcloud App 2. After starting the ``nextcloud`` application, you will find it as a tray icon. -3. Add an account using your public server url, username and password. +3. Add an account using your public server URL, username and password. Further you can choose the target directory the files should be synced to. @@ -26,7 +26,7 @@ Connect using WebDAV managers, by adding a "remote server". * Additionally you can mount your Nextcloud files using WebDAV via - commandline and `/etc/fstab` by installing the `davfs2` package. + the command line and `/etc/fstab` by installing the `davfs2` package. * To mount use: diff --git a/source/components/nextbox/clients/macosx.rst b/source/components/nextbox/clients/macosx.rst index 83a54b6632..2b3b4bbd4d 100644 --- a/source/components/nextbox/clients/macosx.rst +++ b/source/components/nextbox/clients/macosx.rst @@ -1,5 +1,5 @@ -Connect your Mac Commputer -========================== +Connect your Mac Computer +========================= .. contents:: :local: diff --git a/source/components/nextbox/clients/windows.rst b/source/components/nextbox/clients/windows.rst index 88f18a280a..5d82e4b1fd 100644 --- a/source/components/nextbox/clients/windows.rst +++ b/source/components/nextbox/clients/windows.rst @@ -1,4 +1,4 @@ -Connect your Mac Commputer +Connect your Mac Computer ========================== .. contents:: :local: @@ -15,7 +15,7 @@ Connect using the Nextcloud App 2. After installation, click "Log in to your Nextcloud". Afterwards please - provide your Nextcloud's domain. + provide your Nextcloud domain. .. figure:: /components/nextbox/images/win_app/2.png diff --git a/source/components/nextbox/faq/generic.rst b/source/components/nextbox/faq/generic.rst index 6c5f9b5f2a..b8fe2241b7 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.** @@ -65,14 +65,14 @@ Generic FAQ images provided by Nextcloud. Ultimately, if some NextBox/OS configuration is blocking an app to run properly we for sure will look into fixing it. -.. faq:: Can I connect/use the NextBox using Wi-Fi? +.. faq:: Can I connect/use the NextBox using WiFi? - No, currently this is not (easily) possible, only wired ethernet using RJ-45 + No, currently this is not (easily) possible, only wired Ethernet using RJ-45 is available. -.. faq:: Is the Wi-Fi on the Raspberry PI 4B physically available and working? +.. faq:: Is the WiFi on the Raspberry PI 4B physically available and working? - Yes, physically the Wi-Fi is available and working, but not used/managed by the + Yes, physically the WiFi is available and working, but not used/managed by the NextBox App. If you know what you are doing you can configure and use it, if it works even though it's inside the NextBox casing. diff --git a/source/components/nextbox/faq/nextcloud.rst b/source/components/nextbox/faq/nextcloud.rst index 97e27cdd99..bb85fe499c 100644 --- a/source/components/nextbox/faq/nextcloud.rst +++ b/source/components/nextbox/faq/nextcloud.rst @@ -31,7 +31,7 @@ Nextcloud FAQ .. faq:: Why am I getting a permission warning for ``/var/www/html/custom_apps/nextbox`` inside the Nextcloud settings overview? This is a "feature". The NextBox Nextcloud App is installed on the system - with the Debian nextbox package. To avoid an accidental deletion of the NextBox + with the Debian ``nextbox`` package. To avoid an accidental deletion of the NextBox Nextcloud App from within the Nextcloud app management, the stated directory can not be written by Nextcloud, this is what Nextcloud is complaining about here. diff --git a/source/components/nextbox/faq/remote-access.rst b/source/components/nextbox/faq/remote-access.rst index 57d6b3388f..b618aea19f 100644 --- a/source/components/nextbox/faq/remote-access.rst +++ b/source/components/nextbox/faq/remote-access.rst @@ -51,7 +51,7 @@ Remote Access FAQ technologies, which do not allow incoming traffic for the IPv4, which was assigned to you. An incomplete list is: *private IPv4 address*, *DS-Lite connection* or *CarrierGrade-NAT (CG-NAT)*. All these essentially share one - IPv4 address accross multiple users, thus block (incoming) traffic from the + IPv4 address across multiple users, thus block (incoming) traffic from the internet to you. Some ISPs allow upgrading to so-called **full-stack connections**, which should enable full bi-directional traffic for IPv4 and IPv6. @@ -62,7 +62,7 @@ Remote Access FAQ full IPv6 support activated. This means, if your NextBox is configured for IPv6 only access, devices inside these networks will not be able to connect. The **backwards-proxy does work as a workaround here**, as it provides an IPv4 - entrypoint to your NextBox independant of your other remote access + entrypoint to your NextBox independent of your other remote access configuration. diff --git a/source/components/nextbox/gettingstarted.rst b/source/components/nextbox/gettingstarted.rst index f7095ce007..ee962168bd 100644 --- a/source/components/nextbox/gettingstarted.rst +++ b/source/components/nextbox/gettingstarted.rst @@ -6,7 +6,6 @@ Getting Started Quickstart ---------- - 1. Connect NextBox to your Internet router via network cable. 2. Connect the power cable to the NextBox, you can use any of the two USB-C ports. 3. Once powered the NextBox will start @@ -54,8 +53,8 @@ Your can find the NextBox-App in Nextcloud's top level navigation, as shown in t Ready To Go ----------- - .. note:: 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 worstcase + .. note:: 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. This is all it takes to get started with your NextBox. From this point you are diff --git a/source/components/nextbox/remote/dns-rebind.rst b/source/components/nextbox/remote/dns-rebind.rst index b0be3ead5a..b792a57a8f 100644 --- a/source/components/nextbox/remote/dns-rebind.rst +++ b/source/components/nextbox/remote/dns-rebind.rst @@ -15,7 +15,7 @@ on `DNS-Rebinding`_. Home routers include a protection mechanism for this attack by never returning a local IP (v4 & v6) address. In the context of the NextBox this means that, if you are using IPv6, the IPv6 address -of your NextBox is considered local by your router and thus wiull not be returned +of your NextBox is considered local by your router and thus will not be returned during DNS resolving of your designated domain. .. note:: For IPv4 this is also applies, but not a problem. In the IPv4 diff --git a/source/components/nextbox/remote/dynamic-dns.rst b/source/components/nextbox/remote/dynamic-dns.rst index 568d289133..b08f74a7ce 100644 --- a/source/components/nextbox/remote/dynamic-dns.rst +++ b/source/components/nextbox/remote/dynamic-dns.rst @@ -33,7 +33,7 @@ these steps to configure your NextBox using the Guided Dynamic DNS method: allow you to login into your account. * In step two the just acquired secret token shall be inserted into the input - field to complete your guided dynamic dns configuration. + field to complete your guided dynamic DNS configuration. .. hint:: Your token will only be presented once to you (after the verification process). If you need a new token, you need to create a new one inside the @@ -63,7 +63,7 @@ The one used for the guided DNS configuration uses the following template: password='[token]' [domain] -* Once you actiavted this configuration, you can *Continue to TLS activation* - +* Once you activated this configuration, you can *Continue to TLS activation* - see below @@ -74,7 +74,7 @@ On this page first wait for the status-bars to settle and mainly ensure that *reachability* of your NextBox is tested successfully. If this is the case, just click **Enable TLS** to acquire your TLS certificate. -.. note:: If the reachibility test fails, make sure your :doc:`port forwarding ` is configured properly. +.. note:: If the reachability test fails, make sure your :doc:`port forwarding ` is configured properly. diff --git a/source/components/nextbox/remote/port-forwarding.rst b/source/components/nextbox/remote/port-forwarding.rst index e31d3b68e8..ff96312fd5 100644 --- a/source/components/nextbox/remote/port-forwarding.rst +++ b/source/components/nextbox/remote/port-forwarding.rst @@ -30,10 +30,10 @@ ports 80 (HTTP-Server) and 443 (HTTPS-Server).** On a recent *Fritz!Box* you will find this configuration inside: "Internet -> Permit Access -> Port Sharing" -**On some routers it may also be necessary to explicitly state that the Nextbox gets +**On some routers it may also be necessary to explicitly state that the NextBox gets assigned the same IP address every time.** On a recent *Fritz!Box* you will find this configuration inside: -"Home Network -> Network -> Network Connections -> (Edit) for the Nextbox" +"Home Network -> Network -> Network Connections -> (Edit) for the NextBox" Then select "Assign permanent IPv4 address". diff --git a/source/components/nextbox/remote/proxy.rst b/source/components/nextbox/remote/proxy.rst index 8cfd63ba5b..1e1027933c 100644 --- a/source/components/nextbox/remote/proxy.rst +++ b/source/components/nextbox/remote/proxy.rst @@ -13,7 +13,7 @@ recommended, please be aware that this method also comes with some drawbacks: end-to-end encrypted. *In particular, if this server is compromised, your traffic might be readable.* -* The same reason also introduces a bandwith bottleneck, if you are connecting +* The same reason also introduces a bandwidth bottleneck, if you are connecting to your NextBox from within your local area network (LAN). As all traffic has to be send to our proxy server and from there to your NextBox, the available bandwidth is limited to roughly 50% of your upload or download bandwidth @@ -32,8 +32,6 @@ using a non-IPv6 enabled device. As of today e.g., various mobile network providers do not support IPv6 yet. - - .. There are several ways to enable remote access to the NextBox. The easiest way is to use the "Quickstart Configuration". Quickstart Configuration (recommended) @@ -70,5 +68,3 @@ providers do not support IPv6 yet. .. figure:: /components/nextbox/images/gettingstarted/10.png :alt: img10 - - diff --git a/source/components/nextbox/remote/walkthrough.rst b/source/components/nextbox/remote/walkthrough.rst index d378870271..02fd339119 100644 --- a/source/components/nextbox/remote/walkthrough.rst +++ b/source/components/nextbox/remote/walkthrough.rst @@ -1,6 +1,9 @@ Remote Access Walkthrough ========================= +.. spelling:word-list:: + deSEC + .. contents:: :local: This documentation aims to give you a thorough introduction into the Remote diff --git a/source/components/nitrokeys/features/fido2/website.rst b/source/components/nitrokeys/features/fido2/website.rst index b6975c5d04..89128c9ede 100644 --- a/source/components/nitrokeys/features/fido2/website.rst +++ b/source/components/nitrokeys/features/fido2/website.rst @@ -142,8 +142,8 @@ seconds until the green or blue LED lights up. | | | | registration | | | | | signal (user | | | | | presence); the | -| | | | conf | -| | | | iguration/reset | +| | | | configuration / | +| | | | reset | | | | | operations are | | | | | not accepted | +-----------------+-----------------+-----------------+-----------------+ diff --git a/source/components/nitrokeys/features/hidden-storage/index.rst b/source/components/nitrokeys/features/hidden-storage/index.rst index 5e814126e8..aa6ed65231 100644 --- a/source/components/nitrokeys/features/hidden-storage/index.rst +++ b/source/components/nitrokeys/features/hidden-storage/index.rst @@ -10,11 +10,11 @@ The concept is similar to `VeraCrypt's/TrueCrypt's hidden volume