Template:Software Install: Difference between revisions

From OLPC
Jump to navigation Jump to search
(initial draft software install template to reduce ambiguity and create a central point for software installs)
 
No edit summary
 
(27 intermediate revisions by 5 users not shown)
Line 1: Line 1:
<noinclude>This page is generic installation instructions activated by template transclusion, and looking at the page like this (and not in Edit) won't help you understand it. The parameters expected are:
<noinclude>This page is generic installation instructions activated by template transclusion, and looking at the page like this (and not in Edit) won't help you understand it. The parameters expected are:


*model: {{{model|MODEL (XO-1 or XO-1.5)}}}
*model: {{{model|MODEL (XO-1 or XO-1.5, case is significant)}}}
*build: {{{build|BUILD (which build, e.g. os206)}}}
*build: {{{build|BUILD (which build, e.g. os206)}}}
*signed: {{{signed|SIGNED (yes or no)}}}
*signed: {{{signed|SIGNED (yes or no)}}}
*version: {{{version|VERSION (which release version this build is intended for, e.g. 10.1.2)}}}
*release: {{{release|RELEASE (which release version this build is intended for, e.g. 10.1.2)}}}
*path: {{{path|PATH (the path via HTTP to the directory that contains the build file)}}}
*path: {{{path|PATH (the path via HTTP to the directory that contains the build file)}}}
</noinclude>
</noinclude>


How to install
How to install build {{{build|BUILD}}} of version {{{version|VERSION}}} on {{{model|MODEL}}}.
{{ #switch: {{{signed}}} | yes = signed | no = unsigned }}
build
{{{build|BUILD}}}
of release
{{{release|RELEASE}}}
on
{{{model|MODEL}}}.


The build is installed to the internal
The build is installed to the internal
Line 16: Line 23:
| #default = storage
| #default = storage
}}
}}
device. You will need a USB memory stick of at least 1Gb capacity, but only for the duration of the installation.
device. You will need a [[USB drive]] of at least 1 GB capacity, but only for the duration of the installation.


'''ALL USER DATA WILL BE ERASED FROM THE LAPTOP!'''
'''ALL USER DATA WILL BE ERASED FROM THE LAPTOP!'''


