Skip to content

Commit

Permalink
TLS config instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
qryptdev committed Oct 15, 2024
1 parent d4a1888 commit 2a8dd9f
Show file tree
Hide file tree
Showing 27 changed files with 564 additions and 543 deletions.
20 changes: 17 additions & 3 deletions content/eaas/appliance/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ Upon opening the UI, you should see the following landing page:

Each QRNG card installed on the appliance will have its own entry in the table, sorted by card ID.

The current state of the card can be determined by a quick glance at the `Status` column. Possible states are as follows:
The current state of the card can be determined by a quick glance at the "Status" column. Possible states are as follows:

|State|Explanation|
|---|---|
Expand All @@ -72,16 +72,30 @@ Selecting a card will expand the row and show more detail:

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.

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.
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.

*Note that the badge in the `Status` section here is the same as in the card row entry.*
*Note that the badge in the "Status" section here is the same as in the card row entry.*

At the bottom right of the UI, there is a link to download a compressed bundle of server logs:

![DownloadLogs](images/download_logs.png?width=300px&classes=shadow)

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.

---

# TLS Configuration

To enable TLS on the appliance, replace the following two files with your own public and private certs, respectively:

/etc/ssl/certs/public.crt

/etc/ssl/private/private.key

Then, restart *nginx* for the new certs to take effect:

systemctl restart nginx

---
# OpenAPI spec

Expand Down
16 changes: 8 additions & 8 deletions docs/404.html
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,15 @@
<title>404 Page not found</title>


<link href="./css/nucleus.css?1729025234" rel="stylesheet">
<link href="./css/fontawesome-all.min.css?1729025234" rel="stylesheet">
<link href="./css/hybrid.css?1729025234" rel="stylesheet">
<link href="./css/featherlight.min.css?1729025234" rel="stylesheet">
<link href="./css/perfect-scrollbar.min.css?1729025234" rel="stylesheet">
<link href="./css/theme.css?1729025234" rel="stylesheet">
<link href="./css/hugo-theme.css?1729025234" rel="stylesheet">
<link href="./css/nucleus.css?1729027415" rel="stylesheet">
<link href="./css/fontawesome-all.min.css?1729027415" rel="stylesheet">
<link href="./css/hybrid.css?1729027415" rel="stylesheet">
<link href="./css/featherlight.min.css?1729027415" rel="stylesheet">
<link href="./css/perfect-scrollbar.min.css?1729027415" rel="stylesheet">
<link href="./css/theme.css?1729027415" rel="stylesheet">
<link href="./css/hugo-theme.css?1729027415" rel="stylesheet">

<link href="./css/theme-mine.css?1729025234" rel="stylesheet">
<link href="./css/theme-mine.css?1729027415" rel="stylesheet">

<style>
:root #header + #content > #left > #rlblock_left {
Expand Down
44 changes: 22 additions & 22 deletions docs/categories/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -12,22 +12,22 @@
<title>Categories :: Qrypt</title>


<link href="../css/nucleus.css?1729025234" rel="stylesheet">
<link href="../css/fontawesome-all.min.css?1729025234" rel="stylesheet">
<link href="../css/hybrid.css?1729025234" rel="stylesheet">
<link href="../css/featherlight.min.css?1729025234" rel="stylesheet">
<link href="../css/perfect-scrollbar.min.css?1729025234" rel="stylesheet">
<link href="../css/auto-complete.css?1729025234" rel="stylesheet">
<link href="../css/atom-one-dark-reasonable.css?1729025234" rel="stylesheet">
<link href="../css/theme.css?1729025234" rel="stylesheet">
<link href="../css/tabs.css?1729025234" rel="stylesheet">
<link href="../css/hugo-theme.css?1729025234" rel="stylesheet">
<link href="../css/nucleus.css?1729027415" rel="stylesheet">
<link href="../css/fontawesome-all.min.css?1729027415" rel="stylesheet">
<link href="../css/hybrid.css?1729027415" rel="stylesheet">
<link href="../css/featherlight.min.css?1729027415" rel="stylesheet">
<link href="../css/perfect-scrollbar.min.css?1729027415" rel="stylesheet">
<link href="../css/auto-complete.css?1729027415" rel="stylesheet">
<link href="../css/atom-one-dark-reasonable.css?1729027415" rel="stylesheet">
<link href="../css/theme.css?1729027415" rel="stylesheet">
<link href="../css/tabs.css?1729027415" rel="stylesheet">
<link href="../css/hugo-theme.css?1729027415" rel="stylesheet">

<link href="../css/theme-mine.css?1729025234" rel="stylesheet">
<link href="../css/theme-mine.css?1729027415" rel="stylesheet">



