index.html 13.3 KB
Newer Older
Jonathan Carter's avatar
Jonathan Carter committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
<!DOCTYPE html>
  
  
  
  
   <html class="no-js"> 

  <head lang="en-us">
    <meta charset="utf-8">
    <meta name="viewport" content="width=device-width,user-scalable=no,initial-scale=1,maximum-scale=1">
    <meta http-equiv="X-UA-Compatible" content="IE=10" />
    <title>Getting started - AIMS Desktop</title>
    <meta name="generator" content="Hugo 0.18.1" />

    
    <link rel="canonical" href="https://desktop.aims.ac.za/getting-started/">
    

    <meta property="og:url" content="https://desktop.aims.ac.za/getting-started/">
    <meta property="og:title" content="AIMS Desktop">
Jonathan Carter's avatar
Jonathan Carter committed
21
    <meta property="og:image" content="https://desktop.aims.ac.za/images/logo.png">
Jonathan Carter's avatar
Jonathan Carter committed
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
    <meta name="apple-mobile-web-app-title" content="AIMS Desktop">
    <meta name="apple-mobile-web-app-capable" content="yes">
    <meta name="apple-mobile-web-app-status-bar-style" content="black-translucent">

    <link rel="shortcut icon" type="image/x-icon" href="https://desktop.aims.ac.za/images/favicon.ico">
    <link rel="icon" type="image/x-icon" href="https://desktop.aims.ac.za/images/favicon.ico">

    <style>
      @font-face {
        font-family: 'Icon';
        src: url('https://desktop.aims.ac.za/fonts/icon.eot');
        src: url('https://desktop.aims.ac.za/fonts/icon.eot')
               format('embedded-opentype'),
             url('https://desktop.aims.ac.za/fonts/icon.woff')
               format('woff'),
             url('https://desktop.aims.ac.za/fonts/icon.ttf')
               format('truetype'),
             url('https://desktop.aims.ac.za/fonts/icon.svg')
               format('svg');
        font-weight: normal;
        font-style: normal;
      }
    </style>

    <link rel="stylesheet" href="https://desktop.aims.ac.za/stylesheets/application.css">
    <link rel="stylesheet" href="https://desktop.aims.ac.za/stylesheets/temporary.css">
    <link rel="stylesheet" href="https://desktop.aims.ac.za/stylesheets/palettes.css">
    <link rel="stylesheet" href="https://desktop.aims.ac.za/stylesheets/highlight/highlight.css">

    
    
    
    <link rel="stylesheet" href="//fonts.googleapis.com/css?family=Ubuntu:400,700|Ubuntu&#43;Mono">
    <style>
      body, input {
        font-family: 'Ubuntu', Helvetica, Arial, sans-serif;
      }
      pre, code {
        font-family: 'Ubuntu Mono', 'Courier New', 'Courier', monospace;
      }
    </style>

    
    <script src="https://desktop.aims.ac.za/javascripts/modernizr.js"></script>

    

  </head>
Jonathan Carter's avatar
Jonathan Carter committed
70
  <body class="palette-primary-#fc0000 palette-accent-blue">
Jonathan Carter's avatar
Jonathan Carter committed
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92




<div class="backdrop">
	<div class="backdrop-paper"></div>
</div>

<input class="toggle" type="checkbox" id="toggle-drawer">
<input class="toggle" type="checkbox" id="toggle-search">
<label class="toggle-button overlay" for="toggle-drawer"></label>

<header class="header">
	<nav aria-label="Header">
  <div class="bar default">
    <div class="button button-menu" role="button" aria-label="Menu">
      <label class="toggle-button icon icon-menu" for="toggle-drawer">
        <span></span>
      </label>
    </div>
    <div class="stretch">
      <div class="title">
Jonathan Carter's avatar
Jonathan Carter committed
93
94
        
	<a href="https://desktop.aims.ac.za/"><img alt="AIMS Desktop" src="https://desktop.aims.ac.za/images/aims-desktop-heading.png" /></a>
