Skip to content

Commit 6643776

Browse files
qryptdevqryptdev
authored
UI and TLS config documentation (#91)
* add on-prem appliance UI docs * TLS config instructions * minor formatting changes
1 parent 72f1cd8 commit 6643776

File tree

38 files changed

+807
-592
lines changed

38 files changed

+807
-592
lines changed

‎content/eaas/appliance/_index.md

Lines changed: 54 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,8 @@ Due to the high overhead cost of making HTTP requests, the amount of entropy tha
2626
**Max API throughput:**
2727
| 256 bit keys per request| Requests per second
2828
|---|---|
29-
|512|~4,800|
30-
|1|~8,000|
29+
|512|~7,200|
30+
|1|~12,000|
3131

3232
**Max Entropy card output:** ~1,500 Mb/s
3333

@@ -47,6 +47,58 @@ The root path (“/”) returns a UI that displays various metrics, and health r
4747

4848
Client applications can request a configurable amount of entropy from the entropy API, which is served from the “/api/v1/” route. The complete spec for the API can be found below.
4949

50+
---
51+
# Appliance Administration UI
52+
53+
Upon opening the UI, you should see the following landing page:
54+
55+
![FullPage](images/full_page.png?classes=shadow)
56+
57+
Each QRNG card installed on the appliance will have its own entry in the table, sorted by card ID.
58+
59+
The current state of the card can be determined by a quick glance at the "Status" column. Possible states are as follows:
60+
61+
|State|Explanation|
62+
|---|---|
63+
|{{< badge "active" >}}|The card is healthy and streaming entropy.|
64+
|{{< badge "pending" >}}|The card is in a temporary calibration state; this will resolve into either *Active* or *Error*.|
65+
|{{< badge "error" >}}|The card is reporting an error; the error message can be found in details section.|
66+
67+
Clicking on a card will expand the row and show more detail:
68+
69+
![StatusTable](images/status_table.png?classes=shadow)
70+
71+
If the card is in an {{< badge "error" >}} state, the number of errors and the error messages will be enumerated at the bottom of the details section.
72+
73+
If the card is {{< badge "pending" >}}, a "Status Message" field will provide more information. This typically only happens on startup while the initial NIST test suite runs -- upon success, the card will move into an {{< badge "active" >}} state and begin streaming entropy.
74+
75+
*Note that the badge in the "Status" section here is the same as in the card row entry.*
76+
77+
At the bottom right of the UI, there is a link to download a compressed bundle of server logs:
78+
79+
![DownloadLogs](images/download_logs.png?width=300px&classes=shadow)
80+
81+
Note that this may take up to 30 seconds depending on the size of the logfiles, so do not navigate away from the page while the collection is in progress. Logfile processing is indicated by the presence of an animated spinner.
82+
83+
---
84+
85+
# TLS Configuration
86+
87+
To enable TLS on the appliance, replace the following two files with your own public and private certs, respectively:
88+
89+
- /etc/ssl/certs/public.crt
90+
- /etc/ssl/private/private.key
91+
92+
Then, restart *nginx* for the new certs to take effect:
93+
94+
- systemctl restart nginx
95+
96+
You can test this new configuration by running:
97+
98+
- nginx -t
99+
100+
*Note that these operations must be done as sudo user.*
101+
50102
---
51103
# OpenAPI spec
52104

‎content/eaas/appliance/images/card_details.png

38.3 KB
Loading

‎content/eaas/appliance/images/download_logs.png

18.4 KB
Loading

‎content/eaas/appliance/images/full_page.png

227 KB
Loading

‎content/eaas/appliance/images/status_table.png

114 KB
Loading

‎docs/404.html

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -9,15 +9,15 @@
99
<title>404 Page not found</title>
1010

1111

12-
<link href="./css/nucleus.css?1727727456" rel="stylesheet">
13-
<link href="./css/fontawesome-all.min.css?1727727456" rel="stylesheet">
14-
<link href="./css/hybrid.css?1727727456" rel="stylesheet">
15-
<link href="./css/featherlight.min.css?1727727456" rel="stylesheet">
16-
<link href="./css/perfect-scrollbar.min.css?1727727456" rel="stylesheet">
17-
<link href="./css/theme.css?1727727456" rel="stylesheet">
18-
<link href="./css/hugo-theme.css?1727727456" rel="stylesheet">
12+
<link href="./css/nucleus.css?1729087731" rel="stylesheet">
13+
<link href="./css/fontawesome-all.min.css?1729087731" rel="stylesheet">
14+
<link href="./css/hybrid.css?1729087731" rel="stylesheet">
15+
<link href="./css/featherlight.min.css?1729087731" rel="stylesheet">
16+
<link href="./css/perfect-scrollbar.min.css?1729087731" rel="stylesheet">
17+
<link href="./css/theme.css?1729087731" rel="stylesheet">
18+
<link href="./css/hugo-theme.css?1729087731" rel="stylesheet">
1919

20-
<link href="./css/theme-mine.css?1727727456" rel="stylesheet">
20+
<link href="./css/theme-mine.css?1729087731" rel="stylesheet">
2121

2222
<style>
2323
:root #header + #content > #left > #rlblock_left {

‎docs/categories/index.html

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
<head>
44
<meta charset="utf-8">
55
<meta name="viewport" content="width=device-width, initial-scale=1.0">
6-
<meta name="generator" content="Hugo 0.134.3">
6+
<meta name="generator" content="Hugo 0.136.0">
77
<meta name="description" content="">
88

99

@@ -12,22 +12,22 @@
1212
<title>Categories :: Qrypt</title>
1313

1414

15-
<link href="../css/nucleus.css?1727727456" rel="stylesheet">
16-
<link href="../css/fontawesome-all.min.css?1727727456" rel="stylesheet">
17-
<link href="../css/hybrid.css?1727727456" rel="stylesheet">
18-
<link href="../css/featherlight.min.css?1727727456" rel="stylesheet">
19-
<link href="../css/perfect-scrollbar.min.css?1727727456" rel="stylesheet">
20-
<link href="../css/auto-complete.css?1727727456" rel="stylesheet">
21-
<link href="../css/atom-one-dark-reasonable.css?1727727456" rel="stylesheet">
22-
<link href="../css/theme.css?1727727456" rel="stylesheet">
23-
<link href="../css/tabs.css?1727727456" rel="stylesheet">
24-
<link href="../css/hugo-theme.css?1727727456" rel="stylesheet">
15+
<link href="../css/nucleus.css?1729087731" rel="stylesheet">
16+
<link href="../css/fontawesome-all.min.css?1729087731" rel="stylesheet">
17+
<link href="../css/hybrid.css?1729087731" rel="stylesheet">
18+
<link href="../css/featherlight.min.css?1729087731" rel="stylesheet">
19+
<link href="../css/perfect-scrollbar.min.css?1729087731" rel="stylesheet">
20+
<link href="../css/auto-complete.css?1729087731" rel="stylesheet">
21+
<link href="../css/atom-one-dark-reasonable.css?1729087731" rel="stylesheet">
22+
<link href="../css/theme.css?1729087731" rel="stylesheet">
23+
<link href="../css/tabs.css?1729087731" rel="stylesheet">
24+
<link href="../css/hugo-theme.css?1729087731" rel="stylesheet">
2525

26-
<link href="../css/theme-mine.css?1727727456" rel="stylesheet">
26+
<link href="../css/theme-mine.css?1729087731" rel="stylesheet">
2727

2828

2929

30-
<script src="../js/jquery-3.3.1.min.js?1727727456"></script>
30+
<script src="../js/jquery-3.3.1.min.js?1729087731"></script>
3131

3232

3333
</head>
@@ -894,19 +894,19 @@ <h1>
894894
<div style="left: -1000px; overflow: scroll; position: absolute; top: -1000px; border: none; box-sizing: content-box; height: 200px; margin: 0px; padding: 0px; width: 200px;">
895895
<div style="border: none; box-sizing: content-box; height: 200px; margin: 0px; padding: 0px; width: 200px;"></div>
896896
</div>
897-
<script src="../js/clipboard.min.js?1727727456"></script>
898-
<script src="../js/perfect-scrollbar.min.js?1727727456"></script>
899-
<script src="../js/perfect-scrollbar.jquery.min.js?1727727456"></script>
900-
<script src="../js/jquery.sticky.js?1727727456"></script>
901-
<script src="../js/featherlight.min.js?1727727456"></script>
902-
<script src="../js/highlight.pack.js?1727727456"></script>
897+
<script src="../js/clipboard.min.js?1729087731"></script>
898+
<script src="../js/perfect-scrollbar.min.js?1729087731"></script>
899+
<script src="../js/perfect-scrollbar.jquery.min.js?1729087731"></script>
900+
<script src="../js/jquery.sticky.js?1729087731"></script>
901+
<script src="../js/featherlight.min.js?1729087731"></script>
902+
<script src="../js/highlight.pack.js?1729087731"></script>
903903
<script>hljs.initHighlightingOnLoad();</script>
904-
<script src="../js/modernizr.custom-3.6.0.js?1727727456"></script>
905-
<script src="../js/learn.js?1727727456"></script>
906-
<script src="../js/hugo-learn.js?1727727456"></script>
904+
<script src="../js/modernizr.custom-3.6.0.js?1729087731"></script>
905+
<script src="../js/learn.js?1729087731"></script>
906+
<script src="../js/hugo-learn.js?1729087731"></script>
907907

908908

909-
<script src="../mermaid/mermaid.js?1727727456"></script>
909+
<script src="../mermaid/mermaid.js?1729087731"></script>
910910

911911
<script>
912912
mermaid.initialize({ startOnLoad: true });

‎docs/concepts/entropy-projection/index.html

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
<head>
44
<meta charset="utf-8">
55
<meta name="viewport" content="width=device-width, initial-scale=1.0">
6-
<meta name="generator" content="Hugo 0.134.3">
6+
<meta name="generator" content="Hugo 0.136.0">
77
<meta name="description" content="">
88

99

@@ -12,22 +12,22 @@
1212
<title>Key Entropy Size :: Qrypt</title>
1313

1414

15-
<link href="../../css/nucleus.css?1727727456" rel="stylesheet">
16-
<link href="../../css/fontawesome-all.min.css?1727727456" rel="stylesheet">
17-
<link href="../../css/hybrid.css?1727727456" rel="stylesheet">
18-
<link href="../../css/featherlight.min.css?1727727456" rel="stylesheet">
19-
<link href="../../css/perfect-scrollbar.min.css?1727727456" rel="stylesheet">
20-
<link href="../../css/auto-complete.css?1727727456" rel="stylesheet">
21-
<link href="../../css/atom-one-dark-reasonable.css?1727727456" rel="stylesheet">
22-
<link href="../../css/theme.css?1727727456" rel="stylesheet">
23-
<link href="../../css/tabs.css?1727727456" rel="stylesheet">
24-
<link href="../../css/hugo-theme.css?1727727456" rel="stylesheet">
15+
<link href="../../css/nucleus.css?1729087731" rel="stylesheet">
16+
<link href="../../css/fontawesome-all.min.css?1729087731" rel="stylesheet">
17+
<link href="../../css/hybrid.css?1729087731" rel="stylesheet">
18+
<link href="../../css/featherlight.min.css?1729087731" rel="stylesheet">
19+
<link href="../../css/perfect-scrollbar.min.css?1729087731" rel="stylesheet">
20+
<link href="../../css/auto-complete.css?1729087731" rel="stylesheet">
21+
<link href="../../css/atom-one-dark-reasonable.css?1729087731" rel="stylesheet">
22+
<link href="../../css/theme.css?1729087731" rel="stylesheet">
23+
<link href="../../css/tabs.css?1729087731" rel="stylesheet">
24+
<link href="../../css/hugo-theme.css?1729087731" rel="stylesheet">
2525

26-
<link href="../../css/theme-mine.css?1727727456" rel="stylesheet">
26+
<link href="../../css/theme-mine.css?1729087731" rel="stylesheet">
2727

2828

2929

30-
<script src="../../js/jquery-3.3.1.min.js?1727727456"></script>
30+
<script src="../../js/jquery-3.3.1.min.js?1729087731"></script>
3131

3232

3333
</head>
@@ -1023,19 +1023,19 @@ <h2 id="formula">Formula</h2>
10231023
<div style="left: -1000px; overflow: scroll; position: absolute; top: -1000px; border: none; box-sizing: content-box; height: 200px; margin: 0px; padding: 0px; width: 200px;">
10241024
<div style="border: none; box-sizing: content-box; height: 200px; margin: 0px; padding: 0px; width: 200px;"></div>
10251025
</div>
1026-
<script src="../../js/clipboard.min.js?1727727456"></script>
1027-
<script src="../../js/perfect-scrollbar.min.js?1727727456"></script>
1028-
<script src="../../js/perfect-scrollbar.jquery.min.js?1727727456"></script>
1029-
<script src="../../js/jquery.sticky.js?1727727456"></script>
1030-
<script src="../../js/featherlight.min.js?1727727456"></script>
1031-
<script src="../../js/highlight.pack.js?1727727456"></script>
1026+
<script src="../../js/clipboard.min.js?1729087731"></script>
1027+
<script src="../../js/perfect-scrollbar.min.js?1729087731"></script>
1028+
<script src="../../js/perfect-scrollbar.jquery.min.js?1729087731"></script>
1029+
<script src="../../js/jquery.sticky.js?1729087731"></script>
1030+
<script src="../../js/featherlight.min.js?1729087731"></script>
1031+
<script src="../../js/highlight.pack.js?1729087731"></script>
10321032
<script>hljs.initHighlightingOnLoad();</script>
1033-
<script src="../../js/modernizr.custom-3.6.0.js?1727727456"></script>
1034-
<script src="../../js/learn.js?1727727456"></script>
1035-
<script src="../../js/hugo-learn.js?1727727456"></script>
1033+
<script src="../../js/modernizr.custom-3.6.0.js?1729087731"></script>
1034+
<script src="../../js/learn.js?1729087731"></script>
1035+
<script src="../../js/hugo-learn.js?1729087731"></script>
10361036

10371037

1038-
<script src="../../mermaid/mermaid.js?1727727456"></script>
1038+
<script src="../../mermaid/mermaid.js?1729087731"></script>
10391039

10401040
<script>
10411041
mermaid.initialize({ startOnLoad: true });

‎docs/concepts/index.html

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
<head>
44
<meta charset="utf-8">
55
<meta name="viewport" content="width=device-width, initial-scale=1.0">
6-
<meta name="generator" content="Hugo 0.134.3">
6+
<meta name="generator" content="Hugo 0.136.0">
77
<meta name="description" content="">
88

99

@@ -12,22 +12,22 @@
1212
<title>Concepts :: Qrypt</title>
1313

1414

15-
<link href="../css/nucleus.css?1727727456" rel="stylesheet">
16-
<link href="../css/fontawesome-all.min.css?1727727456" rel="stylesheet">
17-
<link href="../css/hybrid.css?1727727456" rel="stylesheet">
18-
<link href="../css/featherlight.min.css?1727727456" rel="stylesheet">
19-
<link href="../css/perfect-scrollbar.min.css?1727727456" rel="stylesheet">
20-
<link href="../css/auto-complete.css?1727727456" rel="stylesheet">
21-
<link href="../css/atom-one-dark-reasonable.css?1727727456" rel="stylesheet">
22-
<link href="../css/theme.css?1727727456" rel="stylesheet">
23-
<link href="../css/tabs.css?1727727456" rel="stylesheet">
24-
<link href="../css/hugo-theme.css?1727727456" rel="stylesheet">
15+
<link href="../css/nucleus.css?1729087731" rel="stylesheet">
16+
<link href="../css/fontawesome-all.min.css?1729087731" rel="stylesheet">
17+
<link href="../css/hybrid.css?1729087731" rel="stylesheet">
18+
<link href="../css/featherlight.min.css?1729087731" rel="stylesheet">
19+
<link href="../css/perfect-scrollbar.min.css?1729087731" rel="stylesheet">
20+
<link href="../css/auto-complete.css?1729087731" rel="stylesheet">
21+
<link href="../css/atom-one-dark-reasonable.css?1729087731" rel="stylesheet">
22+
<link href="../css/theme.css?1729087731" rel="stylesheet">
23+
<link href="../css/tabs.css?1729087731" rel="stylesheet">
24+
<link href="../css/hugo-theme.css?1729087731" rel="stylesheet">
2525

26-
<link href="../css/theme-mine.css?1727727456" rel="stylesheet">
26+
<link href="../css/theme-mine.css?1729087731" rel="stylesheet">
2727

2828

2929

30-
<script src="../js/jquery-3.3.1.min.js?1727727456"></script>
30+
<script src="../js/jquery-3.3.1.min.js?1729087731"></script>
3131

3232

3333
</head>
@@ -901,19 +901,19 @@ <h2 id="one-time-pad-otpotp"><a href="otp/">One-Time Pad (OTP)</a></h2>
901901
<div style="left: -1000px; overflow: scroll; position: absolute; top: -1000px; border: none; box-sizing: content-box; height: 200px; margin: 0px; padding: 0px; width: 200px;">
902902
<div style="border: none; box-sizing: content-box; height: 200px; margin: 0px; padding: 0px; width: 200px;"></div>
903903
</div>
904-
<script src="../js/clipboard.min.js?1727727456"></script>
905-
<script src="../js/perfect-scrollbar.min.js?1727727456"></script>
906-
<script src="../js/perfect-scrollbar.jquery.min.js?1727727456"></script>
907-
<script src="../js/jquery.sticky.js?1727727456"></script>
908-
<script src="../js/featherlight.min.js?1727727456"></script>
909-
<script src="../js/highlight.pack.js?1727727456"></script>
904+
<script src="../js/clipboard.min.js?1729087731"></script>
905+
<script src="../js/perfect-scrollbar.min.js?1729087731"></script>
906+
<script src="../js/perfect-scrollbar.jquery.min.js?1729087731"></script>
907+
<script src="../js/jquery.sticky.js?1729087731"></script>
908+
<script src="../js/featherlight.min.js?1729087731"></script>
909+
<script src="../js/highlight.pack.js?1729087731"></script>
910910
<script>hljs.initHighlightingOnLoad();</script>
911-
<script src="../js/modernizr.custom-3.6.0.js?1727727456"></script>
912-
<script src="../js/learn.js?1727727456"></script>
913-
<script src="../js/hugo-learn.js?1727727456"></script>
911+
<script src="../js/modernizr.custom-3.6.0.js?1729087731"></script>
912+
<script src="../js/learn.js?1729087731"></script>
913+
<script src="../js/hugo-learn.js?1729087731"></script>
914914

915915

916-
<script src="../mermaid/mermaid.js?1727727456"></script>
916+
<script src="../mermaid/mermaid.js?1729087731"></script>
917917

918918
<script>
919919
mermaid.initialize({ startOnLoad: true });

‎docs/concepts/key-generation-architecture/index.html

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
<head>
44
<meta charset="utf-8">
55
<meta name="viewport" content="width=device-width, initial-scale=1.0">
6-
<meta name="generator" content="Hugo 0.134.3">
6+
<meta name="generator" content="Hugo 0.136.0">
77
<meta name="description" content="">
88

99

@@ -12,22 +12,22 @@
1212
<title>Key Generation Architecture :: Qrypt</title>
1313

1414

15-
<link href="../../css/nucleus.css?1727727456" rel="stylesheet">
16-
<link href="../../css/fontawesome-all.min.css?1727727456" rel="stylesheet">
17-
<link href="../../css/hybrid.css?1727727456" rel="stylesheet">
18-
<link href="../../css/featherlight.min.css?1727727456" rel="stylesheet">
19-
<link href="../../css/perfect-scrollbar.min.css?1727727456" rel="stylesheet">
20-
<link href="../../css/auto-complete.css?1727727456" rel="stylesheet">
21-
<link href="../../css/atom-one-dark-reasonable.css?1727727456" rel="stylesheet">
22-
<link href="../../css/theme.css?1727727456" rel="stylesheet">
23-
<link href="../../css/tabs.css?1727727456" rel="stylesheet">
24-
<link href="../../css/hugo-theme.css?1727727456" rel="stylesheet">
15+
<link href="../../css/nucleus.css?1729087731" rel="stylesheet">
16+
<link href="../../css/fontawesome-all.min.css?1729087731" rel="stylesheet">
17+
<link href="../../css/hybrid.css?1729087731" rel="stylesheet">
18+
<link href="../../css/featherlight.min.css?1729087731" rel="stylesheet">
19+
<link href="../../css/perfect-scrollbar.min.css?1729087731" rel="stylesheet">
20+
<link href="../../css/auto-complete.css?1729087731" rel="stylesheet">
21+
<link href="../../css/atom-one-dark-reasonable.css?1729087731" rel="stylesheet">
22+
<link href="../../css/theme.css?1729087731" rel="stylesheet">
23+
<link href="../../css/tabs.css?1729087731" rel="stylesheet">
24+
<link href="../../css/hugo-theme.css?1729087731" rel="stylesheet">
2525

26-
<link href="../../css/theme-mine.css?1727727456" rel="stylesheet">
26+
<link href="../../css/theme-mine.css?1729087731" rel="stylesheet">
2727

2828

2929

30-
<script src="../../js/jquery-3.3.1.min.js?1727727456"></script>
30+
<script src="../../js/jquery-3.3.1.min.js?1729087731"></script>
3131

3232

3333
</head>
@@ -930,19 +930,19 @@ <h1>
930930
<div style="left: -1000px; overflow: scroll; position: absolute; top: -1000px; border: none; box-sizing: content-box; height: 200px; margin: 0px; padding: 0px; width: 200px;">
931931
<div style="border: none; box-sizing: content-box; height: 200px; margin: 0px; padding: 0px; width: 200px;"></div>
932932
</div>
933-
<script src="../../js/clipboard.min.js?1727727456"></script>
934-
<script src="../../js/perfect-scrollbar.min.js?1727727456"></script>
935-
<script src="../../js/perfect-scrollbar.jquery.min.js?1727727456"></script>
936-
<script src="../../js/jquery.sticky.js?1727727456"></script>
937-
<script src="../../js/featherlight.min.js?1727727456"></script>
938-
<script src="../../js/highlight.pack.js?1727727456"></script>
933+
<script src="../../js/clipboard.min.js?1729087731"></script>
934+
<script src="../../js/perfect-scrollbar.min.js?1729087731"></script>
935+
<script src="../../js/perfect-scrollbar.jquery.min.js?1729087731"></script>
936+
<script src="../../js/jquery.sticky.js?1729087731"></script>
937+
<script src="../../js/featherlight.min.js?1729087731"></script>
938+
<script src="../../js/highlight.pack.js?1729087731"></script>
939939
<script>hljs.initHighlightingOnLoad();</script>
940-
<script src="../../js/modernizr.custom-3.6.0.js?1727727456"></script>
941-
<script src="../../js/learn.js?1727727456"></script>
942-
<script src="../../js/hugo-learn.js?1727727456"></script>
940+
<script src="../../js/modernizr.custom-3.6.0.js?1729087731"></script>
941+
<script src="../../js/learn.js?1729087731"></script>
942+
<script src="../../js/hugo-learn.js?1729087731"></script>
943943

944944

945-
<script src="../../mermaid/mermaid.js?1727727456"></script>
945+
<script src="../../mermaid/mermaid.js?1729087731"></script>
946946

947947
<script>
948948
mermaid.initialize({ startOnLoad: true });

0 commit comments

Comments
 (0)