|
1 | 1 | # OnlyKey App
|
2 | 2 |
|
3 |
| -The OnlyKey App is a configuration utility for the OnlyKey. For general |
4 |
| -information on OnlyKey check out [the OnlyKey Product Page](https://crp.to/p/) |
5 |
| -or [the OnlyKey Kickstarter Page][kickstarter]. |
| 3 | +This is the official app for **OnlyKey** |
6 | 4 |
|
7 |
| -OnlyKeys can be ordered from [the OnlyKey Product Page](https://crp.to/p/). |
| 5 | +OnlyKey can be purchased here: [OnlyKey order](http://www.crp.to/p/) |
8 | 6 |
|
9 |
| -## Introduction |
| 7 | +## Geting Started |
10 | 8 |
|
11 |
| -**OnlyKey App** is an app to be used along with an OnlyKey device. The app can |
12 |
| -be used for initial setup of your OnlyKey as well as configuration of usernames, |
13 |
| -passwords, and two-factor authentication. |
| 9 | +Just getting started with OnlyKey? |
| 10 | + |
| 11 | +[Start here](http://www.crp.to/okstart) |
| 12 | + |
| 13 | +## About |
| 14 | + |
| 15 | +**OnlyKey App** is an app to be used along with an OnlyKey device. The app is used for things like: |
| 16 | + |
| 17 | +- Initial setup of OnlyKey (PINs) |
| 18 | +- Configuration of accounts (Slots) |
| 19 | +- Loading keys for PGP, SSH, and secure backup (Keys) |
| 20 | +- Backup and restore of OnlyKey (Backup/Restore) |
| 21 | +- Setting OnlyKey preferences (Preferences) |
| 22 | +- Setting advanced options such as Yubikey and U2F security info (Advanced) |
| 23 | + |
| 24 | +*The app is required on all systems where Google Authenticator (TOTP) is used* |
| 25 | + |
| 26 | +For information on using the app see the [OnlyKey User's Guide](https://docs.crp.to/usersguide.html) |
14 | 27 |
|
15 | 28 | ## Installation
|
16 | 29 |
|
17 |
| -To use the **OnlyKey Chrome App:** |
| 30 | +To use the **standalone app:** |
| 31 | + |
| 32 | +- Obtain an installer from https://github.com/trustcrypto/OnlyKey-Chrome-App/releases/latest |
| 33 | +- Install and launch the app. |
| 34 | + |
| 35 | +To use the **OnlyKey Chrome App:** (Chromebook Users) |
18 | 36 |
|
19 | 37 | - Go to https://chrome.google.com/webstore/detail/onlykey-configuration/adafilbceehejjehoccladhbkgbjmica,
|
20 | 38 | click the **ADD TO CHROME** button.
|
21 | 39 | - Once the app installs ensure that your Chrome Bookmarks Bar is visible by
|
22 | 40 | going to Bookmarks -> Show Bookmarks bar.
|
23 | 41 | - Select "Apps" icon in the bookmarks bar and select **OnlyKey Configuration**.
|
24 | 42 |
|
25 |
| -To use the **standalone app:** |
| 43 | +## Support ## |
26 | 44 |
|
27 |
| -- Obtain an installer from https://github.com/trustcrypto/OnlyKey-Chrome-App/releases/latest |
28 |
| -- Install and launch the app. |
| 45 | +Check out the [OnlyKey Support Forum](https://groups.google.com/forum/#!forum/onlykey) |
| 46 | + |
| 47 | +Check out the [OnlyKey Documentation](https://docs.crp.to) |
29 | 48 |
|
30 | 49 | ### GNU/Linux users:
|
31 | 50 |
|
@@ -53,25 +72,31 @@ To create releases:
|
53 | 72 |
|
54 | 73 | $ npm run release
|
55 | 74 |
|
56 |
| -This will create an installer in the `releases/` subfolder. The installer is |
57 |
| -created for the current OS; this means you will need to run the `release` |
58 |
| -command on Windows, Linux, and Mac OS to generate all the installers. |
| 75 | +This will create an installer in the `releases/` subfolder. The installer is created for the current OS; this means you will need to run the `release` command on Windows, Linux, and Mac OS to generate all the installers. |
59 | 76 |
|
60 |
| -On Windows, you need to install [NSIS][nsis] first, and ensure that it's present |
61 |
| -in your shell's `%PATH%`. That is, add `C:/Program Files (x86)/NSIS` or similar |
62 |
| -to your `%PATH%` in the operating system settings. On Mac OS, you need to |
63 |
| -install an optional NPM dependecy: `npm install appdmg`. |
| 77 | +On Windows, you need to install [NSIS][nsis] first, and ensure that it's present in your shell's `%PATH%`. That is, add `C:/Program Files (x86)/NSIS` or similar to your `%PATH%` in the operating system settings. On Mac OS, you need to install an optional NPM dependecy: `npm install appdmg`. |
64 | 78 |
|
65 | 79 | To run tests:
|
66 | 80 |
|
67 | 81 | $ npm test
|
68 | 82 |
|
69 |
| -Running tests requires the SDK version of NWJS, which comes with a |
70 |
| -`chromedriver` that handles automated Selenium tests. To install that version, |
71 |
| -run `npm install nw --nwjs_build_type=sdk`. Note that to create releases, you |
72 |
| -should install the non-sdk variant again; otherwise the installer will be |
73 |
| -unnecessarily large. |
| 83 | +Running tests requires the SDK version of NWJS, which comes with a `chromedriver` that handles automated Selenium tests. To install that version, run `npm install nw --nwjs_build_type=sdk`. Note that to create releases, you should install the non-sdk variant again; otherwise the installer will be unnecessarily large. |
| 84 | + |
| 85 | +## Cryptography Notice |
| 86 | + |
| 87 | +This distribution includes cryptographic software. The country in which you currently reside may have restrictions on the import, possession, use, and/or re-export to another country, of encryption software. |
| 88 | +BEFORE using any encryption software, please check your country's laws, regulations and policies concerning the import, possession, or use, and re-export of encryption software, to see if this is permitted. |
| 89 | +See <http://www.wassenaar.org/> for more information. |
| 90 | + |
| 91 | +The U.S. Government Department of Commerce, Bureau of Industry and Security (BIS), has classified this software as Export Commodity Control Number (ECCN) 5D002.C.1, which includes information security software using or performing cryptographic functions with asymmetric algorithms. |
| 92 | +The form and manner of this distribution makes it eligible for export under the License Exception ENC Technology Software Unrestricted (TSU) exception (see the BIS Export Administration Regulations, Section 740.13) for both object code and source code. |
| 93 | + |
| 94 | +The following cryptographic software is included in this distribution: |
| 95 | + |
| 96 | + "OpenPGP.js - OpenPGP JavaScript Implementation." - https://openpgpjs.org/ |
| 97 | + |
| 98 | +For more information on export restrictions see: http://www.apache.org/licenses/exports/ |
74 | 99 |
|
| 100 | +## Source |
75 | 101 |
|
76 |
| -[kickstarter]: https://www.kickstarter.com/projects/1048259057/openkey-the-two-factor-authentication-and-password/description |
77 |
| -[nsis]: http://nsis.sourceforge.net/Main_Page |
| 102 | +[OnlyKey App on Github](https://github.com/trustcrypto/OnlyKey-Chrome-App) |
0 commit comments