Jonathan Carter's avatar
Jonathan Carter committed
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
      </div>
    </div>

    

    
    
        
  </div>
  <div class="bar search">
    <div class="button button-close" role="button" aria-label="Close">
      <label class="toggle-button icon icon-back" for="toggle-search"></label>
    </div>
    <div class="stretch">
      <div class="field">
        <input class="query" type="text" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck>
      </div>
    </div>
    <div class="button button-reset" role="button" aria-label="Search">
      <button class="toggle-button icon icon-close" id="reset-search"></button>
    </div>
  </div>
</nav>
Jonathan Carter's avatar
Jonathan Carter committed
118

Jonathan Carter's avatar
Jonathan Carter committed
119
120
121
122
123
</header>

<main class="main">
	<div class="drawer">
		<nav aria-label="Navigation">
Jonathan Carter's avatar
Jonathan Carter committed
124
  <a href="https://desktop.aims.ac.za/download" class="project">
Jonathan Carter's avatar
Jonathan Carter committed
125
126
    <div class="banner">
      
Jonathan Carter's avatar
Jonathan Carter committed
127
128
129
130
        <div class="logo">
          <img src="https://desktop.aims.ac.za/images/logo.png">
        </div>
      
Jonathan Carter's avatar
Jonathan Carter committed
131
      <div class="name">
Jonathan Carter's avatar
Jonathan Carter committed
132
        <strong>AIMS Desktop <span class="version">2017.1</span></strong>
Jonathan Carter's avatar
Jonathan Carter committed
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
        
      </div>
    </div>
  </a>

  <div class="scrollable">
    <div class="wrapper">
      

      <div class="toc">
        
        <ul>
          




<li>
  
    



Jonathan Carter's avatar
Jonathan Carter committed
156
<a  title="AIMS Desktop" href="https://desktop.aims.ac.za/">
Jonathan Carter's avatar
Jonathan Carter committed
157
	
Jonathan Carter's avatar
Jonathan Carter committed
158
	AIMS Desktop
Jonathan Carter's avatar
Jonathan Carter committed
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
</a>



  
</li>



<li>
  
    



<a class="current" title="Getting started" href="https://desktop.aims.ac.za/getting-started/">
	
	Getting started
</a>


<ul id="scrollspy">
</ul>


  
</li>



<li>
  
    



<a  title="Roadmap" href="https://desktop.aims.ac.za/roadmap/">
	
	Roadmap
</a>



  
</li>



<li>
  
    



<a  title="License" href="https://desktop.aims.ac.za/license/">
	
	License
</a>



  
Jonathan Carter's avatar
Jonathan Carter committed
221
</li>
Jonathan Carter's avatar
Jonathan Carter committed
222
223
224
225


        </ul>
        
Jonathan Carter's avatar
Jonathan Carter committed
226
227

        
Jonathan Carter's avatar
Jonathan Carter committed
228
229
230
231
232
233
234
235
236
237
238
239
240
      </div>
    </div>
  </div>
</nav>

	</div>

	<article class="article">
		<div class="wrapper">
			<h1>Getting started </h1>

			

Jonathan Carter's avatar
Jonathan Carter committed
241
242
<h2 id="download-aims-desktop">Download AIMS Desktop</h2>

Jonathan Carter's avatar
Jonathan Carter committed
243
244
245
246
247
<p>AIMS Desktop can be downloaded from <a href="https://desktop.aims.ac.za/download">https://desktop.aims.ac.za/download</a>.</p>

<p>AIMS Desktop is a large download (over 3GB), if you&rsquo;re reading this from a mobile connection,
you might want to download it on a broadband connection instead.</p>

Jonathan Carter's avatar
Jonathan Carter committed
248
<h2 id="preperation">Preperation</h2>
Jonathan Carter's avatar
Jonathan Carter committed
249

Jonathan Carter's avatar
Jonathan Carter committed
250
251
252
253
254
<p>AIMS Desktop installs a new operating system to your computer. It can be installed alongside
an existing system such as Microsoft Windows, Apple macOS, BSD or another GNU/Linux system.</p>

<p>Installation Media:</p>

Jonathan Carter's avatar
Jonathan Carter committed
255
<p>You will need a USB disk that is at least 4GB large. Preparing it as an installation
Jonathan Carter's avatar
Jonathan Carter committed
256
disk for AIMS desktop will overwrite all the data that&rsquo;s on there, so if you have important files
Jonathan Carter's avatar
Jonathan Carter committed
257
258
259
260
261
262
263
264
on that USB disk, you should move it to a safer location before writing the installer to disk.</p>

