This repository was archived by the owner on Jun 4, 2019. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathgettingStarted.html
220 lines (210 loc) · 15 KB
/
gettingStarted.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
<!DOCTYPE html>
<!--[if IE 8]> <html lang="en" class="ie8"> <![endif]-->
<!--[if IE 9]> <html lang="en" class="ie9"> <![endif]-->
<!--[if !IE]><!--> <html lang="en"> <!--<![endif]-->
<head>
<title>OpenRAP | Getting Started</title>
<!-- Meta -->
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="description" content="">
<meta name="author" content="">
<link href="https://fonts.googleapis.com/css?family=Pacifico" rel="stylesheet">
<link href='http://fonts.googleapis.com/css?family=Open+Sans:300italic,400italic,600italic,700italic,800italic,400,300,600,700,800' rel='stylesheet' type='text/css'>
<!-- Global CSS -->
<link rel="stylesheet" href="assets/plugins/bootstrap/css/bootstrap.min.css">
<!-- Plugins CSS -->
<link rel="stylesheet" href="assets/plugins/font-awesome/css/font-awesome.css">
<link rel="stylesheet" href="assets/plugins/prism/prism.css">
<link rel="stylesheet" href="assets/plugins/elegant_font/css/style.css">
<!-- Theme CSS -->
<link id="theme-style" rel="stylesheet" href="assets/css/styles.css">
<!-- HTML5 shim and Respond.js IE8 support of HTML5 elements and media queries -->
<!--[if lt IE 9]>
<script src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js"></script>
<script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
<![endif]-->
</head>
<body class="body-green">
<div class="page-wrapper">
<!-- ******Header****** -->
<header id="header" class="header">
<div class="container">
<div class="branding">
<h1 class="logo">
<a href="index.html">
<span style="font-family: 'Pacifico',cursive">OpenRAP</span>
</a>
</h1>
</div><!--//branding-->
<ol class="breadcrumb">
<li><a href="index.html">Home</a></li>
<li class="active">Getting Started</li>
</ol>
</div><!--//container-->
</header><!--//header-->
<div class="doc-wrapper">
<div class="container">
<div id="doc-header" class="doc-header text-center">
<h1 class="doc-title"><i class="icon fa fa-paper-plane"></i>Getting Started</h1>
<div class="meta"><i class="fa fa-clock-o"></i> Last updated: February 16, 2018</div>
</div><!--//doc-header-->
<div class="doc-body">
<div class="doc-content">
<div class="content-inner">
<section id="get-a-device-section" class="doc-section">
<h2 class="section-title">Get a Device</h2>
<div class="section-block">
<p>OpenRAP has been tested on these devices:<br />
<ul>
<li><a href='https://www.raspberrypi.org/products/raspberry-pi-3-model-b/' target="_blank">Raspberry Pi 3 Model B</a>
</ul>Newer devices will be added as and when adequate testing confirms their compatibility with our product.
</p>
</div>
</section><!--//doc-section-->
<section id="installation-section" class="doc-section">
<h2 class="section-title">Install Base Image</h2>
<div class="section-block">
<h3 class="block-title">Steps to follow:</h3>
<ol>
<li>Download the zip file from <a href="https://drive.google.com/open?id=1iPRlTCKRfSKfe_3m6RTSU-qn7vIgEg3k">here</a>.</li>
<li>Extract the image from the zip file.</li>
<li>Burn the extracted base image into a microSD Card with a minimum capacity of 4GB.</li>
<li>Insert the SD Card into the device and boot it.</li>
<li>You should see a Hotspot published in 10 seconds with the name "OpenRAP"</li>
<li>Build the latest version of OpenRAP and upgrade your device by following the steps mentioned below.</li></ol>
<!--//row-->
</div><!--//section-block-->
</section>
<section id="building-section" class="doc-section">
<h2 class="section-title">Build the Latest Release</h2>
<div id="step1" class="section-block">
<p>The following steps let you build the latest version of OpenRAP to use in your box.</p>
<h3 class="block-title">Clone our Repository</h3>
<p>Clone the code from our repsoitory into your local machine.</p>
<div class="code-block">
<h6>Using SSH:</h6>
<p><code>git clone [email protected]:projectOpenRAP/OpenRAP.git</code></p>
<h6>Using HTTPS:</h6>
<p><code>git clone https://github.com/projectOpenRAP/OpenRAP.git</code></p>
</div><!--//code-block-->
</div><!--//section-block-->
<div id="step2" class="section-block">
<h3 class="block-title">Ensure you have the prerequisites</h3>
<p>Run the following commands:
<div class="code-block">
<p><code>node -v<br />npm -v <br />go version</code></p>
</div>
</p>
<p>The output should be the corresponding version numbers of NodeJS, NPM and GoLang installed. If you need to install them, please check out the <a href="https://nodejs.org/en/download/">NodeJS</a>, the <a href="https://docs.npmjs.com/getting-started/installing-node">NPM</a> and <a href="https://golang.org/dl/">GoLang</a> download and documentation pages.</p>
<br /><br />
<div class="callout-block callout-warning">
<div class="icon-holder">
<i class="fa fa-warning"></i>
</div><!--//icon-holder-->
<div class="content">
<h4 class="callout-title">Warning!</h4>
<p>This project uses NodeJS <b>v.8.9.4</b> and NPM <b>5.6.0</b>. Ensure that this is the <b>minimum</b> version in your machine as well. Using versions earlier than this can lead to unexpected behavior or even failure of execution.</p>
</div><!--//content-->
</div>
</div><!--//section-block-->
<div id="step3" class="section-block">
<h3 class="block-title">Install Packages</h3>
<p>Install the prerequisite packages by:</p>
<div class="code-block">
<p><code>cd OpenRAP/devmgmtV2<br />npm install<br />
cd ../devmgmtui <br />npm install</code></p>
</div>
</div>
<div id="step4" class="section-block">
<h3 class="block-title">Building the Image</h3>
<p>Run the script that builds the .tgz file by:</p>
<div class="code-block">
<p><code>cd .. && python buildimage.py</code></p>
<p>The python script also takes positional arguments that allow you to modify the output based on the board and platform you wish to use. These positional arguments are:
<ul>
<li><code>--board</code> Defines the board to be used</li>
<li><code>--platform</code> Defines the platform to be used</li>
<li><code>--profile</code> Defines a custom profile</li>
<li><code>--clean</code> Specifies the type of image to be cleaned</li>
</ul>
</p>
<p>The positional arguments can be accessed in the terminal with the <code> -h </code> argument.
</div>
</div>
<div id="step5" class="section-block">
<h3 class="block-title">Verifying Image Creation</h3>
<p>The tgz file will be named as <code>openrap-<version-no>.tgz</code> and stored in the <code>build/</code> directory.</p>
</div>
</section><!--//doc-section-->
<section id="upgrade-section" class="doc-section">
<h2 class="section-title">Upgrade Base Image to Latest Version</h2>
<div class="section-block">
<p>
The following steps will allow you to upgrade your device to the latest version.
<ol>
<li>Connect to the hotspot and then to the device at <code>admin.openrap.com:8008</code></li>
<li>Use <code>root</code> for the username and password.<br /><br />
<div class="callout-block callout-danger">
<div class="icon-holder">
<i class="fa fa-warning"></i>
</div><!--//icon-holder-->
<div class="content">
<h4 class="callout-title">Alert!</h4>
<p>Make sure you modify your root password and [preferably] create another account with limited priveleges for regular use after setup.</p>
</div><!--//content-->
</div>
</li>
<li>Click on the upgrade button and select "local files"</li>
<li>Navigate to the built image and upload it</li>
<li>The upgrade will begin once the image is uploaded.</li>
<li>Once you get the notification of a successful upgrade, reboot the device.</li>
<li>The device is now in the latest version.</li>
</ol>
</p>
</div><!--//section-block-->
</section>
</div><!--//content-inner-->
</div><!--//doc-content-->
<div class="doc-sidebar hidden-xs">
<nav id="doc-nav">
<ul id="doc-menu" class="nav doc-menu" data-spy="affix">
<li><a class="scrollto" href="#get-a-device-section">Get a device</a></li>
<li>
<a class="scrollto" href="#installation-section">Install The Base Image</a>
</li>
<li><a class="scrollto" href="#building-section">Build the Latest Release</a>
<ul class="nav doc-sub-menu">
<li><a class="scrollto" href="#step1">Clone The Repo</a></li>
<li><a class="scrollto" href="#step2">Ensure Prerequisites</a></li>
<li><a class="scrollto" href="#step3">Install Packages</a></li>
<li><a class="scrollto" href="#step4">Build Image</a></li>
<li><a class="scrollto" href="#step5">Verify Image</a></li>
</ul><!--//nav-->
</li>
<li>
<a class="scrollto" href="#upgrade-section">Upgrade Base Image to <br />Latest Version</a>
</li>
</ul><!--//doc-menu-->
</nav>
</div><!--//doc-sidebar-->
</div><!--//doc-body-->
</div><!--//container-->
</div><!--//doc-wrapper-->
</div><!--//page-wrapper-->
<footer id="footer" class="footer text-center">
<div class="container">
<!--/* This template is released under the Creative Commons Attribution 3.0 License. Please keep the attribution link below when using for your own project. Thank you for your support. :) If you'd like to use the template without the attribution, you can check out other license options via our website: themes.3rdwavemedia.com */-->
<small class="copyright">OpenRAP. 2017. All Rights Reserved. Template taken from <a href="http://themes.3rdwavemedia.com/" target="_blank">here.</a></small>
</div><!--//container-->
</footer><!--//footer-->
<!-- Main Javascript -->
<script type="text/javascript" src="assets/plugins/jquery-1.12.3.min.js"></script>
<script type="text/javascript" src="assets/plugins/bootstrap/js/bootstrap.min.js"></script>
<script type="text/javascript" src="assets/plugins/prism/prism.js"></script>
<script type="text/javascript" src="assets/plugins/jquery-scrollTo/jquery.scrollTo.min.js"></script>
<script type="text/javascript" src="assets/plugins/jquery-match-height/jquery.matchHeight-min.js"></script>
<script type="text/javascript" src="assets/js/main.js"></script>
</body>
</html>