Document not found (404)
+This URL is invalid, sorry. Please use the navigation bar or search to continue.
+ +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/css/chrome.css b/css/chrome.css
new file mode 100644
index 0000000..83b7969
--- /dev/null
+++ b/css/chrome.css
@@ -0,0 +1,604 @@
+/* CSS for UI elements (a.k.a. chrome) */
+
+html {
+ scrollbar-color: var(--scrollbar) var(--bg);
+}
+#searchresults a,
+.content a:link,
+a:visited,
+a > .hljs {
+ color: var(--links);
+}
+
+/*
+ body-container is necessary because mobile browsers don't seem to like
+ overflow-x on the body tag when there is a tag.
+*/
+#body-container {
+ /*
+ This is used when the sidebar pushes the body content off the side of
+ the screen on small screens. Without it, dragging on mobile Safari
+ will want to reposition the viewport in a weird way.
+ */
+ overflow-x: clip;
+}
+
+/* Menu Bar */
+
+#menu-bar,
+#menu-bar-hover-placeholder {
+ z-index: 101;
+ margin: auto calc(0px - var(--page-padding));
+}
+#menu-bar {
+ position: relative;
+ display: flex;
+ flex-wrap: wrap;
+ background-color: var(--bg);
+ border-block-end-color: var(--bg);
+ border-block-end-width: 1px;
+ border-block-end-style: solid;
+}
+#menu-bar.sticky,
+.js #menu-bar-hover-placeholder:hover + #menu-bar,
+.js #menu-bar:hover,
+.js.sidebar-visible #menu-bar {
+ position: -webkit-sticky;
+ position: sticky;
+ top: 0 !important;
+}
+#menu-bar-hover-placeholder {
+ position: sticky;
+ position: -webkit-sticky;
+ top: 0;
+ height: var(--menu-bar-height);
+}
+#menu-bar.bordered {
+ border-block-end-color: var(--table-border-color);
+}
+#menu-bar i, #menu-bar .icon-button {
+ position: relative;
+ padding: 0 8px;
+ z-index: 10;
+ line-height: var(--menu-bar-height);
+ cursor: pointer;
+ transition: color 0.5s;
+}
+@media only screen and (max-width: 420px) {
+ #menu-bar i, #menu-bar .icon-button {
+ padding: 0 5px;
+ }
+}
+
+.icon-button {
+ border: none;
+ background: none;
+ padding: 0;
+ color: inherit;
+}
+.icon-button i {
+ margin: 0;
+}
+
+.right-buttons {
+ margin: 0 15px;
+}
+.right-buttons a {
+ text-decoration: none;
+}
+
+.left-buttons {
+ display: flex;
+ margin: 0 5px;
+}
+.no-js .left-buttons button {
+ display: none;
+}
+
+.menu-title {
+ display: inline-block;
+ font-weight: 200;
+ font-size: 2.4rem;
+ line-height: var(--menu-bar-height);
+ text-align: center;
+ margin: 0;
+ flex: 1;
+ white-space: nowrap;
+ overflow: hidden;
+ text-overflow: ellipsis;
+}
+.js .menu-title {
+ cursor: pointer;
+}
+
+.menu-bar,
+.menu-bar:visited,
+.nav-chapters,
+.nav-chapters:visited,
+.mobile-nav-chapters,
+.mobile-nav-chapters:visited,
+.menu-bar .icon-button,
+.menu-bar a i {
+ color: var(--icons);
+}
+
+.menu-bar i:hover,
+.menu-bar .icon-button:hover,
+.nav-chapters:hover,
+.mobile-nav-chapters i:hover {
+ color: var(--icons-hover);
+}
+
+/* Nav Icons */
+
+.nav-chapters {
+ font-size: 2.5em;
+ text-align: center;
+ text-decoration: none;
+
+ position: fixed;
+ top: 0;
+ bottom: 0;
+ margin: 0;
+ max-width: 150px;
+ min-width: 90px;
+
+ display: flex;
+ justify-content: center;
+ align-content: center;
+ flex-direction: column;
+
+ transition: color 0.5s, background-color 0.5s;
+}
+
+.nav-chapters:hover {
+ text-decoration: none;
+ background-color: var(--theme-hover);
+ transition: background-color 0.15s, color 0.15s;
+}
+
+.nav-wrapper {
+ margin-block-start: 50px;
+ display: none;
+}
+
+.mobile-nav-chapters {
+ font-size: 2.5em;
+ text-align: center;
+ text-decoration: none;
+ width: 90px;
+ border-radius: 5px;
+ background-color: var(--sidebar-bg);
+}
+
+/* Only Firefox supports flow-relative values */
+.previous { float: left; }
+[dir=rtl] .previous { float: right; }
+
+/* Only Firefox supports flow-relative values */
+.next {
+ float: right;
+ right: var(--page-padding);
+}
+[dir=rtl] .next {
+ float: left;
+ right: unset;
+ left: var(--page-padding);
+}
+
+/* Use the correct buttons for RTL layouts*/
+[dir=rtl] .previous i.fa-angle-left:before {content:"\f105";}
+[dir=rtl] .next i.fa-angle-right:before { content:"\f104"; }
+
+@media only screen and (max-width: 1080px) {
+ .nav-wide-wrapper { display: none; }
+ .nav-wrapper { display: block; }
+}
+
+/* sidebar-visible */
+@media only screen and (max-width: 1380px) {
+ #sidebar-toggle-anchor:checked ~ .page-wrapper .nav-wide-wrapper { display: none; }
+ #sidebar-toggle-anchor:checked ~ .page-wrapper .nav-wrapper { display: block; }
+}
+
+/* Inline code */
+
+:not(pre) > .hljs {
+ display: inline;
+ padding: 0.1em 0.3em;
+ border-radius: 3px;
+}
+
+:not(pre):not(a) > .hljs {
+ color: var(--inline-code-color);
+ overflow-x: initial;
+}
+
+a:hover > .hljs {
+ text-decoration: underline;
+}
+
+pre {
+ position: relative;
+}
+pre > .buttons {
+ position: absolute;
+ z-index: 100;
+ right: 0px;
+ top: 2px;
+ margin: 0px;
+ padding: 2px 0px;
+
+ color: var(--sidebar-fg);
+ cursor: pointer;
+ visibility: hidden;
+ opacity: 0;
+ transition: visibility 0.1s linear, opacity 0.1s linear;
+}
+pre:hover > .buttons {
+ visibility: visible;
+ opacity: 1
+}
+pre > .buttons :hover {
+ color: var(--sidebar-active);
+ border-color: var(--icons-hover);
+ background-color: var(--theme-hover);
+}
+pre > .buttons i {
+ margin-inline-start: 8px;
+}
+pre > .buttons button {
+ cursor: inherit;
+ margin: 0px 5px;
+ padding: 3px 5px;
+ font-size: 14px;
+
+ border-style: solid;
+ border-width: 1px;
+ border-radius: 4px;
+ border-color: var(--icons);
+ background-color: var(--theme-popup-bg);
+ transition: 100ms;
+ transition-property: color,border-color,background-color;
+ color: var(--icons);
+}
+@media (pointer: coarse) {
+ pre > .buttons button {
+ /* On mobile, make it easier to tap buttons. */
+ padding: 0.3rem 1rem;
+ }
+
+ .sidebar-resize-indicator {
+ /* Hide resize indicator on devices with limited accuracy */
+ display: none;
+ }
+}
+pre > code {
+ display: block;
+ padding: 1rem;
+}
+
+/* FIXME: ACE editors overlap their buttons because ACE does absolute
+ positioning within the code block which breaks padding. The only solution I
+ can think of is to move the padding to the outer pre tag (or insert a div
+ wrapper), but that would require fixing a whole bunch of CSS rules.
+*/
+.hljs.ace_editor {
+ padding: 0rem 0rem;
+}
+
+pre > .result {
+ margin-block-start: 10px;
+}
+
+/* Search */
+
+#searchresults a {
+ text-decoration: none;
+}
+
+mark {
+ border-radius: 2px;
+ padding-block-start: 0;
+ padding-block-end: 1px;
+ padding-inline-start: 3px;
+ padding-inline-end: 3px;
+ margin-block-start: 0;
+ margin-block-end: -1px;
+ margin-inline-start: -3px;
+ margin-inline-end: -3px;
+ background-color: var(--search-mark-bg);
+ transition: background-color 300ms linear;
+ cursor: pointer;
+}
+
+mark.fade-out {
+ background-color: rgba(0,0,0,0) !important;
+ cursor: auto;
+}
+
+.searchbar-outer {
+ margin-inline-start: auto;
+ margin-inline-end: auto;
+ max-width: var(--content-max-width);
+}
+
+#searchbar {
+ width: 100%;
+ margin-block-start: 5px;
+ margin-block-end: 0;
+ margin-inline-start: auto;
+ margin-inline-end: auto;
+ padding: 10px 16px;
+ transition: box-shadow 300ms ease-in-out;
+ border: 1px solid var(--searchbar-border-color);
+ border-radius: 3px;
+ background-color: var(--searchbar-bg);
+ color: var(--searchbar-fg);
+}
+#searchbar:focus,
+#searchbar.active {
+ box-shadow: 0 0 3px var(--searchbar-shadow-color);
+}
+
+.searchresults-header {
+ font-weight: bold;
+ font-size: 1em;
+ padding-block-start: 18px;
+ padding-block-end: 0;
+ padding-inline-start: 5px;
+ padding-inline-end: 0;
+ color: var(--searchresults-header-fg);
+}
+
+.searchresults-outer {
+ margin-inline-start: auto;
+ margin-inline-end: auto;
+ max-width: var(--content-max-width);
+ border-block-end: 1px dashed var(--searchresults-border-color);
+}
+
+ul#searchresults {
+ list-style: none;
+ padding-inline-start: 20px;
+}
+ul#searchresults li {
+ margin: 10px 0px;
+ padding: 2px;
+ border-radius: 2px;
+}
+ul#searchresults li.focus {
+ background-color: var(--searchresults-li-bg);
+}
+ul#searchresults span.teaser {
+ display: block;
+ clear: both;
+ margin-block-start: 5px;
+ margin-block-end: 0;
+ margin-inline-start: 20px;
+ margin-inline-end: 0;
+ font-size: 0.8em;
+}
+ul#searchresults span.teaser em {
+ font-weight: bold;
+ font-style: normal;
+}
+
+/* Sidebar */
+
+.sidebar {
+ position: fixed;
+ left: 0;
+ top: 0;
+ bottom: 0;
+ width: var(--sidebar-width);
+ font-size: 0.875em;
+ box-sizing: border-box;
+ -webkit-overflow-scrolling: touch;
+ overscroll-behavior-y: contain;
+ background-color: var(--sidebar-bg);
+ color: var(--sidebar-fg);
+}
+[dir=rtl] .sidebar { left: unset; right: 0; }
+.sidebar-resizing {
+ -moz-user-select: none;
+ -webkit-user-select: none;
+ -ms-user-select: none;
+ user-select: none;
+}
+.no-js .sidebar,
+.js:not(.sidebar-resizing) .sidebar {
+ transition: transform 0.3s; /* Animation: slide away */
+}
+.sidebar code {
+ line-height: 2em;
+}
+.sidebar .sidebar-scrollbox {
+ overflow-y: auto;
+ position: absolute;
+ top: 0;
+ bottom: 0;
+ left: 0;
+ right: 0;
+ padding: 10px 10px;
+}
+.sidebar .sidebar-resize-handle {
+ position: absolute;
+ cursor: col-resize;
+ width: 0;
+ right: calc(var(--sidebar-resize-indicator-width) * -1);
+ top: 0;
+ bottom: 0;
+ display: flex;
+ align-items: center;
+}
+
+.sidebar-resize-handle .sidebar-resize-indicator {
+ width: 100%;
+ height: 12px;
+ background-color: var(--icons);
+ margin-inline-start: var(--sidebar-resize-indicator-space);
+}
+
+[dir=rtl] .sidebar .sidebar-resize-handle {
+ left: calc(var(--sidebar-resize-indicator-width) * -1);
+ right: unset;
+}
+.js .sidebar .sidebar-resize-handle {
+ cursor: col-resize;
+ width: calc(var(--sidebar-resize-indicator-width) - var(--sidebar-resize-indicator-space));
+}
+/* sidebar-hidden */
+#sidebar-toggle-anchor:not(:checked) ~ .sidebar {
+ transform: translateX(calc(0px - var(--sidebar-width) - var(--sidebar-resize-indicator-width)));
+ z-index: -1;
+}
+[dir=rtl] #sidebar-toggle-anchor:not(:checked) ~ .sidebar {
+ transform: translateX(calc(var(--sidebar-width) + var(--sidebar-resize-indicator-width)));
+}
+.sidebar::-webkit-scrollbar {
+ background: var(--sidebar-bg);
+}
+.sidebar::-webkit-scrollbar-thumb {
+ background: var(--scrollbar);
+}
+
+/* sidebar-visible */
+#sidebar-toggle-anchor:checked ~ .page-wrapper {
+ transform: translateX(calc(var(--sidebar-width) + var(--sidebar-resize-indicator-width)));
+}
+[dir=rtl] #sidebar-toggle-anchor:checked ~ .page-wrapper {
+ transform: translateX(calc(0px - var(--sidebar-width) - var(--sidebar-resize-indicator-width)));
+}
+@media only screen and (min-width: 620px) {
+ #sidebar-toggle-anchor:checked ~ .page-wrapper {
+ transform: none;
+ margin-inline-start: calc(var(--sidebar-width) + var(--sidebar-resize-indicator-width));
+ }
+ [dir=rtl] #sidebar-toggle-anchor:checked ~ .page-wrapper {
+ transform: none;
+ }
+}
+
+.chapter {
+ list-style: none outside none;
+ padding-inline-start: 0;
+ line-height: 2.2em;
+}
+
+.chapter ol {
+ width: 100%;
+}
+
+.chapter li {
+ display: flex;
+ color: var(--sidebar-non-existant);
+}
+.chapter li a {
+ display: block;
+ padding: 0;
+ text-decoration: none;
+ color: var(--sidebar-fg);
+}
+
+.chapter li a:hover {
+ color: var(--sidebar-active);
+}
+
+.chapter li a.active {
+ color: var(--sidebar-active);
+}
+
+.chapter li > a.toggle {
+ cursor: pointer;
+ display: block;
+ margin-inline-start: auto;
+ padding: 0 10px;
+ user-select: none;
+ opacity: 0.68;
+}
+
+.chapter li > a.toggle div {
+ transition: transform 0.5s;
+}
+
+/* collapse the section */
+.chapter li:not(.expanded) + li > ol {
+ display: none;
+}
+
+.chapter li.chapter-item {
+ line-height: 1.5em;
+ margin-block-start: 0.6em;
+}
+
+.chapter li.expanded > a.toggle div {
+ transform: rotate(90deg);
+}
+
+.spacer {
+ width: 100%;
+ height: 3px;
+ margin: 5px 0px;
+}
+.chapter .spacer {
+ background-color: var(--sidebar-spacer);
+}
+
+@media (-moz-touch-enabled: 1), (pointer: coarse) {
+ .chapter li a { padding: 5px 0; }
+ .spacer { margin: 10px 0; }
+}
+
+.section {
+ list-style: none outside none;
+ padding-inline-start: 20px;
+ line-height: 1.9em;
+}
+
+/* Theme Menu Popup */
+
+.theme-popup {
+ position: absolute;
+ left: 10px;
+ top: var(--menu-bar-height);
+ z-index: 1000;
+ border-radius: 4px;
+ font-size: 0.7em;
+ color: var(--fg);
+ background: var(--theme-popup-bg);
+ border: 1px solid var(--theme-popup-border);
+ margin: 0;
+ padding: 0;
+ list-style: none;
+ display: none;
+ /* Don't let the children's background extend past the rounded corners. */
+ overflow: hidden;
+}
+[dir=rtl] .theme-popup { left: unset; right: 10px; }
+.theme-popup .default {
+ color: var(--icons);
+}
+.theme-popup .theme {
+ width: 100%;
+ border: 0;
+ margin: 0;
+ padding: 2px 20px;
+ line-height: 25px;
+ white-space: nowrap;
+ text-align: start;
+ cursor: pointer;
+ color: inherit;
+ background: inherit;
+ font-size: inherit;
+}
+.theme-popup .theme:hover {
+ background-color: var(--theme-hover);
+}
+
+.theme-selected::before {
+ display: inline-block;
+ content: "✓";
+ margin-inline-start: -14px;
+ width: 14px;
+}
diff --git a/css/general.css b/css/general.css
new file mode 100644
index 0000000..7670b08
--- /dev/null
+++ b/css/general.css
@@ -0,0 +1,232 @@
+/* Base styles and content styles */
+
+:root {
+ /* Browser default font-size is 16px, this way 1 rem = 10px */
+ font-size: 62.5%;
+ color-scheme: var(--color-scheme);
+}
+
+html {
+ font-family: "Open Sans", sans-serif;
+ color: var(--fg);
+ background-color: var(--bg);
+ text-size-adjust: none;
+ -webkit-text-size-adjust: none;
+}
+
+body {
+ margin: 0;
+ font-size: 1.6rem;
+ overflow-x: hidden;
+}
+
+code {
+ font-family: var(--mono-font) !important;
+ font-size: var(--code-font-size);
+ direction: ltr !important;
+}
+
+/* make long words/inline code not x overflow */
+main {
+ overflow-wrap: break-word;
+}
+
+/* make wide tables scroll if they overflow */
+.table-wrapper {
+ overflow-x: auto;
+}
+
+/* Don't change font size in headers. */
+h1 code, h2 code, h3 code, h4 code, h5 code, h6 code {
+ font-size: unset;
+}
+
+.left { float: left; }
+.right { float: right; }
+.boring { opacity: 0.6; }
+.hide-boring .boring { display: none; }
+.hidden { display: none !important; }
+
+h2, h3 { margin-block-start: 2.5em; }
+h4, h5 { margin-block-start: 2em; }
+
+.header + .header h3,
+.header + .header h4,
+.header + .header h5 {
+ margin-block-start: 1em;
+}
+
+h1:target::before,
+h2:target::before,
+h3:target::before,
+h4:target::before,
+h5:target::before,
+h6:target::before {
+ display: inline-block;
+ content: "»";
+ margin-inline-start: -30px;
+ width: 30px;
+}
+
+/* This is broken on Safari as of version 14, but is fixed
+ in Safari Technology Preview 117 which I think will be Safari 14.2.
+ https://bugs.webkit.org/show_bug.cgi?id=218076
+*/
+:target {
+ /* Safari does not support logical properties */
+ scroll-margin-top: calc(var(--menu-bar-height) + 0.5em);
+}
+
+.page {
+ outline: 0;
+ padding: 0 var(--page-padding);
+ margin-block-start: calc(0px - var(--menu-bar-height)); /* Compensate for the #menu-bar-hover-placeholder */
+}
+.page-wrapper {
+ box-sizing: border-box;
+ background-color: var(--bg);
+}
+.no-js .page-wrapper,
+.js:not(.sidebar-resizing) .page-wrapper {
+ transition: margin-left 0.3s ease, transform 0.3s ease; /* Animation: slide away */
+}
+[dir=rtl] .js:not(.sidebar-resizing) .page-wrapper {
+ transition: margin-right 0.3s ease, transform 0.3s ease; /* Animation: slide away */
+}
+
+.content {
+ overflow-y: auto;
+ padding: 0 5px 50px 5px;
+}
+.content main {
+ margin-inline-start: auto;
+ margin-inline-end: auto;
+ max-width: var(--content-max-width);
+}
+.content p { line-height: 1.45em; }
+.content ol { line-height: 1.45em; }
+.content ul { line-height: 1.45em; }
+.content a { text-decoration: none; }
+.content a:hover { text-decoration: underline; }
+.content img, .content video { max-width: 100%; }
+.content .header:link,
+.content .header:visited {
+ color: var(--fg);
+}
+.content .header:link,
+.content .header:visited:hover {
+ text-decoration: none;
+}
+
+table {
+ margin: 0 auto;
+ border-collapse: collapse;
+}
+table td {
+ padding: 3px 20px;
+ border: 1px var(--table-border-color) solid;
+}
+table thead {
+ background: var(--table-header-bg);
+}
+table thead td {
+ font-weight: 700;
+ border: none;
+}
+table thead th {
+ padding: 3px 20px;
+}
+table thead tr {
+ border: 1px var(--table-header-bg) solid;
+}
+/* Alternate background colors for rows */
+table tbody tr:nth-child(2n) {
+ background: var(--table-alternate-bg);
+}
+
+
+blockquote {
+ margin: 20px 0;
+ padding: 0 20px;
+ color: var(--fg);
+ background-color: var(--quote-bg);
+ border-block-start: .1em solid var(--quote-border);
+ border-block-end: .1em solid var(--quote-border);
+}
+
+.warning {
+ margin: 20px;
+ padding: 0 20px;
+ border-inline-start: 2px solid var(--warning-border);
+}
+
+.warning:before {
+ position: absolute;
+ width: 3rem;
+ height: 3rem;
+ margin-inline-start: calc(-1.5rem - 21px);
+ content: "ⓘ";
+ text-align: center;
+ background-color: var(--bg);
+ color: var(--warning-border);
+ font-weight: bold;
+ font-size: 2rem;
+}
+
+blockquote .warning:before {
+ background-color: var(--quote-bg);
+}
+
+kbd {
+ background-color: var(--table-border-color);
+ border-radius: 4px;
+ border: solid 1px var(--theme-popup-border);
+ box-shadow: inset 0 -1px 0 var(--theme-hover);
+ display: inline-block;
+ font-size: var(--code-font-size);
+ font-family: var(--mono-font);
+ line-height: 10px;
+ padding: 4px 5px;
+ vertical-align: middle;
+}
+
+:not(.footnote-definition) + .footnote-definition,
+.footnote-definition + :not(.footnote-definition) {
+ margin-block-start: 2em;
+}
+.footnote-definition {
+ font-size: 0.9em;
+ margin: 0.5em 0;
+}
+.footnote-definition p {
+ display: inline;
+}
+
+.tooltiptext {
+ position: absolute;
+ visibility: hidden;
+ color: #fff;
+ background-color: #333;
+ transform: translateX(-50%); /* Center by moving tooltip 50% of its width left */
+ left: -8px; /* Half of the width of the icon */
+ top: -35px;
+ font-size: 0.8em;
+ text-align: center;
+ border-radius: 6px;
+ padding: 5px 8px;
+ margin: 5px;
+ z-index: 1000;
+}
+.tooltipped .tooltiptext {
+ visibility: visible;
+}
+
+.chapter li.part-title {
+ color: var(--sidebar-fg);
+ margin: 5px 0px;
+ font-weight: bold;
+}
+
+.result-no-output {
+ font-style: italic;
+}
diff --git a/css/print.css b/css/print.css
new file mode 100644
index 0000000..80ec3a5
--- /dev/null
+++ b/css/print.css
@@ -0,0 +1,50 @@
+
+#sidebar,
+#menu-bar,
+.nav-chapters,
+.mobile-nav-chapters {
+ display: none;
+}
+
+#page-wrapper.page-wrapper {
+ transform: none !important;
+ margin-inline-start: 0px;
+ overflow-y: initial;
+}
+
+#content {
+ max-width: none;
+ margin: 0;
+ padding: 0;
+}
+
+.page {
+ overflow-y: initial;
+}
+
+code {
+ direction: ltr !important;
+}
+
+pre > .buttons {
+ z-index: 2;
+}
+
+a, a:visited, a:active, a:hover {
+ color: #4183c4;
+ text-decoration: none;
+}
+
+h1, h2, h3, h4, h5, h6 {
+ page-break-inside: avoid;
+ page-break-after: avoid;
+}
+
+pre, code {
+ page-break-inside: avoid;
+ white-space: pre-wrap;
+}
+
+.fa {
+ display: none !important;
+}
diff --git a/css/variables.css b/css/variables.css
new file mode 100644
index 0000000..0da55e8
--- /dev/null
+++ b/css/variables.css
@@ -0,0 +1,279 @@
+
+/* Globals */
+
+:root {
+ --sidebar-width: 300px;
+ --sidebar-resize-indicator-width: 8px;
+ --sidebar-resize-indicator-space: 2px;
+ --page-padding: 15px;
+ --content-max-width: 750px;
+ --menu-bar-height: 50px;
+ --mono-font: "Source Code Pro", Consolas, "Ubuntu Mono", Menlo, "DejaVu Sans Mono", monospace, monospace;
+ --code-font-size: 0.875em /* please adjust the ace font size accordingly in editor.js */
+}
+
+/* Themes */
+
+.ayu {
+ --bg: hsl(210, 25%, 8%);
+ --fg: #c5c5c5;
+
+ --sidebar-bg: #14191f;
+ --sidebar-fg: #c8c9db;
+ --sidebar-non-existant: #5c6773;
+ --sidebar-active: #ffb454;
+ --sidebar-spacer: #2d334f;
+
+ --scrollbar: var(--sidebar-fg);
+
+ --icons: #737480;
+ --icons-hover: #b7b9cc;
+
+ --links: #0096cf;
+
+ --inline-code-color: #ffb454;
+
+ --theme-popup-bg: #14191f;
+ --theme-popup-border: #5c6773;
+ --theme-hover: #191f26;
+
+ --quote-bg: hsl(226, 15%, 17%);
+ --quote-border: hsl(226, 15%, 22%);
+
+ --warning-border: #ff8e00;
+
+ --table-border-color: hsl(210, 25%, 13%);
+ --table-header-bg: hsl(210, 25%, 28%);
+ --table-alternate-bg: hsl(210, 25%, 11%);
+
+ --searchbar-border-color: #848484;
+ --searchbar-bg: #424242;
+ --searchbar-fg: #fff;
+ --searchbar-shadow-color: #d4c89f;
+ --searchresults-header-fg: #666;
+ --searchresults-border-color: #888;
+ --searchresults-li-bg: #252932;
+ --search-mark-bg: #e3b171;
+
+ --color-scheme: dark;
+}
+
+.coal {
+ --bg: hsl(200, 7%, 8%);
+ --fg: #98a3ad;
+
+ --sidebar-bg: #292c2f;
+ --sidebar-fg: #a1adb8;
+ --sidebar-non-existant: #505254;
+ --sidebar-active: #3473ad;
+ --sidebar-spacer: #393939;
+
+ --scrollbar: var(--sidebar-fg);
+
+ --icons: #43484d;
+ --icons-hover: #b3c0cc;
+
+ --links: #2b79a2;
+
+ --inline-code-color: #c5c8c6;
+
+ --theme-popup-bg: #141617;
+ --theme-popup-border: #43484d;
+ --theme-hover: #1f2124;
+
+ --quote-bg: hsl(234, 21%, 18%);
+ --quote-border: hsl(234, 21%, 23%);
+
+ --warning-border: #ff8e00;
+
+ --table-border-color: hsl(200, 7%, 13%);
+ --table-header-bg: hsl(200, 7%, 28%);
+ --table-alternate-bg: hsl(200, 7%, 11%);
+
+ --searchbar-border-color: #aaa;
+ --searchbar-bg: #b7b7b7;
+ --searchbar-fg: #000;
+ --searchbar-shadow-color: #aaa;
+ --searchresults-header-fg: #666;
+ --searchresults-border-color: #98a3ad;
+ --searchresults-li-bg: #2b2b2f;
+ --search-mark-bg: #355c7d;
+
+ --color-scheme: dark;
+}
+
+.light {
+ --bg: hsl(0, 0%, 100%);
+ --fg: hsl(0, 0%, 0%);
+
+ --sidebar-bg: #fafafa;
+ --sidebar-fg: hsl(0, 0%, 0%);
+ --sidebar-non-existant: #aaaaaa;
+ --sidebar-active: #1f1fff;
+ --sidebar-spacer: #f4f4f4;
+
+ --scrollbar: #8F8F8F;
+
+ --icons: #747474;
+ --icons-hover: #000000;
+
+ --links: #20609f;
+
+ --inline-code-color: #301900;
+
+ --theme-popup-bg: #fafafa;
+ --theme-popup-border: #cccccc;
+ --theme-hover: #e6e6e6;
+
+ --quote-bg: hsl(197, 37%, 96%);
+ --quote-border: hsl(197, 37%, 91%);
+
+ --warning-border: #ff8e00;
+
+ --table-border-color: hsl(0, 0%, 95%);
+ --table-header-bg: hsl(0, 0%, 80%);
+ --table-alternate-bg: hsl(0, 0%, 97%);
+
+ --searchbar-border-color: #aaa;
+ --searchbar-bg: #fafafa;
+ --searchbar-fg: #000;
+ --searchbar-shadow-color: #aaa;
+ --searchresults-header-fg: #666;
+ --searchresults-border-color: #888;
+ --searchresults-li-bg: #e4f2fe;
+ --search-mark-bg: #a2cff5;
+
+ --color-scheme: light;
+}
+
+.navy {
+ --bg: hsl(226, 23%, 11%);
+ --fg: #bcbdd0;
+
+ --sidebar-bg: #282d3f;
+ --sidebar-fg: #c8c9db;
+ --sidebar-non-existant: #505274;
+ --sidebar-active: #2b79a2;
+ --sidebar-spacer: #2d334f;
+
+ --scrollbar: var(--sidebar-fg);
+
+ --icons: #737480;
+ --icons-hover: #b7b9cc;
+
+ --links: #2b79a2;
+
+ --inline-code-color: #c5c8c6;
+
+ --theme-popup-bg: #161923;
+ --theme-popup-border: #737480;
+ --theme-hover: #282e40;
+
+ --quote-bg: hsl(226, 15%, 17%);
+ --quote-border: hsl(226, 15%, 22%);
+
+ --warning-border: #ff8e00;
+
+ --table-border-color: hsl(226, 23%, 16%);
+ --table-header-bg: hsl(226, 23%, 31%);
+ --table-alternate-bg: hsl(226, 23%, 14%);
+
+ --searchbar-border-color: #aaa;
+ --searchbar-bg: #aeaec6;
+ --searchbar-fg: #000;
+ --searchbar-shadow-color: #aaa;
+ --searchresults-header-fg: #5f5f71;
+ --searchresults-border-color: #5c5c68;
+ --searchresults-li-bg: #242430;
+ --search-mark-bg: #a2cff5;
+
+ --color-scheme: dark;
+}
+
+.rust {
+ --bg: hsl(60, 9%, 87%);
+ --fg: #262625;
+
+ --sidebar-bg: #3b2e2a;
+ --sidebar-fg: #c8c9db;
+ --sidebar-non-existant: #505254;
+ --sidebar-active: #e69f67;
+ --sidebar-spacer: #45373a;
+
+ --scrollbar: var(--sidebar-fg);
+
+ --icons: #737480;
+ --icons-hover: #262625;
+
+ --links: #2b79a2;
+
+ --inline-code-color: #6e6b5e;
+
+ --theme-popup-bg: #e1e1db;
+ --theme-popup-border: #b38f6b;
+ --theme-hover: #99908a;
+
+ --quote-bg: hsl(60, 5%, 75%);
+ --quote-border: hsl(60, 5%, 70%);
+
+ --warning-border: #ff8e00;
+
+ --table-border-color: hsl(60, 9%, 82%);
+ --table-header-bg: #b3a497;
+ --table-alternate-bg: hsl(60, 9%, 84%);
+
+ --searchbar-border-color: #aaa;
+ --searchbar-bg: #fafafa;
+ --searchbar-fg: #000;
+ --searchbar-shadow-color: #aaa;
+ --searchresults-header-fg: #666;
+ --searchresults-border-color: #888;
+ --searchresults-li-bg: #dec2a2;
+ --search-mark-bg: #e69f67;
+
+ --color-scheme: light;
+}
+
+@media (prefers-color-scheme: dark) {
+ .light.no-js {
+ --bg: hsl(200, 7%, 8%);
+ --fg: #98a3ad;
+
+ --sidebar-bg: #292c2f;
+ --sidebar-fg: #a1adb8;
+ --sidebar-non-existant: #505254;
+ --sidebar-active: #3473ad;
+ --sidebar-spacer: #393939;
+
+ --scrollbar: var(--sidebar-fg);
+
+ --icons: #43484d;
+ --icons-hover: #b3c0cc;
+
+ --links: #2b79a2;
+
+ --inline-code-color: #c5c8c6;
+
+ --theme-popup-bg: #141617;
+ --theme-popup-border: #43484d;
+ --theme-hover: #1f2124;
+
+ --quote-bg: hsl(234, 21%, 18%);
+ --quote-border: hsl(234, 21%, 23%);
+
+ --warning-border: #ff8e00;
+
+ --table-border-color: hsl(200, 7%, 13%);
+ --table-header-bg: hsl(200, 7%, 28%);
+ --table-alternate-bg: hsl(200, 7%, 11%);
+
+ --searchbar-border-color: #aaa;
+ --searchbar-bg: #b7b7b7;
+ --searchbar-fg: #000;
+ --searchbar-shadow-color: #aaa;
+ --searchresults-header-fg: #666;
+ --searchresults-border-color: #98a3ad;
+ --searchresults-li-bg: #2b2b2f;
+ --search-mark-bg: #355c7d;
+ }
+}
diff --git a/dogenet.html b/dogenet.html
new file mode 100644
index 0000000..5ee1bf3
--- /dev/null
+++ b/dogenet.html
@@ -0,0 +1,228 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ E-Commerce - Sell stuff with Dogecoin
+ +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/dogenet_handler.html b/dogenet_handler.html
new file mode 100644
index 0000000..07fe33d
--- /dev/null
+++ b/dogenet_handler.html
@@ -0,0 +1,228 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Dogenet Node
+ +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/elasticlunr.min.js b/elasticlunr.min.js
new file mode 100644
index 0000000..94b20dd
--- /dev/null
+++ b/elasticlunr.min.js
@@ -0,0 +1,10 @@
+/**
+ * elasticlunr - http://weixsong.github.io
+ * Lightweight full-text search engine in Javascript for browser search and offline search. - 0.9.5
+ *
+ * Copyright (C) 2017 Oliver Nightingale
+ * Copyright (C) 2017 Wei Song
+ * MIT Licensed
+ * @license
+ */
+!function(){function e(e){if(null===e||"object"!=typeof e)return e;var t=e.constructor();for(var n in e)e.hasOwnProperty(n)&&(t[n]=e[n]);return t}var t=function(e){var n=new t.Index;return n.pipeline.add(t.trimmer,t.stopWordFilter,t.stemmer),e&&e.call(n,n),n};t.version="0.9.5",lunr=t,t.utils={},t.utils.warn=function(e){return function(t){e.console&&console.warn&&console.warn(t)}}(this),t.utils.toString=function(e){return void 0===e||null===e?"":e.toString()},t.EventEmitter=function(){this.events={}},t.EventEmitter.prototype.addListener=function(){var e=Array.prototype.slice.call(arguments),t=e.pop(),n=e;if("function"!=typeof t)throw new TypeError("last argument must be a function");n.forEach(function(e){this.hasHandler(e)||(this.events[e]=[]),this.events[e].push(t)},this)},t.EventEmitter.prototype.removeListener=function(e,t){if(this.hasHandler(e)){var n=this.events[e].indexOf(t);-1!==n&&(this.events[e].splice(n,1),0==this.events[e].length&&delete this.events[e])}},t.EventEmitter.prototype.emit=function(e){if(this.hasHandler(e)){var t=Array.prototype.slice.call(arguments,1);this.events[e].forEach(function(e){e.apply(void 0,t)},this)}},t.EventEmitter.prototype.hasHandler=function(e){return e in this.events},t.tokenizer=function(e){if(!arguments.length||null===e||void 0===e)return[];if(Array.isArray(e)){var n=e.filter(function(e){return null===e||void 0===e?!1:!0});n=n.map(function(e){return t.utils.toString(e).toLowerCase()});var i=[];return n.forEach(function(e){var n=e.split(t.tokenizer.seperator);i=i.concat(n)},this),i}return e.toString().trim().toLowerCase().split(t.tokenizer.seperator)},t.tokenizer.defaultSeperator=/[\s\-]+/,t.tokenizer.seperator=t.tokenizer.defaultSeperator,t.tokenizer.setSeperator=function(e){null!==e&&void 0!==e&&"object"==typeof e&&(t.tokenizer.seperator=e)},t.tokenizer.resetSeperator=function(){t.tokenizer.seperator=t.tokenizer.defaultSeperator},t.tokenizer.getSeperator=function(){return t.tokenizer.seperator},t.Pipeline=function(){this._queue=[]},t.Pipeline.registeredFunctions={},t.Pipeline.registerFunction=function(e,n){n in t.Pipeline.registeredFunctions&&t.utils.warn("Overwriting existing registered function: "+n),e.label=n,t.Pipeline.registeredFunctions[n]=e},t.Pipeline.getRegisteredFunction=function(e){return e in t.Pipeline.registeredFunctions!=!0?null:t.Pipeline.registeredFunctions[e]},t.Pipeline.warnIfFunctionNotRegistered=function(e){var n=e.label&&e.label in this.registeredFunctions;n||t.utils.warn("Function is not registered with pipeline. This may cause problems when serialising the index.\n",e)},t.Pipeline.load=function(e){var n=new t.Pipeline;return e.forEach(function(e){var i=t.Pipeline.getRegisteredFunction(e);if(!i)throw new Error("Cannot load un-registered function: "+e);n.add(i)}),n},t.Pipeline.prototype.add=function(){var e=Array.prototype.slice.call(arguments);e.forEach(function(e){t.Pipeline.warnIfFunctionNotRegistered(e),this._queue.push(e)},this)},t.Pipeline.prototype.after=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var i=this._queue.indexOf(e);if(-1===i)throw new Error("Cannot find existingFn");this._queue.splice(i+1,0,n)},t.Pipeline.prototype.before=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var i=this._queue.indexOf(e);if(-1===i)throw new Error("Cannot find existingFn");this._queue.splice(i,0,n)},t.Pipeline.prototype.remove=function(e){var t=this._queue.indexOf(e);-1!==t&&this._queue.splice(t,1)},t.Pipeline.prototype.run=function(e){for(var t=[],n=e.length,i=this._queue.length,o=0;n>o;o++){for(var r=e[o],s=0;i>s&&(r=this._queue[s](r,o,e),void 0!==r&&null!==r);s++);void 0!==r&&null!==r&&t.push(r)}return t},t.Pipeline.prototype.reset=function(){this._queue=[]},t.Pipeline.prototype.get=function(){return this._queue},t.Pipeline.prototype.toJSON=function(){return this._queue.map(function(e){return t.Pipeline.warnIfFunctionNotRegistered(e),e.label})},t.Index=function(){this._fields=[],this._ref="id",this.pipeline=new t.Pipeline,this.documentStore=new t.DocumentStore,this.index={},this.eventEmitter=new t.EventEmitter,this._idfCache={},this.on("add","remove","update",function(){this._idfCache={}}.bind(this))},t.Index.prototype.on=function(){var e=Array.prototype.slice.call(arguments);return this.eventEmitter.addListener.apply(this.eventEmitter,e)},t.Index.prototype.off=function(e,t){return this.eventEmitter.removeListener(e,t)},t.Index.load=function(e){e.version!==t.version&&t.utils.warn("version mismatch: current "+t.version+" importing "+e.version);var n=new this;n._fields=e.fields,n._ref=e.ref,n.documentStore=t.DocumentStore.load(e.documentStore),n.pipeline=t.Pipeline.load(e.pipeline),n.index={};for(var i in e.index)n.index[i]=t.InvertedIndex.load(e.index[i]);return n},t.Index.prototype.addField=function(e){return this._fields.push(e),this.index[e]=new t.InvertedIndex,this},t.Index.prototype.setRef=function(e){return this._ref=e,this},t.Index.prototype.saveDocument=function(e){return this.documentStore=new t.DocumentStore(e),this},t.Index.prototype.addDoc=function(e,n){if(e){var n=void 0===n?!0:n,i=e[this._ref];this.documentStore.addDoc(i,e),this._fields.forEach(function(n){var o=this.pipeline.run(t.tokenizer(e[n]));this.documentStore.addFieldLength(i,n,o.length);var r={};o.forEach(function(e){e in r?r[e]+=1:r[e]=1},this);for(var s in r){var u=r[s];u=Math.sqrt(u),this.index[n].addToken(s,{ref:i,tf:u})}},this),n&&this.eventEmitter.emit("add",e,this)}},t.Index.prototype.removeDocByRef=function(e){if(e&&this.documentStore.isDocStored()!==!1&&this.documentStore.hasDoc(e)){var t=this.documentStore.getDoc(e);this.removeDoc(t,!1)}},t.Index.prototype.removeDoc=function(e,n){if(e){var n=void 0===n?!0:n,i=e[this._ref];this.documentStore.hasDoc(i)&&(this.documentStore.removeDoc(i),this._fields.forEach(function(n){var o=this.pipeline.run(t.tokenizer(e[n]));o.forEach(function(e){this.index[n].removeToken(e,i)},this)},this),n&&this.eventEmitter.emit("remove",e,this))}},t.Index.prototype.updateDoc=function(e,t){var t=void 0===t?!0:t;this.removeDocByRef(e[this._ref],!1),this.addDoc(e,!1),t&&this.eventEmitter.emit("update",e,this)},t.Index.prototype.idf=function(e,t){var n="@"+t+"/"+e;if(Object.prototype.hasOwnProperty.call(this._idfCache,n))return this._idfCache[n];var i=this.index[t].getDocFreq(e),o=1+Math.log(this.documentStore.length/(i+1));return this._idfCache[n]=o,o},t.Index.prototype.getFields=function(){return this._fields.slice()},t.Index.prototype.search=function(e,n){if(!e)return[];e="string"==typeof e?{any:e}:JSON.parse(JSON.stringify(e));var i=null;null!=n&&(i=JSON.stringify(n));for(var o=new t.Configuration(i,this.getFields()).get(),r={},s=Object.keys(e),u=0;u
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Custom Protocol Handlers
+ +":e:f.tabReplace?e.replace(/\t/g,f.tabReplace):e):e}function E(e){let n=null;const t=function(e){var n=e.className+" ";n+=e.parentNode?e.parentNode.className:"";const t=f.languageDetectRe.exec(n);if(t){var r=T(t[1]);return r||(console.warn(g.replace("{}",t[1])),console.warn("Falling back to no-highlight mode for this block.",e)),r?t[1]:"no-highlight"}return n.split(/\s+/).find(e=>p(e)||T(e))}(e);if(p(t))return;S("before:highlightBlock",{block:e,language:t}),f.useBR?(n=document.createElement("div")).innerHTML=e.innerHTML.replace(/\n/g,"").replace(/
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/install.html b/install.html
new file mode 100644
index 0000000..80f025f
--- /dev/null
+++ b/install.html
@@ -0,0 +1,250 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 
What is the Dogebox project?
+Dogebox is a Linux server distribution and custom server software built +specifically to meet the needs of the Dogecoin community.
+The objective: to provide a decentralised platform for the development, +distribution and self-hosting of software (we call them PUPs) that will +bring real utility to the Dogecoin ecosystem and drive adoption.
+>>> Join the Dogebox Developer Discord for Help <<<
+What's in the box?
+Dogebox is a locked down custom configuration of NixOS Linux which includes +a number of Dogecoin specific services that combined deliver the Dogebox +UI, the DRE (Doge Runtime Environment), Pup management and secure interaction +between Pups.
+Dogeboxd - Pup management and runtime orchestration
+https://github.com/dogeorg/dogeboxd
+Dogebox runs a daemon process 'dogeboxd' which provides installation +and orchestration of Pups which are run in isolated containers via +Linux Systemd / Linux Namespaces.
+Dogeboxd manages inter-pup communications via nix-config rules, exposing +TCP ports between containers, and proxying REST APIs as required for Pups +to communicate with their dependencies, in accordance with their manifest rules.
+This is all done in aid of providing an easy to use platform for Dogecoin +users that can provide a secure runtime environment for Dogecoin adventurers +who are not Linux administrators.
+DPanel - Admin UI
+https://github.com/dogeorg/dpanel
+The Dogebox is managed via a convenient Web control panel that allows the +user to install new Pups from the community, determine how they can communicate +with eachother and the network, and then ensure they are running and monitored.
+DKM - Doge Key Manager
+https://github.com/dogeorg/dkm
+The DKM provides cryptographic authentication to the Dogebox and Dogecoin key +management for Pups in a manner that lets the user recover and control any +keys generated by pups, via the use of hierarchical deterministic keys.
+Each Pup installed is issued a 'delegated' child key from the Dogebox user's +master key. Pups can then use these keys to derive further child keys for use +as pay-to addresses or anything else such as providing full wallet functionality, +online shops, etc.
+DKM creates an encrypted master key and generates (derives) private-public +keypairs for pups and other parts of the DogeBox ecosystem.
+Keys are encrypted at rest with the DogeBox password and stored on disk.
+Passwords are first hashed using Argon2 memory-hard KDF (Argon2id variant) +with parameters time=3, memory=64M, threads=4 and the BLAKE2b hash function +as recommended in RFC 9106.
+The password-derived hash is then used to encrypt the master key with ChaCha20 +cypher and Poly1305 Authenticated Encryption (AE) scheme.
+Keys in DKM are only in memory while they are actively being used for Authentication +or key derivation.
+Dogenet - Multi-protocol gossip network
+https://github.com/dogeorg/dogenet
+DogeNet is a service that implements the Doge Gossip Protocol, which is a +multi-channel protocol for communicating among Dogenet nodes.
+It is a foundational piece for future experimental protocols (ComPoS / Sakura), +and provides useful side-channels for Dogecoin adjacent projects to communicate +without polluting the Dogecoin blockchain, where simple peer-to-peer +communication is sufficient.
+DogeNet builds a database of active DogeBox nodes, which is used to find peer +nodes to connect to. DogeNet maintains a connection to at least 6 peers at all +times (more if running novel protocol-handlers that require connecting to other +participating nodes.)
+DogeNet exposes a local UNIX-domain socket for custom Protocol Handlers to connect to +DogeNet and send/receive messages on any channels they're interested in.
+Channels are assigned to different protocols; for example, DogeNet nodes announce +their presence and public address on the ''Node' channel; DogeBoxes can optionally +announce an identity profile on the ''Iden' channel, for display on the DogeMap and +for use in future social pups.
+ +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/mark.min.js b/mark.min.js
new file mode 100644
index 0000000..1636231
--- /dev/null
+++ b/mark.min.js
@@ -0,0 +1,7 @@
+/*!***************************************************
+* mark.js v8.11.1
+* https://markjs.io/
+* Copyright (c) 2014–2018, Julian Kühnel
+* Released under the MIT license https://git.io/vwTVl
+*****************************************************/
+!function(e,t){"object"==typeof exports&&"undefined"!=typeof module?module.exports=t():"function"==typeof define&&define.amd?define(t):e.Mark=t()}(this,function(){"use strict";var e="function"==typeof Symbol&&"symbol"==typeof Symbol.iterator?function(e){return typeof e}:function(e){return e&&"function"==typeof Symbol&&e.constructor===Symbol&&e!==Symbol.prototype?"symbol":typeof e},t=function(e,t){if(!(e instanceof t))throw new TypeError("Cannot call a class as a function")},n=function(){function e(e,t){for(var n=0;n
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Installation
+Pre-installed hardware
+The Dogecoin Foundation offers pre-installed NanoPC-T6's +running Dogebox which are available for purchase at link comming soon.
+
DIY
+Dogebox is available as a bare-metal Linux install or as a +virtual machine image for a number of platforms. Dogebox +is also developed to run natively on the FriendlyElec NanoPC-T6 +and a number of other ARM SBCs.
+
DIY Installation options
+There are various options for installing Dogebox on your own +system, for direct help be sure to join the Developer Discord Server
+-
+
- Install directly on a FriendlyElec T6 ARM +
- Install directly on any x86 computer as the host OS +
- Install images for various Virtual Machines +
- How to build the above images from source +
Initial Setup
+On first-boot your Dogebox will enter Setup Mode
+TBD
+ +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/pup_dev_comms.html b/pup_dev_comms.html
new file mode 100644
index 0000000..58bc2e9
--- /dev/null
+++ b/pup_dev_comms.html
@@ -0,0 +1,228 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
What is the Dogebox project?
+Dogebox is a Linux server distribution and custom server software built +specifically to meet the needs of the Dogecoin community.
+The objective: to provide a decentralised platform for the development, +distribution and self-hosting of software (we call them PUPs) that will +bring real utility to the Dogecoin ecosystem and drive adoption.
+>>> Join the Dogebox Developer Discord for Help <<<
+What's in the box?
+Dogebox is a locked down custom configuration of NixOS Linux which includes +a number of Dogecoin specific services that combined deliver the Dogebox +UI, the DRE (Doge Runtime Environment), Pup management and secure interaction +between Pups.
+Dogeboxd - Pup management and runtime orchestration
+https://github.com/dogeorg/dogeboxd
+Dogebox runs a daemon process 'dogeboxd' which provides installation +and orchestration of Pups which are run in isolated containers via +Linux Systemd / Linux Namespaces.
+Dogeboxd manages inter-pup communications via nix-config rules, exposing +TCP ports between containers, and proxying REST APIs as required for Pups +to communicate with their dependencies, in accordance with their manifest rules.
+This is all done in aid of providing an easy to use platform for Dogecoin +users that can provide a secure runtime environment for Dogecoin adventurers +who are not Linux administrators.
+DPanel - Admin UI
+https://github.com/dogeorg/dpanel
+The Dogebox is managed via a convenient Web control panel that allows the +user to install new Pups from the community, determine how they can communicate +with eachother and the network, and then ensure they are running and monitored.
+DKM - Doge Key Manager
+https://github.com/dogeorg/dkm
+The DKM provides cryptographic authentication to the Dogebox and Dogecoin key +management for Pups in a manner that lets the user recover and control any +keys generated by pups, via the use of hierarchical deterministic keys.
+Each Pup installed is issued a 'delegated' child key from the Dogebox user's +master key. Pups can then use these keys to derive further child keys for use +as pay-to addresses or anything else such as providing full wallet functionality, +online shops, etc.
+DKM creates an encrypted master key and generates (derives) private-public +keypairs for pups and other parts of the DogeBox ecosystem.
+Keys are encrypted at rest with the DogeBox password and stored on disk.
+Passwords are first hashed using Argon2 memory-hard KDF (Argon2id variant) +with parameters time=3, memory=64M, threads=4 and the BLAKE2b hash function +as recommended in RFC 9106.
+The password-derived hash is then used to encrypt the master key with ChaCha20 +cypher and Poly1305 Authenticated Encryption (AE) scheme.
+Keys in DKM are only in memory while they are actively being used for Authentication +or key derivation.
+Dogenet - Multi-protocol gossip network
+https://github.com/dogeorg/dogenet
+DogeNet is a service that implements the Doge Gossip Protocol, which is a +multi-channel protocol for communicating among Dogenet nodes.
+It is a foundational piece for future experimental protocols (ComPoS / Sakura), +and provides useful side-channels for Dogecoin adjacent projects to communicate +without polluting the Dogecoin blockchain, where simple peer-to-peer +communication is sufficient.
+DogeNet builds a database of active DogeBox nodes, which is used to find peer +nodes to connect to. DogeNet maintains a connection to at least 6 peers at all +times (more if running novel protocol-handlers that require connecting to other +participating nodes.)
+DogeNet exposes a local UNIX-domain socket for custom Protocol Handlers to connect to +DogeNet and send/receive messages on any channels they're interested in.
+Channels are assigned to different protocols; for example, DogeNet nodes announce +their presence and public address on the ''Node' channel; DogeBoxes can optionally +announce an identity profile on the ''Iden' channel, for display on the DogeMap and +for use in future social pups.
+Installation
+Pre-installed hardware
+The Dogecoin Foundation offers pre-installed NanoPC-T6's +running Dogebox which are available for purchase at link comming soon.
+
DIY
+Dogebox is available as a bare-metal Linux install or as a +virtual machine image for a number of platforms. Dogebox +is also developed to run natively on the FriendlyElec NanoPC-T6 +and a number of other ARM SBCs.
+
DIY Installation options
+There are various options for installing Dogebox on your own +system, for direct help be sure to join the Developer Discord Server
+-
+
- Install directly on a FriendlyElec T6 ARM +
- Install directly on any x86 computer as the host OS +
- Install images for various Virtual Machines +
- How to build the above images from source +
Initial Setup
+On first-boot your Dogebox will enter Setup Mode
+TBD
+FriendlyElec T6 ARM
+x86
+Virtual Machines
+Download images
+Head over to https://github.com/dogeorg/dogebox/releases and download +the appropriate image for your VM platform.
+Steps to run on VirtualBox
+-
+
- Download Virtualbox, or another OVA compatible VM launcher. +
- Import the OVA image. +
- Configure your network to use bridged mode. +
- Launch the VM. This may take up to 10 minutes depending on your internet connection, to configure itself initially. +
- Login with username: shibe and password suchpass +
- Run ip addr to get the IP address of the VM +
- On your computer, visit http://ip:8080 to visit the setup experience. +
Building Dogebox
+Building images for Dogebox requires the Dogebox repository
+https://github.com/dogeorg/dogebox/
+For help building images be sure to join Developer Discord Server
+SD and SD installer images for the NanoPC-T6
+Start by building a disk image containing the root filesystem. Assuming you are in an environment containing nix-shell, from the root of this repository run
+nix-shell
+make nanopc-T6
+Take a note of the location of the built image.
+The SD images are built with a fork of FriendlyElec's sd-fuse_rk3588 for now. The following steps will be automated or replaced.
+SD
+Clone sd-fuse and create a directory for the components
+git clone https://github.com/dogeorg/sd-fuse_rk3588 https://github.com/dogeorg/sd-fuse_rk3588.git
+cd sd-fuse_rk3588
+mkdir nixos-arm64
+sd-fuse wants an android sparse image and we have a raw full-disk image. The following mount command mounts the partition inside the full disk image and build-rootfs-img.sh builds an android sparse image from the mounted directory and puts the result in nixos-arm64/rootfs.img
+If /mnt is in use, use another location for the temporary mount.
+mount -o loop,offset=$((2048 * 512)) <location of the image created in the first step> /mnt
+./build-rootfs-img.sh /mnt nixos-arm64
+umount /mnt
+You can use prebuilt artifacts from this point, but if you intend to build the u-boot bootoarder from source, clone it's repository. +If aarch64 cross compiling is not set up, the build script shoul fail with instructions containing what it's looking for.
+cd out
+git clone https://github.com/dogeorg/uboot-rockchip.git uboot-rk3588
+cd uboot-rk3588
+git checkout nanopi6-v2017.09
+cd ../../
+./build-uboot.sh nixos-arm64 nanopc-t6
+Add any remaining artifacts to the 'nixos-arm64' directory
+idbloader.img
+uboot.img
+misc.img
+dtbo.img
+resource.img
+kernel.img
+boot.img
+Run the image builing script
+./mk-sd-image.sh nixos-arm64
+This will output an image to out/<rk3588-sd-nixos-arm64-YYYYMMDD.img>
+u-boot's 'distro boot' expects to find an active partition, so we'll need to set that flag on the rootfs partition.
+fdisk <image>
+x
+A
+8
+r
+w
+Container/VM images
+Quick notes on building a container or VM image from a configuration.nix file:
+-
+
-
+
Make sure the configuration.nix doesn't mention a bootloader, an appropriate one is included automatically and one defined here can conflict.
+
+ -
+
Install
+nixos-generators, if you have the nix package manager or are running NixOS you can just run 'nix-shell -p nixos-generators'
+ -
+
Build the desired image with
+nixos-generate -c configuration.nix -f $format
+
Tested image formats include: docker, install-iso, iso, lxc, lxc-metadata, proxmox-lxc, qcow, vmware
-
+
- The build output should tell you the name and location of the built image. +
'docker' for docker/podman
+Use docker import or 'podman import' to generate a container image. You will need to manually specify a run CMD.
'install-iso / iso' for optical media images
+Generates a bootable iso, install-iso will give you an installer, iso will be a live CD.
'lxc / lxc-metadata, proxmox-lxc' for linux containers
+Use lxc and lxc-metadata for a manual container, or load the file generated by proxmox-lxc as a CT template to generate a container in proxmox.
'qcow' for qemu qcow2
+Can be used as a disk image for qemu.
+'vmware' for VMWare and VirtualBox
+Generates a VMDK file that can be used by VMware or VirtualBox VMs directly
+If you'd prefer a VDI, you can convert with VBoxManage clonehd --format VDI <from>.vmdk <to>.vdi
Generating a VDI out of the box with -f virtualbox doesn't appear to be working currently with the default config.
Installing PUPs
+Pups are the lifeblood of the Dogebox, these are packaged services +that the Dogebox runs inside an isolated container, they can depend +on other Pups such as Dogecoin Core or GigaWallet, and thus build up +a functional Dogecoin ecosystem that can provide online shopping, +tipping, new wallets or anything else that interacts with the Dogecoin +Blockchain.
+
Explore - The Pup Store
+Clicking the 'Explore' link in the nav will take you to the 'Pup Store' where all +available Pups can be found.
+++⚠️ Note: To start with you will only see a few Pups provided by +the Dogecoin Foundation supported 'Pup Source', such as Dogecoin Core, +Dogecoin GigaWallet, Dogenet and a few others. More Pups can be added to the store +by adding new 'Pup Sources' (see below).
+
Pup Sources - Where do pups come from?
+Dogebox is designed to let the community create and distribute Pups without +any centralised group controlling a 'store' (hint: like Google or Apple!).
+From the Pup Store you can 'manage sources', and paste in a URI to a different +Pup source form the internet. This will be scanned and any pups found will be +available in the Pup Store.
+++⚠️ Note: currently Sources are Git repositories that follow a particular +format, however we are working on other Source types such as decentralised +Radicle sources, http and others.
+
Pup Installation
+Clicking a pup from the Pup Store will let you install the Pup. Dogebox will +prepare an isolated 'container' for your Pup to run in, and assign any resources +that your Pup needs based on it's config.
+++⚠️ Note: This may take some time as Dogebox will download the source-code for the software +and compile it on your Dogebox. Dogecoin Core may take 10 minutes or more depending on your +hardware. Grab a cuppa and chill.
+
Pup Management Screen
+The pup management screen exists for every installed pup, and is the main +control panel for interacting with the software. From here you can monitor the +general Stats of the container, view any custom Mertrics or Logs, and launch +the Pup's own UI (if it provides one!)
+
Meeting Dependencies
+Some pups depend on other pups, they do this via 'Interfaces' and 'Providers'. A pup
+that requires an interface provider will let you know by entering the Unmet Dependencies
+state.
At this point you will need to install or select a pup that 'provides' the required +interface. Don't worry, there's a helpful dialog to get you through this step.
+
Enabling / Disabling Pups
+From the Pup management screen, you can use the 'Enabled' slider to enable or disable +a pup.
+++⚠️ Note: this may take a little time as Dogebox is managing interconnected services +related to this Pup, opening or closing firewall ports and updating it's internal +routes.
+
Reading Logs
+For the more technically minded, you can click the 'Logs' action under the Pup management +screen to see the output of the Pup in realtime.
+
Developing PUPs
+DRE (Dogecoin Runtime Environment)
+Pup Manifest
+pup.nix
+Pup Dependencies
+Pup to Pup Communication
+Pup Metrics
+Dogenet Node
+Custom Protocol Handlers
+E-Commerce - Sell stuff with Dogecoin
+ +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/pup_dev_deps.html b/pup_dev_deps.html
new file mode 100644
index 0000000..9a7fbf3
--- /dev/null
+++ b/pup_dev_deps.html
@@ -0,0 +1,228 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Pup to Pup Communication
+ +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/pup_dev_dre.html b/pup_dev_dre.html
new file mode 100644
index 0000000..2baa328
--- /dev/null
+++ b/pup_dev_dre.html
@@ -0,0 +1,228 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Pup Dependencies
+ +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/pup_dev_manifest.html b/pup_dev_manifest.html
new file mode 100644
index 0000000..87dcb1d
--- /dev/null
+++ b/pup_dev_manifest.html
@@ -0,0 +1,228 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ DRE (Dogecoin Runtime Environment)
+ +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/pup_dev_metrics.html b/pup_dev_metrics.html
new file mode 100644
index 0000000..58046c2
--- /dev/null
+++ b/pup_dev_metrics.html
@@ -0,0 +1,228 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Pup Manifest
+ +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/pup_dev_nix.html b/pup_dev_nix.html
new file mode 100644
index 0000000..5a0d928
--- /dev/null
+++ b/pup_dev_nix.html
@@ -0,0 +1,228 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Pup Metrics
+ +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/pup_development.html b/pup_development.html
new file mode 100644
index 0000000..25c979c
--- /dev/null
+++ b/pup_development.html
@@ -0,0 +1,228 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ pup.nix
+ +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/pup_install.html b/pup_install.html
new file mode 100644
index 0000000..3be784a
--- /dev/null
+++ b/pup_install.html
@@ -0,0 +1,293 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Developing PUPs
+ +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/searcher.js b/searcher.js
new file mode 100644
index 0000000..dc03e0a
--- /dev/null
+++ b/searcher.js
@@ -0,0 +1,483 @@
+"use strict";
+window.search = window.search || {};
+(function search(search) {
+ // Search functionality
+ //
+ // You can use !hasFocus() to prevent keyhandling in your key
+ // event handlers while the user is typing their search.
+
+ if (!Mark || !elasticlunr) {
+ return;
+ }
+
+ //IE 11 Compatibility from https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/startsWith
+ if (!String.prototype.startsWith) {
+ String.prototype.startsWith = function(search, pos) {
+ return this.substr(!pos || pos < 0 ? 0 : +pos, search.length) === search;
+ };
+ }
+
+ var search_wrap = document.getElementById('search-wrapper'),
+ searchbar = document.getElementById('searchbar'),
+ searchbar_outer = document.getElementById('searchbar-outer'),
+ searchresults = document.getElementById('searchresults'),
+ searchresults_outer = document.getElementById('searchresults-outer'),
+ searchresults_header = document.getElementById('searchresults-header'),
+ searchicon = document.getElementById('search-toggle'),
+ content = document.getElementById('content'),
+
+ searchindex = null,
+ doc_urls = [],
+ results_options = {
+ teaser_word_count: 30,
+ limit_results: 30,
+ },
+ search_options = {
+ bool: "AND",
+ expand: true,
+ fields: {
+ title: {boost: 1},
+ body: {boost: 1},
+ breadcrumbs: {boost: 0}
+ }
+ },
+ mark_exclude = [],
+ marker = new Mark(content),
+ current_searchterm = "",
+ URL_SEARCH_PARAM = 'search',
+ URL_MARK_PARAM = 'highlight',
+ teaser_count = 0,
+
+ SEARCH_HOTKEY_KEYCODE = 83,
+ ESCAPE_KEYCODE = 27,
+ DOWN_KEYCODE = 40,
+ UP_KEYCODE = 38,
+ SELECT_KEYCODE = 13;
+
+ function hasFocus() {
+ return searchbar === document.activeElement;
+ }
+
+ function removeChildren(elem) {
+ while (elem.firstChild) {
+ elem.removeChild(elem.firstChild);
+ }
+ }
+
+ // Helper to parse a url into its building blocks.
+ function parseURL(url) {
+ var a = document.createElement('a');
+ a.href = url;
+ return {
+ source: url,
+ protocol: a.protocol.replace(':',''),
+ host: a.hostname,
+ port: a.port,
+ params: (function(){
+ var ret = {};
+ var seg = a.search.replace(/^\?/,'').split('&');
+ var len = seg.length, i = 0, s;
+ for (;i
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Installing PUPs
+Pups are the lifeblood of the Dogebox, these are packaged services +that the Dogebox runs inside an isolated container, they can depend +on other Pups such as Dogecoin Core or GigaWallet, and thus build up +a functional Dogecoin ecosystem that can provide online shopping, +tipping, new wallets or anything else that interacts with the Dogecoin +Blockchain.
+
Explore - The Pup Store
+Clicking the 'Explore' link in the nav will take you to the 'Pup Store' where all +available Pups can be found.
+++⚠️ Note: To start with you will only see a few Pups provided by +the Dogecoin Foundation supported 'Pup Source', such as Dogecoin Core, +Dogecoin GigaWallet, Dogenet and a few others. More Pups can be added to the store +by adding new 'Pup Sources' (see below).
+
Pup Sources - Where do pups come from?
+Dogebox is designed to let the community create and distribute Pups without +any centralised group controlling a 'store' (hint: like Google or Apple!).
+From the Pup Store you can 'manage sources', and paste in a URI to a different +Pup source form the internet. This will be scanned and any pups found will be +available in the Pup Store.
+++⚠️ Note: currently Sources are Git repositories that follow a particular +format, however we are working on other Source types such as decentralised +Radicle sources, http and others.
+
Pup Installation
+Clicking a pup from the Pup Store will let you install the Pup. Dogebox will +prepare an isolated 'container' for your Pup to run in, and assign any resources +that your Pup needs based on it's config.
+++⚠️ Note: This may take some time as Dogebox will download the source-code for the software +and compile it on your Dogebox. Dogecoin Core may take 10 minutes or more depending on your +hardware. Grab a cuppa and chill.
+
Pup Management Screen
+The pup management screen exists for every installed pup, and is the main +control panel for interacting with the software. From here you can monitor the +general Stats of the container, view any custom Mertrics or Logs, and launch +the Pup's own UI (if it provides one!)
+
Meeting Dependencies
+Some pups depend on other pups, they do this via 'Interfaces' and 'Providers'. A pup
+that requires an interface provider will let you know by entering the Unmet Dependencies
+state.
At this point you will need to install or select a pup that 'provides' the required +interface. Don't worry, there's a helpful dialog to get you through this step.
+
Enabling / Disabling Pups
+From the Pup management screen, you can use the 'Enabled' slider to enable or disable +a pup.
+++⚠️ Note: this may take a little time as Dogebox is managing interconnected services +related to this Pup, opening or closing firewall ports and updating it's internal +routes.
+
Reading Logs
+For the more technically minded, you can click the 'Logs' action under the Pup management +screen to see the output of the Pup in realtime.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/tomorrow-night.css b/tomorrow-night.css
new file mode 100644
index 0000000..81fe276
--- /dev/null
+++ b/tomorrow-night.css
@@ -0,0 +1,102 @@
+/* Tomorrow Night Theme */
+/* https://github.com/jmblog/color-themes-for-highlightjs */
+/* Original theme - https://github.com/chriskempson/tomorrow-theme */
+/* https://github.com/jmblog/color-themes-for-highlightjs */
+
+/* Tomorrow Comment */
+.hljs-comment {
+ color: #969896;
+}
+
+/* Tomorrow Red */
+.hljs-variable,
+.hljs-attribute,
+.hljs-tag,
+.hljs-regexp,
+.ruby .hljs-constant,
+.xml .hljs-tag .hljs-title,
+.xml .hljs-pi,
+.xml .hljs-doctype,
+.html .hljs-doctype,
+.css .hljs-id,
+.css .hljs-class,
+.css .hljs-pseudo {
+ color: #cc6666;
+}
+
+/* Tomorrow Orange */
+.hljs-number,
+.hljs-preprocessor,
+.hljs-pragma,
+.hljs-built_in,
+.hljs-literal,
+.hljs-params,
+.hljs-constant {
+ color: #de935f;
+}
+
+/* Tomorrow Yellow */
+.ruby .hljs-class .hljs-title,
+.css .hljs-rule .hljs-attribute {
+ color: #f0c674;
+}
+
+/* Tomorrow Green */
+.hljs-string,
+.hljs-value,
+.hljs-inheritance,
+.hljs-header,
+.hljs-name,
+.ruby .hljs-symbol,
+.xml .hljs-cdata {
+ color: #b5bd68;
+}
+
+/* Tomorrow Aqua */
+.hljs-title,
+.css .hljs-hexcolor {
+ color: #8abeb7;
+}
+
+/* Tomorrow Blue */
+.hljs-function,
+.python .hljs-decorator,
+.python .hljs-title,
+.ruby .hljs-function .hljs-title,
+.ruby .hljs-title .hljs-keyword,
+.perl .hljs-sub,
+.javascript .hljs-title,
+.coffeescript .hljs-title {
+ color: #81a2be;
+}
+
+/* Tomorrow Purple */
+.hljs-keyword,
+.javascript .hljs-function {
+ color: #b294bb;
+}
+
+.hljs {
+ display: block;
+ overflow-x: auto;
+ background: #1d1f21;
+ color: #c5c8c6;
+}
+
+.coffeescript .javascript,
+.javascript .xml,
+.tex .hljs-formula,
+.xml .javascript,
+.xml .vbscript,
+.xml .css,
+.xml .hljs-cdata {
+ opacity: 0.5;
+}
+
+.hljs-addition {
+ color: #718c00;
+}
+
+.hljs-deletion {
+ color: #c82829;
+}
diff --git a/vms.html b/vms.html
new file mode 100644
index 0000000..2af69fb
--- /dev/null
+++ b/vms.html
@@ -0,0 +1,241 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Building Dogebox
+Building images for Dogebox requires the Dogebox repository
+https://github.com/dogeorg/dogebox/
+For help building images be sure to join Developer Discord Server
+SD and SD installer images for the NanoPC-T6
+Start by building a disk image containing the root filesystem. Assuming you are in an environment containing nix-shell, from the root of this repository run
+nix-shell
+make nanopc-T6
+Take a note of the location of the built image.
+The SD images are built with a fork of FriendlyElec's sd-fuse_rk3588 for now. The following steps will be automated or replaced.
+SD
+Clone sd-fuse and create a directory for the components
+git clone https://github.com/dogeorg/sd-fuse_rk3588 https://github.com/dogeorg/sd-fuse_rk3588.git
+cd sd-fuse_rk3588
+mkdir nixos-arm64
+sd-fuse wants an android sparse image and we have a raw full-disk image. The following mount command mounts the partition inside the full disk image and build-rootfs-img.sh builds an android sparse image from the mounted directory and puts the result in nixos-arm64/rootfs.img
+If /mnt is in use, use another location for the temporary mount.
+mount -o loop,offset=$((2048 * 512)) <location of the image created in the first step> /mnt
+./build-rootfs-img.sh /mnt nixos-arm64
+umount /mnt
+You can use prebuilt artifacts from this point, but if you intend to build the u-boot bootoarder from source, clone it's repository. +If aarch64 cross compiling is not set up, the build script shoul fail with instructions containing what it's looking for.
+cd out
+git clone https://github.com/dogeorg/uboot-rockchip.git uboot-rk3588
+cd uboot-rk3588
+git checkout nanopi6-v2017.09
+cd ../../
+./build-uboot.sh nixos-arm64 nanopc-t6
+Add any remaining artifacts to the 'nixos-arm64' directory
+idbloader.img
+uboot.img
+misc.img
+dtbo.img
+resource.img
+kernel.img
+boot.img
+Run the image builing script
+./mk-sd-image.sh nixos-arm64
+This will output an image to out/<rk3588-sd-nixos-arm64-YYYYMMDD.img>
+u-boot's 'distro boot' expects to find an active partition, so we'll need to set that flag on the rootfs partition.
+fdisk <image>
+x
+A
+8
+r
+w
+Container/VM images
+Quick notes on building a container or VM image from a configuration.nix file:
+-
+
-
+
Make sure the configuration.nix doesn't mention a bootloader, an appropriate one is included automatically and one defined here can conflict.
+
+ -
+
Install
+nixos-generators, if you have the nix package manager or are running NixOS you can just run 'nix-shell -p nixos-generators'
+ -
+
Build the desired image with
+nixos-generate -c configuration.nix -f $format
+
Tested image formats include: docker, install-iso, iso, lxc, lxc-metadata, proxmox-lxc, qcow, vmware
-
+
- The build output should tell you the name and location of the built image. +
'docker' for docker/podman
+Use docker import or 'podman import' to generate a container image. You will need to manually specify a run CMD.
'install-iso / iso' for optical media images
+Generates a bootable iso, install-iso will give you an installer, iso will be a live CD.
'lxc / lxc-metadata, proxmox-lxc' for linux containers
+Use lxc and lxc-metadata for a manual container, or load the file generated by proxmox-lxc as a CT template to generate a container in proxmox.
'qcow' for qemu qcow2
+Can be used as a disk image for qemu.
+'vmware' for VMWare and VirtualBox
+Generates a VMDK file that can be used by VMware or VirtualBox VMs directly
+If you'd prefer a VDI, you can convert with VBoxManage clonehd --format VDI <from>.vmdk <to>.vdi
Generating a VDI out of the box with -f virtualbox doesn't appear to be working currently with the default config.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/what.html b/what.html
new file mode 100644
index 0000000..f5a806f
--- /dev/null
+++ b/what.html
@@ -0,0 +1,287 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Virtual Machines
+Download images
+Head over to https://github.com/dogeorg/dogebox/releases and download +the appropriate image for your VM platform.
+Steps to run on VirtualBox
+-
+
- Download Virtualbox, or another OVA compatible VM launcher. +
- Import the OVA image. +
- Configure your network to use bridged mode. +
- Launch the VM. This may take up to 10 minutes depending on your internet connection, to configure itself initially. +
- Login with username: shibe and password suchpass +
- Run ip addr to get the IP address of the VM +
- On your computer, visit http://ip:8080 to visit the setup experience. +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/x86.html b/x86.html
new file mode 100644
index 0000000..befd4c0
--- /dev/null
+++ b/x86.html
@@ -0,0 +1,228 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
What is the Dogebox project?
+Dogebox is a Linux server distribution and custom server software built +specifically to meet the needs of the Dogecoin community.
+The objective: to provide a decentralised platform for the development, +distribution and self-hosting of software (we call them PUPs) that will +bring real utility to the Dogecoin ecosystem and drive adoption.
+>>> Join the Dogebox Developer Discord for Help <<<
+What's in the box?
+Dogebox is a locked down custom configuration of NixOS Linux which includes +a number of Dogecoin specific services that combined deliver the Dogebox +UI, the DRE (Doge Runtime Environment), Pup management and secure interaction +between Pups.
+Dogeboxd - Pup management and runtime orchestration
+https://github.com/dogeorg/dogeboxd
+Dogebox runs a daemon process 'dogeboxd' which provides installation +and orchestration of Pups which are run in isolated containers via +Linux Systemd / Linux Namespaces.
+Dogeboxd manages inter-pup communications via nix-config rules, exposing +TCP ports between containers, and proxying REST APIs as required for Pups +to communicate with their dependencies, in accordance with their manifest rules.
+This is all done in aid of providing an easy to use platform for Dogecoin +users that can provide a secure runtime environment for Dogecoin adventurers +who are not Linux administrators.
+DPanel - Admin UI
+https://github.com/dogeorg/dpanel
+The Dogebox is managed via a convenient Web control panel that allows the +user to install new Pups from the community, determine how they can communicate +with eachother and the network, and then ensure they are running and monitored.
+DKM - Doge Key Manager
+https://github.com/dogeorg/dkm
+The DKM provides cryptographic authentication to the Dogebox and Dogecoin key +management for Pups in a manner that lets the user recover and control any +keys generated by pups, via the use of hierarchical deterministic keys.
+Each Pup installed is issued a 'delegated' child key from the Dogebox user's +master key. Pups can then use these keys to derive further child keys for use +as pay-to addresses or anything else such as providing full wallet functionality, +online shops, etc.
+DKM creates an encrypted master key and generates (derives) private-public +keypairs for pups and other parts of the DogeBox ecosystem.
+Keys are encrypted at rest with the DogeBox password and stored on disk.
+Passwords are first hashed using Argon2 memory-hard KDF (Argon2id variant) +with parameters time=3, memory=64M, threads=4 and the BLAKE2b hash function +as recommended in RFC 9106.
+The password-derived hash is then used to encrypt the master key with ChaCha20 +cypher and Poly1305 Authenticated Encryption (AE) scheme.
+Keys in DKM are only in memory while they are actively being used for Authentication +or key derivation.
+Dogenet - Multi-protocol gossip network
+https://github.com/dogeorg/dogenet
+DogeNet is a service that implements the Doge Gossip Protocol, which is a +multi-channel protocol for communicating among Dogenet nodes.
+It is a foundational piece for future experimental protocols (ComPoS / Sakura), +and provides useful side-channels for Dogecoin adjacent projects to communicate +without polluting the Dogecoin blockchain, where simple peer-to-peer +communication is sufficient.
+DogeNet builds a database of active DogeBox nodes, which is used to find peer +nodes to connect to. DogeNet maintains a connection to at least 6 peers at all +times (more if running novel protocol-handlers that require connecting to other +participating nodes.)
+DogeNet exposes a local UNIX-domain socket for custom Protocol Handlers to connect to +DogeNet and send/receive messages on any channels they're interested in.
+Channels are assigned to different protocols; for example, DogeNet nodes announce +their presence and public address on the ''Node' channel; DogeBoxes can optionally +announce an identity profile on the ''Iden' channel, for display on the DogeMap and +for use in future social pups.
+ +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+