<script src="../js/jquery-3.3.1.min.js?1729025234"></script>
<script src="../js/jquery-3.3.1.min.js?1729027415"></script>


</head>
Expand Down Expand Up @@ -894,19 +894,19 @@ <h1>
<div style="left: -1000px; overflow: scroll; position: absolute; top: -1000px; border: none; box-sizing: content-box; height: 200px; margin: 0px; padding: 0px; width: 200px;">
<div style="border: none; box-sizing: content-box; height: 200px; margin: 0px; padding: 0px; width: 200px;"></div>
</div>
<script src="../js/clipboard.min.js?1729025234"></script>
<script src="../js/perfect-scrollbar.min.js?1729025234"></script>
<script src="../js/perfect-scrollbar.jquery.min.js?1729025234"></script>
<script src="../js/jquery.sticky.js?1729025234"></script>
<script src="../js/featherlight.min.js?1729025234"></script>
<script src="../js/highlight.pack.js?1729025234"></script>
<script src="../js/clipboard.min.js?1729027415"></script>
<script src="../js/perfect-scrollbar.min.js?1729027415"></script>
<script src="../js/perfect-scrollbar.jquery.min.js?1729027415"></script>
<script src="../js/jquery.sticky.js?1729027415"></script>
<script src="../js/featherlight.min.js?1729027415"></script>
<script src="../js/highlight.pack.js?1729027415"></script>
<script>hljs.initHighlightingOnLoad();</script>
<script src="../js/modernizr.custom-3.6.0.js?1729025234"></script>
<script src="../js/learn.js?1729025234"></script>
<script src="../js/hugo-learn.js?1729025234"></script>
<script src="../js/modernizr.custom-3.6.0.js?1729027415"></script>
<script src="../js/learn.js?1729027415"></script>
<script src="../js/hugo-learn.js?1729027415"></script>


<script src="../mermaid/mermaid.js?1729025234"></script>
<script src="../mermaid/mermaid.js?1729027415"></script>

<script>
mermaid.initialize({ startOnLoad: true });
Expand Down
44 changes: 22 additions & 22 deletions docs/concepts/entropy-projection/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -12,22 +12,22 @@
<title>Key Entropy Size :: Qrypt</title>


<link href="../../css/nucleus.css?1729025234" rel="stylesheet">
<link href="../../css/fontawesome-all.min.css?1729025234" rel="stylesheet">
<link href="../../css/hybrid.css?1729025234" rel="stylesheet">
<link href="../../css/featherlight.min.css?1729025234" rel="stylesheet">
<link href="../../css/perfect-scrollbar.min.css?1729025234" rel="stylesheet">
<link href="../../css/auto-complete.css?1729025234" rel="stylesheet">
<link href="../../css/atom-one-dark-reasonable.css?1729025234" rel="stylesheet">
<link href="../../css/theme.css?1729025234" rel="stylesheet">
<link href="../../css/tabs.css?1729025234" rel="stylesheet">
<link href="../../css/hugo-theme.css?1729025234" rel="stylesheet">
<link href="../../css/nucleus.css?1729027415" rel="stylesheet">
<link href="../../css/fontawesome-all.min.css?1729027415" rel="stylesheet">
<link href="../../css/hybrid.css?1729027415" rel="stylesheet">
<link href="../../css/featherlight.min.css?1729027415" rel="stylesheet">
<link href="../../css/perfect-scrollbar.min.css?1729027415" rel="stylesheet">
<link href="../../css/auto-complete.css?1729027415" rel="stylesheet">
<link href="../../css/atom-one-dark-reasonable.css?1729027415" rel="stylesheet">
<link href="../../css/theme.css?1729027415" rel="stylesheet">
<link href="../../css/tabs.css?1729027415" rel="stylesheet">
<link href="../../css/hugo-theme.css?1729027415" rel="stylesheet">

<link href="../../css/theme-mine.css?1729025234" rel="stylesheet">
<link href="../../css/theme-mine.css?1729027415" rel="stylesheet">



<script src="../../js/jquery-3.3.1.min.js?1729025234"></script>
<script src="../../js/jquery-3.3.1.min.js?1729027415"></script>