<p>If you&rsquo;re familiar with the dd command, you can use that from your Linux or macOS system to write
the command directly to a raw USB device.</p>

<p>If you&rsquo;re using Windows and don&rsquo;t have access to a Linux device, you can download the Rufus USB
tool at <a href="https://rufus.akeo.ie/">https://rufus.akeo.ie/</a> which makes writing USB disks from Windows really easy and that
tool has been confirmed to work with AIMS Desktop media.</p>
Jonathan Carter's avatar
Jonathan Carter committed
265
266
267

<p>Prepare your system:</p>

Jonathan Carter's avatar
Jonathan Carter committed
268
269
270
271
272
273
274
275
276
277
278
279
<p>The AIMS installer will do most of the work, however, here are some tips:</p>

<ul>
<li><p><strong>Back up your system.</strong> Even though there is a very small risk of data loss, it&rsquo;s recommended
that you make a full backup of your system before installing. The installer in AIMS Desktop is
widely used and tested, but making a backup will also protect you against human error.</p></li>

<li><p><strong>Disable secure boot.</strong> AIMS Desktop doesn&rsquo;t yet support secure boot. If your laptop has this
enabled, you should disable it in the firmware before commencing installation. You will have
to consult the manual for your laptop or do an internet search for how to do this on your
machine.</p></li>
</ul>
Jonathan Carter's avatar
Jonathan Carter committed
280

Jonathan Carter's avatar
Jonathan Carter committed
281
<h2 id="installation">Installation</h2>
Jonathan Carter's avatar
Jonathan Carter committed
282

Jonathan Carter's avatar
Jonathan Carter committed
283
284
285
286
287
288
289
290
291
292
293
<p>For the most part, the installation of AIMS Desktop is very simple. It uses a graphical installation
tool called Calamares (<a href="https://calamares.io">https://calamares.io</a>) which guides you through the entire installation process.</p>

<p>One aspect to be mindful though, especially if you&rsquo;re dual-booting, is to be aware of the boot method
that your computer uses. Newer computers use UEFI, while older computers use BIOS/Legacy boot mode.</p>

<p>We&rsquo;ve made it really easy to identify which method your computer uses to boot up. When you start the
AIMS Desktop live USB disk, it will show you the boot method in brackets.</p>

<p><img src="https://desktop.aims.ac.za/images/getting-started/bootmodes.png" alt="Boot modes" />
<em>Booting in Legacy/BIOS mode to the left, booting UEFI mode to the right. The red underline has been added to these images for emphasis.</em></p>
Jonathan Carter's avatar
Jonathan Carter committed
294

Jonathan Carter's avatar
Jonathan Carter committed
295
296
297
298
299
300
301
<p>When you press enter on either boot mode, it will start loading the live environment, and you should
see a loading screen similar to the one below. Startup will take a few seconds to a few minuted depending
on what kind of computer you have.</p>

<p><img src="https://desktop.aims.ac.za/images/getting-started/bootsplash.jpg" alt="Boot splash screeh" />
<em>AIMS Desktop startup screen</em></p>

Jonathan Carter's avatar
Jonathan Carter committed
302
303
304
305
306
307
308
309
310
<p>When it has finished booted up, you will be presented with the AIMS Desktop Live environment. The
live environment can do a lot more than just install AIMS Desktop, you can also use it to test
whether hardware supports the system, try out the software on AIMS Desktop, or show it to a friend.</p>

<p><img src="https://desktop.aims.ac.za/images/getting-started/aims-live-desktop.jpg" alt="AIMS Live Desktop" />
<em>AIMS Live Desktop</em></p>

<p>The installer icon is the first one after the main menu button on the top left side, as highlighed below. Click on this button if you&rsquo;d like to proceed installing AIMS Desktop.</p>

Jonathan Carter's avatar
Jonathan Carter committed
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
<p><img src="https://desktop.aims.ac.za/images/getting-started/installer-icon.jpg" alt="Installer Button" />
<em>Installer button, as highlighted above</em></p>

<p>You will then be greeted by the installer. If you&rsquo;re unsure about some options like region,
keyboard layout, etc, then don&rsquo;t stress about, you can change it again after installation.</p>

<p><img src="https://desktop.aims.ac.za/images/getting-started/installer-welcome.jpg" alt="Installer welcome screen" />
<em>Installer welcome screen</em></p>

<p>Select the language that you would like to use during the installation, then click on next.</p>

<p>Then, choose your location and timezone. The city that designates your timezone might not
be the actualy city you&rsquo;re in, and is often the capital of your country.</p>

<p><img src="https://desktop.aims.ac.za/images/getting-started/installer-timezone.jpg" alt="Time zone settings" />
<em>Time zone settings</em></p>

<p>Next, we&rsquo;ll select a keyboard layout. Normall, you&rsquo;ll want to select a keyboard layout that closest
match your physical keyboard layout. In some cases, you might want a different layout to match
another computer you&rsquo;re using. The keyboard image in this screen will adapt so that you have a preview
of the option you have chosen, and you can also type test it in the typing space at the bottom.</p>

<p><img src="https://desktop.aims.ac.za/images/getting-started/installer-keyboard.jpg" alt="Keyboard selection" />]
<em>Keyboard settings</em></p>
Jonathan Carter's avatar
Jonathan Carter committed
335