*Prepare the USB memory stick:
*Prepare the USB drive:
**Download [{{{path}}}/{{{build}}}.{{ #switch: {{{model}}} | XO-1 = img | XO-1.5 = zd}} {{{build}}}.{{ #switch: {{{model}}} | XO-1 = img | XO-1.5 = zd}}],
**Download [{{{path}}}/{{{build}}}.{{ #switch: {{{model}}} | XO-1 = img | XO-1.5 = zd}} {{{build}}}.{{ #switch: {{{model}}} | XO-1 = img | XO-1.5 = zd}}],
**Save the file to the top directory of a USB memory stick, {{ #ifeq: {{{signed}}} | yes |
**Save the file to the top directory of the USB drive, {{ #ifeq: {{{signed}}} | yes |
**Download [{{{path}}}/fs.zip fs.zip],
**Download [{{{path}}}/{{{build}}}.{{ #switch: {{{model}}} | XO-1 = img.fs.zip | XO-1.5 = zsp.fs.zip}} {{{build}}}.{{ #switch: {{{model}}} | XO-1 = img.fs.zip | XO-1.5 = zsp.fs.zip}}],
**Save the file to the top directory of the same USB drive,
**Rename the file to fs.zip, (removing the {{{build}}}.{{ #switch: {{{model}}} | XO-1 = img | XO-1.5 = zsp}} part of the name),
**Check the USB drive contains at least the two files fs.zip and {{{build}}}.{{ #switch: {{{model}}} | XO-1 = img | XO-1.5 = zd}}. | {{ #ifeq: {{{model}}} | XO-1 |
**Download [{{{path}}}/{{{build}}}.crc {{{build}}}.crc],
**Save the file to the top directory of a USB memory stick,
**Save the file to the top directory of a USB memory stick,
**Check the USB memory stick contains at least the two files fs.zip and {{{build}}}.{{ #switch: {{{model}}} | XO-1 = img | XO-1.5 = zd}}.}}
**Check the USB drive contains at least the two files {{{build}}}.img and {{{build}}}.crc
}}
}}


*Prepare the laptop:
*Prepare the laptop:
**Make a copy of any data you wish to keep, {{ #ifeq: {{{signed}}} | no |
**Make a copy of any data you wish to keep, {{ #ifeq: {{{signed}}} | no |
**Obtain a [[Developer key]] and disable security, }}
**Obtain a [[Developer key]] and disable security, }}
**Ensure the battery is in the laptop,
**Check the battery is inserted and locked,
**Check that the power cord is in place and the battery indicator is green,
**Connect the laptop to external power,
**[[Shutdown|Turn off]] the laptop, unless it is already off.
**[[Shutdown|Turn off]] the laptop, unless it is already off,
**Insert the USB memory stick into any USB port on the laptop,
**Insert the USB drive into any USB port on the laptop,


*Start installing:
*Start installing:
Line 44: Line 57:
**Obtain the [[Ok]] prompt,
**Obtain the [[Ok]] prompt,
**Type the command:
**Type the command:
{{ #switch: {{{model}}} | XO-1 = copy-nand u:{{{build}}}.img | XO-1.5 = fs-update u:\{{{build}}}.zd | #default = ERROR}}
{{ #switch: {{{model}}}
| xo-1 =
copy-nand u:{{{build}}}.img
| xo-1.5 =
fs-update u:{{{build}}}.zd
}}
}}
}}


Installation progress will be displayed. Green colour will fill grey blocks. It will take about
Installation progress will be displayed. Green colour will fill
{{ #switch: {{{model}}} | XO-1 = yellow | XO-1.5 = grey }}
blocks. It will take about
{{ #switch: {{{model}}} | XO-1 = five | XO-1.5 = ten }}
{{ #switch: {{{model}}} | XO-1 = five | XO-1.5 = ten }}
minutes. Once finished, the laptop
minutes. Once finished,
{{ #switch: {{{signed}}}
{{ #switch: {{{signed}}}
| yes = will reboot automatically.
| yes = the laptop will reboot automatically. Remove the USB drive during or after the reboot.
| no = must be rebooted using ''bye'' or the power button, not with the ''boot'' command.}}
| no = the Ok prompt will return. Remove the USB drive. The laptop {{ #switch: {{{model}}} | XO-1 = may be rebooted. | XO-1.5 = must be rebooted using ''bye'' or the power button, not with the ''boot'' command.}}
}}
Remove the USB memory stick during or after the reboot. The USB memory stick can be used on other laptops.
The USB drive can be used on other laptops.


{{ #switch: {{{signed}}}
{{ #switch: {{{signed}}} | yes =
| yes =
If you see a message ''Boot failed'' then either:
If you see a message ''Boot failed'' then either:
*the USB memory stick has not been properly prepared, or;
*the USB drive has not been properly prepared, or;
*the firmware is out of date and should be updated (see [[Firmware]]).
*the firmware is out of date and should be updated (see [[Firmware]]).}}
}}

Latest revision as of 21:28, 26 January 2011

This page is generic installation instructions activated by template transclusion, and looking at the page like this (and not in Edit) won't help you understand it. The parameters expected are:

  • model: MODEL (XO-1 or XO-1.5, case is significant)
  • build: BUILD (which build, e.g. os206)
  • signed: SIGNED (yes or no)
  • release: RELEASE (which release version this build is intended for, e.g. 10.1.2)
  • path: PATH (the path via HTTP to the directory that contains the build file)


How to install

build BUILD of release RELEASE on MODEL.

The build is installed to the internal storage device. You will need a USB drive of at least 1 GB capacity, but only for the duration of the installation.

ALL USER DATA WILL BE ERASED FROM THE LAPTOP!

  • Prepare the USB drive:
    • Download [{{{path}}}/{{{build}}}. {{{build}}}.],
    • Save the file to the top directory of the USB drive,
  • Prepare the laptop:
    • Make a copy of any data you wish to keep,
    • Check the battery is inserted and locked,
    • Check that the power cord is in place and the battery indicator is green,
    • Turn off the laptop, unless it is already off,
    • Insert the USB drive into any USB port on the laptop,
  • Start installing:


Installation progress will be displayed. Green colour will fill

blocks. It will take about

minutes. Once finished,

The USB drive can be used on other laptops.