</head>
Expand Down Expand Up @@ -1023,19 +1023,19 @@ <h2 id="formula">Formula</h2>
<div style="left: -1000px; overflow: scroll; position: absolute; top: -1000px; border: none; box-sizing: content-box; height: 200px; margin: 0px; padding: 0px; width: 200px;">
<div style="border: none; box-sizing: content-box; height: 200px; margin: 0px; padding: 0px; width: 200px;"></div>
</div>
<script src="../../js/clipboard.min.js?1729025234"></script>
<script src="../../js/perfect-scrollbar.min.js?1729025234"></script>
<script src="../../js/perfect-scrollbar.jquery.min.js?1729025234"></script>
<script src="../../js/jquery.sticky.js?1729025234"></script>
<script src="../../js/featherlight.min.js?1729025234"></script>
<script src="../../js/highlight.pack.js?1729025234"></script>
<script src="../../js/clipboard.min.js?1729027415"></script>
<script src="../../js/perfect-scrollbar.min.js?1729027415"></script>
<script src="../../js/perfect-scrollbar.jquery.min.js?1729027415"></script>
<script src="../../js/jquery.sticky.js?1729027415"></script>
<script src="../../js/featherlight.min.js?1729027415"></script>
<script src="../../js/highlight.pack.js?1729027415"></script>
<script>hljs.initHighlightingOnLoad();</script>
<script src="../../js/modernizr.custom-3.6.0.js?1729025234"></script>
<script src="../../js/learn.js?1729025234"></script>
<script src="../../js/hugo-learn.js?1729025234"></script>
<script src="../../js/modernizr.custom-3.6.0.js?1729027415"></script>
<script src="../../js/learn.js?1729027415"></script>
<script src="../../js/hugo-learn.js?1729027415"></script>


<script src="../../mermaid/mermaid.js?1729025234"></script>
<script src="../../mermaid/mermaid.js?1729027415"></script>

<script>
mermaid.initialize({ startOnLoad: true });
Expand Down
44 changes: 22 additions & 22 deletions docs/concepts/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -12,22 +12,22 @@
<title>Concepts :: Qrypt</title>


<link href="../css/nucleus.css?1729025234" rel="stylesheet">
<link href="../css/fontawesome-all.min.css?1729025234" rel="stylesheet">
<link href="../css/hybrid.css?1729025234" rel="stylesheet">
<link href="../css/featherlight.min.css?1729025234" rel="stylesheet">
<link href="../css/perfect-scrollbar.min.css?1729025234" rel="stylesheet">
<link href="../css/auto-complete.css?1729025234" rel="stylesheet">
<link href="../css/atom-one-dark-reasonable.css?1729025234" rel="stylesheet">
<link href="../css/theme.css?1729025234" rel="stylesheet">
<link href="../css/tabs.css?1729025234" rel="stylesheet">
<link href="../css/hugo-theme.css?1729025234" rel="stylesheet">
<link href="../css/nucleus.css?1729027415" rel="stylesheet">
<link href="../css/fontawesome-all.min.css?1729027415" rel="stylesheet">
<link href="../css/hybrid.css?1729027415" rel="stylesheet">
<link href="../css/featherlight.min.css?1729027415" rel="stylesheet">
<link href="../css/perfect-scrollbar.min.css?1729027415" rel="stylesheet">
<link href="../css/auto-complete.css?1729027415" rel="stylesheet">
<link href="../css/atom-one-dark-reasonable.css?1729027415" rel="stylesheet">
<link href="../css/theme.css?1729027415" rel="stylesheet">
<link href="../css/tabs.css?1729027415" rel="stylesheet">
<link href="../css/hugo-theme.css?1729027415" rel="stylesheet">

<link href="../css/theme-mine.css?1729025234" rel="stylesheet">
<link href="../css/theme-mine.css?1729027415" rel="stylesheet">



<script src="../js/jquery-3.3.1.min.js?1729025234"></script>
<script src="../js/jquery-3.3.1.min.js?1729027415"></script>


</head>
Expand Down Expand Up @@ -901,19 +901,19 @@ <h2 id="one-time-pad-otpotp"><a href="otp/">One-Time Pad (OTP)</a></h2>
<div style="left: -1000px; overflow: scroll; position: absolute; top: -1000px; border: none; box-sizing: content-box; height: 200px; margin: 0px; padding: 0px; width: 200px;">
<div style="border: none; box-sizing: content-box; height: 200px; margin: 0px; padding: 0px; width: 200px;"></div>
</div>
<script src="../js/clipboard.min.js?1729025234"></script>
<script src="../js/perfect-scrollbar.min.js?1729025234"></script>
<script src="../js/perfect-scrollbar.jquery.min.js?1729025234"></script>
<script src="../js/jquery.sticky.js?1729025234"></script>
<script src="../js/featherlight.min.js?1729025234"></script>
<script src="../js/highlight.pack.js?1729025234"></script>
<script src="../js/clipboard.min.js?1729027415"></script>
<script src="../js/perfect-scrollbar.min.js?1729027415"></script>
<script src="../js/perfect-scrollbar.jquery.min.js?1729027415"></script>
<script src="../js/jquery.sticky.js?1729027415"></script>
<script src="../js/featherlight.min.js?1729027415"></script>
<script src="../js/highlight.pack.js?1729027415"></script>
<script>hljs.initHighlightingOnLoad();</script>
<script src="../js/modernizr.custom-3.6.0.js?1729025234"></script>
<script src="../js/learn.js?1729025234"></script>
<script src="../js/hugo-learn.js?1729025234"></script>
<script src="../js/modernizr.custom-3.6.0.js?1729027415"></script>
<script src="../js/learn.js?1729027415"></script>
<script src="../js/hugo-learn.js?1729027415"></script>


