Skip to content

Commit b9b888b

Browse files
author
Deploy from CI
committed
Deploy 671610d to deployment
0 parents  commit b9b888b

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

54 files changed

+8262
-0
lines changed

‎.github/workflows/deploy.yml

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
name: Deploy
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
8+
jobs:
9+
deploy:
10+
name: Deploy
11+
runs-on: ubuntu-latest
12+
steps:
13+
- uses: actions/checkout@v3
14+
with:
15+
fetch-depth: 0
16+
- name: Install mdbook
17+
run: |
18+
mkdir mdbook
19+
curl -sSL https://github.com/rust-lang/mdBook/releases/download/v0.4.14/mdbook-v0.4.14-x86_64-unknown-linux-gnu.tar.gz | tar -xz --directory=./mdbook
20+
echo `pwd`/mdbook >> $GITHUB_PATH
21+
- name: Deploy GitHub Pages
22+
run: |
23+
# This assumes your book is in the root of your repository.
24+
# Just add a `cd` here if you need to change to another directory.
25+
mdbook build
26+
git worktree add deployment
27+
git config user.name "Deploy from CI"
28+
git config user.email ""
29+
cd deployment
30+
# Delete the ref to avoid keeping history.
31+
git update-ref -d refs/heads/deployment
32+
rm -rf *
33+
mv ../book/* .
34+
echo "docs.nomic.io" >> CNAME
35+
git add .
36+
git commit -m "Deploy $GITHUB_SHA to deployment"
37+
git push --force --set-upstream origin deployment

‎.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
book

‎00-00-setup.html

Lines changed: 218 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,218 @@
1+
<!DOCTYPE HTML>
2+
<html lang="en" class="sidebar-visible no-js light">
3+
<head>
4+
<!-- Book generated using mdBook -->
5+
<meta charset="UTF-8">
6+
<title>Setup - The Nomic Network</title>
7+
<!-- Custom HTML head -->
8+
<meta content="text/html; charset=utf-8" http-equiv="Content-Type">
9+
<meta name="description" content="">
10+
<meta name="viewport" content="width=device-width, initial-scale=1">
11+
<meta name="theme-color" content="#ffffff" />
12+
13+
<link rel="icon" href="favicon.svg">
14+
<link rel="shortcut icon" href="favicon.png">
15+
<link rel="stylesheet" href="css/variables.css">
16+
<link rel="stylesheet" href="css/general.css">
17+
<link rel="stylesheet" href="css/chrome.css">
18+
<link rel="stylesheet" href="css/print.css" media="print">
19+
<!-- Fonts -->
20+
<link rel="stylesheet" href="FontAwesome/css/font-awesome.css">
21+
<link rel="stylesheet" href="fonts/fonts.css">
22+
<!-- Highlight.js Stylesheets -->
23+
<link rel="stylesheet" href="highlight.css">
24+
<link rel="stylesheet" href="tomorrow-night.css">
25+
<link rel="stylesheet" href="ayu-highlight.css">
26+
27+
<!-- Custom theme stylesheets -->
28+
</head>
29+
<body>
30+
<!-- Provide site root to javascript -->
31+
<script type="text/javascript">
32+
var path_to_root = "";
33+
var default_theme = window.matchMedia("(prefers-color-scheme: dark)").matches ? "navy" : "light";
34+
</script>
35+
36+
<!-- Work around some values being stored in localStorage wrapped in quotes -->
37+
<script type="text/javascript">
38+
try {
39+
var theme = localStorage.getItem('mdbook-theme');
40+
var sidebar = localStorage.getItem('mdbook-sidebar');
41+
42+
if (theme.startsWith('"') && theme.endsWith('"')) {
43+
localStorage.setItem('mdbook-theme', theme.slice(1, theme.length - 1));
44+
}
45+
46+
if (sidebar.startsWith('"') && sidebar.endsWith('"')) {
47+
localStorage.setItem('mdbook-sidebar', sidebar.slice(1, sidebar.length - 1));
48+
}
49+
} catch (e) { }
50+
</script>
51+
52+
<!-- Set the theme before any content is loaded, prevents flash -->
53+
<script type="text/javascript">
54+
var theme;
55+
try { theme = localStorage.getItem('mdbook-theme'); } catch(e) { }
56+
if (theme === null || theme === undefined) { theme = default_theme; }
57+
var html = document.querySelector('html');
58+
html.classList.remove('no-js')
59+
html.classList.remove('light')
60+
html.classList.add(theme);
61+
html.classList.add('js');
62+
</script>
63+
64+
<!-- Hide / unhide sidebar before it is displayed -->
65+
<script type="text/javascript">
66+
var html = document.querySelector('html');
67+
var sidebar = 'hidden';
68+
if (document.body.clientWidth >= 1080) {
69+
try { sidebar = localStorage.getItem('mdbook-sidebar'); } catch(e) { }
70+
sidebar = sidebar || 'visible';
71+
}
72+
html.classList.remove('sidebar-visible');
73+
html.classList.add("sidebar-" + sidebar);
74+
</script>
75+
76+
<nav id="sidebar" class="sidebar" aria-label="Table of contents">
77+
<div class="sidebar-scrollbox">
78+
<ol class="chapter"><li class="chapter-item expanded "><a href="intro.html"><strong aria-hidden="true">1.</strong> Nomic</a></li><li class="chapter-item expanded "><a href="00-node.html"><strong aria-hidden="true">2.</strong> Running a Node</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="00-00-setup.html" class="active"><strong aria-hidden="true">2.1.</strong> Setup</a></li><li class="chapter-item expanded "><a href="00-01-upgrading.html"><strong aria-hidden="true">2.2.</strong> Upgrading</a></li><li class="chapter-item expanded "><a href="00-02-validating.html"><strong aria-hidden="true">2.3.</strong> Validating</a></li><li class="chapter-item expanded "><a href="00-03-bitcoin-relayer.html"><strong aria-hidden="true">2.4.</strong> Bitcoin Relayer</a></li><li class="chapter-item expanded "><a href="00-04-bitcoin-signer.html"><strong aria-hidden="true">2.5.</strong> Bitcoin Signer</a></li><li class="chapter-item expanded "><a href="00-05-ibc-relayer.html"><strong aria-hidden="true">2.6.</strong> IBC Relayer</a></li></ol></li></ol>
79+
</div>
80+
<div id="sidebar-resize-handle" class="sidebar-resize-handle"></div>
81+
</nav>
82+
83+
<div id="page-wrapper" class="page-wrapper">
84+
85+
<div class="page">
86+
<div id="menu-bar-hover-placeholder"></div>
87+
<div id="menu-bar" class="menu-bar sticky bordered">
88+
<div class="left-buttons">
89+
<button id="sidebar-toggle" class="icon-button" type="button" title="Toggle Table of Contents" aria-label="Toggle Table of Contents" aria-controls="sidebar">
90+
<i class="fa fa-bars"></i>
91+
</button>
92+
<button id="theme-toggle" class="icon-button" type="button" title="Change theme" aria-label="Change theme" aria-haspopup="true" aria-expanded="false" aria-controls="theme-list">
93+
<i class="fa fa-paint-brush"></i>
94+
</button>
95+
<ul id="theme-list" class="theme-popup" aria-label="Themes" role="menu">
96+
<li role="none"><button role="menuitem" class="theme" id="light">Light (default)</button></li>
97+
<li role="none"><button role="menuitem" class="theme" id="rust">Rust</button></li>
98+
<li role="none"><button role="menuitem" class="theme" id="coal">Coal</button></li>
99+
<li role="none"><button role="menuitem" class="theme" id="navy">Navy</button></li>
100+
<li role="none"><button role="menuitem" class="theme" id="ayu">Ayu</button></li>
101+
</ul>
102+
<button id="search-toggle" class="icon-button" type="button" title="Search. (Shortkey: s)" aria-label="Toggle Searchbar" aria-expanded="false" aria-keyshortcuts="S" aria-controls="searchbar">
103+
<i class="fa fa-search"></i>
104+
</button>
105+
</div>
106+
107+
<h1 class="menu-title">The Nomic Network</h1>
108+
109+
<div class="right-buttons">
110+
<a href="print.html" title="Print this book" aria-label="Print this book">
111+
<i id="print-button" class="fa fa-print"></i>
112+
</a>
113+
</div>
114+
</div>
115+
116+
<div id="search-wrapper" class="hidden">
117+
<form id="searchbar-outer" class="searchbar-outer">
118+
<input type="search" id="searchbar" name="searchbar" placeholder="Search this book ..." aria-controls="searchresults-outer" aria-describedby="searchresults-header">
119+
</form>
120+
<div id="searchresults-outer" class="searchresults-outer hidden">
121+
<div id="searchresults-header" class="searchresults-header"></div>
122+
<ul id="searchresults">
123+
</ul>
124+
</div>
125+
</div>
126+
<!-- Apply ARIA attributes after the sidebar and the sidebar toggle button are added to the DOM -->
127+
<script type="text/javascript">
128+
document.getElementById('sidebar-toggle').setAttribute('aria-expanded', sidebar === 'visible');
129+
document.getElementById('sidebar').setAttribute('aria-hidden', sidebar !== 'visible');
130+
Array.from(document.querySelectorAll('#sidebar a')).forEach(function(link) {
131+
link.setAttribute('tabIndex', sidebar === 'visible' ? 0 : -1);
132+
});
133+
</script>
134+
135+
<div id="content" class="content">
136+
<main>
137+
<h1 id="setup"><a class="header" href="#setup">Setup</a></h1>
138+
<p>These instructions will help you set up a new Nomic Stakenet node from scratch. If you are already running an older Nomic node, follow the <a href="00-01-upgrading.html">upgrade instructions</a> instead.</p>
139+
<h3 id="requirements"><a class="header" href="#requirements">Requirements</a></h3>
140+
<ul>
141+
<li>&gt;= 4GB RAM</li>
142+
<li>&gt;= 100GB of storage</li>
143+
<li>Linux or macOS</li>
144+
</ul>
145+
<h3 id="1-build-nomic"><a class="header" href="#1-build-nomic">1. Build Nomic</a></h3>
146+
<p>Start by building Nomic.</p>
147+
<ol>
148+
<li>Install rustup if you haven't already:</li>
149+
</ol>
150+
<pre><code class="language-bash">curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
151+
</code></pre>
152+
<ol start="2">
153+
<li>Install required dependencies:</li>
154+
</ol>
155+
<p><strong>Ubuntu/Debian:</strong></p>
156+
<pre><code class="language-bash">sudo apt install build-essential libssl-dev pkg-config clang
157+
</code></pre>
158+
<p><strong>Fedora:</strong></p>
159+
<pre><code class="language-bash">sudo dnf install clang openssl-devel &amp;&amp; sudo dnf group install &quot;C Development Tools and Libraries&quot;
160+
</code></pre>
161+
<ol start="3">
162+
<li>Clone the repo and switch to the correct directory and branch:</li>
163+
</ol>
164+
<pre><code class="language-bash">git clone https://github.com/nomic-io/nomic.git
165+
cd nomic
166+
git checkout main
167+
</code></pre>
168+
<ol start="4">
169+
<li>Build and install. This adds a <code>nomic</code> command to your PATH:</li>
170+
</ol>
171+
<pre><code class="language-bash">cargo install --locked --path .
172+
nomic --version
173+
</code></pre>
174+
<h3 id="2-run-your-node"><a class="header" href="#2-run-your-node">2. Run your node</a></h3>
175+
<p>Start your Nomic node:</p>
176+
<pre><code class="language-bash">nomic start
177+
</code></pre>
178+
<p>This will run the Nomic state machine and a Tendermint process. For new nodes, the state-sync process will run automatically to get the node up to speed with the current chain.</p>
179+
180+
</main>
181+
182+
<nav class="nav-wrapper" aria-label="Page navigation">
183+
<!-- Mobile navigation buttons -->
184+
<a rel="prev" href="00-node.html" class="mobile-nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
185+
<i class="fa fa-angle-left"></i>
186+
</a>
187+
<a rel="next" href="00-01-upgrading.html" class="mobile-nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
188+
<i class="fa fa-angle-right"></i>
189+
</a>
190+
<div style="clear: both"></div>
191+
</nav>
192+
</div>
193+
</div>
194+
195+
<nav class="nav-wide-wrapper" aria-label="Page navigation">
196+
<a rel="prev" href="00-node.html" class="nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
197+
<i class="fa fa-angle-left"></i>
198+
</a>
199+
<a rel="next" href="00-01-upgrading.html" class="nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
200+
<i class="fa fa-angle-right"></i>
201+
</a>
202+
</nav>
203+
204+
</div>
205+
206+
<script type="text/javascript">
207+
window.playground_copyable = true;
208+
</script>
209+
<script src="elasticlunr.min.js" type="text/javascript" charset="utf-8"></script>
210+
<script src="mark.min.js" type="text/javascript" charset="utf-8"></script>
211+
<script src="searcher.js" type="text/javascript" charset="utf-8"></script>
212+
<script src="clipboard.min.js" type="text/javascript" charset="utf-8"></script>
213+
<script src="highlight.js" type="text/javascript" charset="utf-8"></script>
214+
<script src="book.js" type="text/javascript" charset="utf-8"></script>
215+
216+
<!-- Custom JS scripts -->
217+
</body>
218+
</html>

0 commit comments

Comments
 (0)