Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions rstcheck.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
[tool.rstcheck]
ignore_directives = [
"card",
"dropdown",
"tabs",
"faq",
"product-table",
Expand Down
1 change: 1 addition & 0 deletions source/components/software/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,5 +6,6 @@ Software
:titlesonly:

nk-app2/index
nk-app1/index
nitropy/index
nitrokey-sdk-py/index
146 changes: 146 additions & 0 deletions source/components/software/nk-app1/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,146 @@
Nitrokey App 1
==============

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/>`__.

Installation
------------

The latest Nitrokey App is version 1.4.2 (`Release notes <https://github.com/Nitrokey/nitrokey-app/releases/>`__, `PGP signatures and older versions <https://github.com/Nitrokey/nitrokey-app/releases/>`__).

Released binaries are signed by PGP key:
`868184069239FF65DE0BCD7DD9BAE35991DE5B22 <https://keys.openpgp.org/vks/v1/by-fingerprint/868184069239FF65DE0BCD7DD9BAE35991DE5B22>`__ `szczepan@nitrokey.com <szczepan@nitrokey.com>`__.

Linux
*****

.. dropdown:: Alpine Linux

Nitrokey App isn't an official package to Alpine Linux but this `inofficial package <https://git.alpinelinux.org/aports/tree/community/nitrokey-app/APKBUILD?id=d80ddaa597091157e11b96586ecc8c955920b2a1>`__ can be used.

.. dropdown:: Arch Linux

The Nitrokey App is included in the official extra repo.

.. code-block:: bash

$ pacman -S nitrokey-app

.. dropdown:: Debian

For Debian 9 and newer, the Nitrokey App is included in the Debian repository.

.. code-block:: bash

$ sudo apt update
$ sudo apt install nitrokey-app

Unfortunately, the App versions in the official Debian repositories are often not up-to-date.

.. dropdown:: Fedora

Nitrokey App `is part <https://koji.fedoraproject.org/koji/packageinfo?packageID=23317>`__ of Fedora's package repositories.

.. code-block:: bash

$ sudo dnf install nitrokey-app

.. dropdown:: Guix

Further information `here <https://guix.gnu.org/packages/nitrokey-app-1.4.2/>`__.

.. dropdown:: NixOS

Nitrokey App `is part <https://github.com/NixOS/nixpkgs/tree/master/pkgs/by-name/ni/nitrokey-app>`__ of NixOS's package repository.

.. dropdown:: Slackware

Available at `Slackbuilds <http://slackbuilds.org/repository/14.2/desktop/nitrokey-app/?search=nitrokey>`__.

.. dropdown:: SUSE

Nitrokey App `is part <https://software.opensuse.org/download.html?project=security&package=nitrokey-app>`__ of SUSE's package repository. You can just install it `like every other software <https://en.opensuse.org/YaST_Software_Management>`__.

.. dropdown:: Ubuntu

The Nitrokey App is included in Ubuntu's repositories since Ubuntu 18.04 (codename 'bionic') on.

.. code-block:: bash

$ sudo apt update
$ sudo apt install nitrokey-app

Unfortunately, the App versions in the official Ubuntu repositories are often not up-to-date.

**More recent App versions**

To get the most recent Nitrokey App you can add a separate repository which is maintained by Nitrokey.

.. code-block:: bash

$ sudo add-apt-repository ppa:nitrokey/nitrokey
$ sudo apt install nitrokey-app

**Alternatively**, you can use the snap package. Please see the **Snap** entry for more information.

.. 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.
See `here <https://github.com/Nitrokey/nitrokey-app/releases/latest>`__ 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.

.. dropdown:: Flatpak

.. code-block:: bash

$ flatpak install flathub com.nitrokey.nitrokey-app
$ flatpak run com.nitrokey.nitrokey-app

For more information visit `Flathub <https://flathub.org/apps/details/com.nitrokey.nitrokey-app>`__.

.. dropdown:: Snap

.. note::

There is a problem with the current Snap package. Please make sure that scdaemon is installed by typing

.. code-block:: bash

$ apt-get update && apt-get install scdaemon

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 <https://snapcraft.io/>`__ first. As soon as you have Snap installed you can open a terminal and type

.. code-block:: bash

$ sudo snap install nitrokey-app --devmode

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] <https://bugs.launchpad.net/ubuntu/+source/snapd/+bug/1592696/comments/7>`__ `[2] <https://bugs.launchpad.net/ubuntu/+source/snapd/+bug/1592696/comments/8>`__.

Windows
*******

Download .exe file from `here <https://github.com/Nitrokey/nitrokey-app/releases/latest>`__.

macOS
*****

Download latest Nitrokey App (DMG file) `here <https://github.com/Nitrokey/nitrokey-app/releases/latest>`__.
**Note:** The Nitrokey App was not notarized by Apple yet, which is required by macOS 10.15. See this `forum post <https://support.nitrokey.com/t/failed-install-on-macos-catalina/2047>`__ for more information.

FreeBSD
*******

.. code-block:: bash

$ pkg install nitrokey-app

Source
******

You can download and compile the source code from `here <https://github.com/Nitrokey/nitrokey-app/>`__. In this case you may need to install `these UDEV rules <https://www.nitrokey.com/sites/default/files/41-nitrokey.rules>`__ manually.
2 changes: 1 addition & 1 deletion source/components/software/nk-app2/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Available languages: English, German, French, Italian, Polish, and Arabic. Langu

.. note::

This application is compatible only with Nitrokey 3 devices. For Nitrokey Pro and Nitrokey Storage devices, please use `Nitrokey App 1 <https://www.nitrokey.com/download>`__.
This application is compatible only with Nitrokey 3 devices. For Nitrokey Pro and Nitrokey Storage devices, please use `Nitrokey App 1 <../nk-app1/>`__.

Installation
------------
Expand Down
Loading