<script src="../mermaid/mermaid.js?1729025234"></script>
<script src="../mermaid/mermaid.js?1729027415"></script>

<script>
mermaid.initialize({ startOnLoad: true });
Expand Down
44 changes: 22 additions & 22 deletions docs/concepts/key-generation-architecture/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -12,22 +12,22 @@
<title>Key Generation Architecture :: Qrypt</title>


<link href="../../css/nucleus.css?1729025234" rel="stylesheet">
<link href="../../css/fontawesome-all.min.css?1729025234" rel="stylesheet">
<link href="../../css/hybrid.css?1729025234" rel="stylesheet">
<link href="../../css/featherlight.min.css?1729025234" rel="stylesheet">
<link href="../../css/perfect-scrollbar.min.css?1729025234" rel="stylesheet">
<link href="../../css/auto-complete.css?1729025234" rel="stylesheet">
<link href="../../css/atom-one-dark-reasonable.css?1729025234" rel="stylesheet">
<link href="../../css/theme.css?1729025234" rel="stylesheet">
<link href="../../css/tabs.css?1729025234" rel="stylesheet">
<link href="../../css/hugo-theme.css?1729025234" rel="stylesheet">
<link href="../../css/nucleus.css?1729027415" rel="stylesheet">
<link href="../../css/fontawesome-all.min.css?1729027415" rel="stylesheet">
<link href="../../css/hybrid.css?1729027415" rel="stylesheet">
<link href="../../css/featherlight.min.css?1729027415" rel="stylesheet">
<link href="../../css/perfect-scrollbar.min.css?1729027415" rel="stylesheet">
<link href="../../css/auto-complete.css?1729027415" rel="stylesheet">
<link href="../../css/atom-one-dark-reasonable.css?1729027415" rel="stylesheet">
<link href="../../css/theme.css?1729027415" rel="stylesheet">
<link href="../../css/tabs.css?1729027415" rel="stylesheet">
<link href="../../css/hugo-theme.css?1729027415" rel="stylesheet">

<link href="../../css/theme-mine.css?1729025234" rel="stylesheet">
<link href="../../css/theme-mine.css?1729027415" rel="stylesheet">



<script src="../../js/jquery-3.3.1.min.js?1729025234"></script>
<script src="../../js/jquery-3.3.1.min.js?1729027415"></script>


</head>
Expand Down Expand Up @@ -930,19 +930,19 @@ <h1>
<div style="left: -1000px; overflow: scroll; position: absolute; top: -1000px; border: none; box-sizing: content-box; height: 200px; margin: 0px; padding: 0px; width: 200px;">
<div style="border: none; box-sizing: content-box; height: 200px; margin: 0px; padding: 0px; width: 200px;"></div>
</div>
<script src="../../js/clipboard.min.js?1729025234"></script>
<script src="../../js/perfect-scrollbar.min.js?1729025234"></script>
<script src="../../js/perfect-scrollbar.jquery.min.js?1729025234"></script>
<script src="../../js/jquery.sticky.js?1729025234"></script>
<script src="../../js/featherlight.min.js?1729025234"></script>
<script src="../../js/highlight.pack.js?1729025234"></script>
<script src="../../js/clipboard.min.js?1729027415"></script>
<script src="../../js/perfect-scrollbar.min.js?1729027415"></script>
<script src="../../js/perfect-scrollbar.jquery.min.js?1729027415"></script>
<script src="../../js/jquery.sticky.js?1729027415"></script>
<script src="../../js/featherlight.min.js?1729027415"></script>
<script src="../../js/highlight.pack.js?1729027415"></script>
<script>hljs.initHighlightingOnLoad();</script>
<script src="../../js/modernizr.custom-3.6.0.js?1729025234"></script>
<script src="../../js/learn.js?1729025234"></script>
<script src="../../js/hugo-learn.js?1729025234"></script>
<script src="../../js/modernizr.custom-3.6.0.js?1729027415"></script>
<script src="../../js/learn.js?1729027415"></script>
<script src="../../js/hugo-learn.js?1729027415"></script>


<script src="../../mermaid/mermaid.js?1729025234"></script>
<script src="../../mermaid/mermaid.js?1729027415"></script>

<script>
mermaid.initialize({ startOnLoad: true });
Expand Down
Loading

0 comments on commit 2a8dd9f

Please sign in to comment.