Jonathan Carter's avatar
Jonathan Carter committed
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
<h2 id="configuration">Configuration</h2>

<h2 id="options">Options</h2>


			<aside class="copyright" role="note">
				
				Documentation built with
				<a href="https://www.gohugo.io" target="_blank">Hugo</a>
				using the
				<a href="http://github.com/digitalcraftsman/hugo-material-docs" target="_blank">Material</a> theme.
			</aside>

			<footer class="footer">
				

<nav class="pagination" aria-label="Footer">
  <div class="previous">
  
  </div>

  <div class="next">
  
Jonathan Carter's avatar
Jonathan Carter committed
359
      <a href="https://desktop.aims.ac.za/configuration/" title="Configuration Guide">
Jonathan Carter's avatar
Jonathan Carter committed
360
361
362
363
364
365
        <span class="direction">
          Next
        </span>
        <div class="page">
          <div class="stretch">
            <div class="title">
Jonathan Carter's avatar
Jonathan Carter committed
366
              Configuration Guide
Jonathan Carter's avatar
Jonathan Carter committed
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
            </div>
          </div>
          <div class="button button-next" role="button" aria-label="Next">
            <i class="icon icon-forward"></i>
          </div>
        </div>
      </a>
  
  </div>
</nav>





			</footer>
		</div>
	</article>

	<div class="results" role="status" aria-live="polite">
		<div class="scrollable">
			<div class="wrapper">
				<div class="meta"></div>
				<div class="list"></div>
			</div>
		</div>
	</div>
</main>

    <script>
    
Jonathan Carter's avatar
Jonathan Carter committed
398
399
      var base_url = '';
      var repo_id  = '';
Jonathan Carter's avatar
Jonathan Carter committed
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
    
    </script>

    <script src="https://desktop.aims.ac.za/javascripts/application.js"></script>
    

    <script>
      /* Add headers to scrollspy */
      var headers   = document.getElementsByTagName("h2");
      var scrollspy = document.getElementById('scrollspy');

      if(scrollspy) {
        if(headers.length > 0) {
          for(var i = 0; i < headers.length; i++) {
            var li = document.createElement("li");
            li.setAttribute("class", "anchor");

            var a  = document.createElement("a");
            a.setAttribute("href", "#" + headers[i].id);
            a.setAttribute("title", headers[i].innerHTML);
            a.innerHTML = headers[i].innerHTML;

            li.appendChild(a)
            scrollspy.appendChild(li);
          }
        } else {
          scrollspy.parentElement.removeChild(scrollspy)
        }


        /* Add permanent link next to the headers */
        var headers = document.querySelectorAll("h1, h2, h3, h4, h5, h6");

        for(var i = 0; i < headers.length; i++) {
            var a = document.createElement("a");
            a.setAttribute("class", "headerlink");
            a.setAttribute("href", "#" + headers[i].id);
            a.setAttribute("title", "Permanent link")
            a.innerHTML = "#";
            headers[i].appendChild(a);
        }
      }
    </script>

    

    <script src="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.8.0/highlight.min.js"></script>
    <script>hljs.initHighlightingOnLoad();</script>
  </body>
</html>