From Sugar Labs
Revision as of 12:53, 2 May 2019 by FGrose (talk | contribs) (bypass redirect on Supported Distributions)
Jump to navigation Jump to search
english | español | français | norsk HowTo [ID# 102829] 

File:Download-circle.png rect 58 6 109 51 MS Windows rect 146 28 195 85 GNU/Linux rect 146 128 200 181 OLPC XO rect 60 154 111 212 virtual machine rect 5 77 50 133 Apple Mac OS X rect 86 76 128 133 Are you new to Sugar? desc none </imagemap>

Are you new to Sugar?

The SoaS download is found here: Sugar on a Stick. Basic instructions are found below:

Sugar on a Stick installation instructions

MS Windows


Download Mirabell.png
USB flash drive.jpg
  1. Prepare: Download the Fedora Live USB Creator from FedoraHosted.

  2. Download the latest Sugar on a Stick .iso file.

  3. Load: Insert a USB flash drive (or SD Card) with 2 GB or more of free space into your computer and launch Fedora Live USB Creator to create a Sugar-on-a-Stick bootable image.
    Note: Be sure to set the persistent storage slider to a non-zero value.

  4. Boot: Insert the USB stick into a USB port on your computer. Set the option to "boot from USB" in your computer's BIOS setup, and then start up the computer.

Detailed installation instructions for Windows and booting instructions are available. There is also a guide to exploring Sugar.



Download Mirabell.png

USB flash drive.jpg

  1. Download the latest Sugar on a Stick .iso file.

  2. Prepare: (with root user permissions at a terminal or console command line)
    • Create a mount point directory: mkdir /run/soas
    • Mount the .iso file to make it accessible as a disk: mount /path/to/downloaded.iso /run/soas/
      (Where /path/to/downloaded.iso is the filesystem path, or fully specified name, of the downloaded .iso file.)
      This is the source for the installation, and must remain mounted until the installation is complete.
    • Insert a USB stick of 2 GB or greater capacity into your computer.
    • With root user permissions at a terminal or console command line, use the command sudo df -Th or sudo blkid to get the USB device node name.
    • (Items in angle brackets, such as <MyAccount> are descriptive placeholders.)
       You should see something like the following:
      [<user>@<system> <working directory>]$ sudo df -Th
      Filesystem     Type      Size  Used Avail Use% Mounted on
      devtmpfs       devtmpfs   16G     0   16G   0% /dev
      tmpfs          tmpfs      16G   33M   16G   1% /dev/shm
      tmpfs          tmpfs      16G  1.8M   16G   1% /run
      tmpfs          tmpfs      16G     0   16G   0% /sys/fs/cgroup
      /dev/sda1      ext4      123G   17G  100G  15% /
      tmpfs          tmpfs      16G   80K   16G   1% /tmp
      tmpfs          tmpfs     3.2G   10M  3.2G   1% /run/user/1000
      /dev/sdb1      vfat      233G   90G  143G  39% /run/media/<MyAccount>/<filesystem label>
      /dev/loop0     iso9660   942M  942M     0 100% /run/soas
      (The /run/media/<MyAccount>/ path is the standard mount point for removable media.
      /media/<MyMountPoint> is common on other operating systems.)
      [<user>@<system> <working directory>]$ sudo blkid
      /dev/sda1: LABEL="Fedora30" UUID="dddf4ae0-e1fd-43c3-bacc-91acbafb3a34" TYPE="ext4" PARTUUID="000b2340-03"
      /dev/sdb1: LABEL_FATBOOT="Fat" LABEL="Fat" UUID="D082-05E1" TYPE="vfat" PARTLABEL="Fat" PARTUUID="53132329-808c-4a44-adf6-e98ad17546ff"
      /dev/loop0: UUID="2019-04-26-02-18-05-00" LABEL="Fedora-SoaS-Live-30-1-2" TYPE="iso9660" PTUUID="37f2045d" PTTYPE="dos"
      (Additional disk drive partitions may be listed on your computer.)
      The mount point (Mounted on), Filesystem, Size, and LABEL should help you identify what you want.
    • Unmount the USB device filesystem:
      umount /run/media/<MyAccount>/<MyUSBdiscMountPoint>
      (The /run/media/<MyAccount>/ path is the standard mount point. Other operating systems may use /media/<MyMountPoint>.)
    • (You should have the isomd5sum package installed so that the following installation script can verify the download.)

  3. Load: Execute the following installation command, as the root user, in one command line with many options:
    /run/soas/LiveOS/livecd-iso-to-disk --reset-mbr --overlay-size-mb 500 --home-size-mb 500 --unencrypted-home /path/to/downloaded.iso /dev/sd?1
    The '?' in the final parameter represents the target USB device scsi drive node, such as sdb1 or sdc1, etc., and /path/to/downloaded.iso is the location and name of the .iso file.
    The operating system will occupy ~960 MB, and the overlay and home size arguments, 500 and 500, were selected to fit in a 2 GB device. These may be adjusted depending on your preferences and device capacity (see LiveOS image). On a 4 GB device, one might use 1000 and 1600 for the size arguments.
     The installation transcript should look something like the following:
    [<user>@<system> <working directory>]$ sudo /run/soas/LiveOS/livecd-iso-to-disk --reset-mbr --overlay-size-mb 500 --home-size-mb 500 --unencrypted-home /<path to>/Fedora-SoaS-Live-x86_64-30-1.2.iso /dev/sdc1
    Verifying image...
    /<path to>/Fedora-SoaS-Live-x86_64-30-1.2.iso:   bac65eaf45ad370f6e9ddf793f436e33
    Fragment sums: 82358a8de12fab19be3e83c22431837827fbe4b8be6d9be46695f853676f
    Fragment count: 20
    Supported ISO: no
    Press [Esc] to abort check.
    Checking: 100.0%
    The media check is complete, the result is: PASS.
    It is OK to use this media.
    Copying LiveOS image to target device...
        887,312,384 100%  379.28MB/s    0:00:02 (xfr#1, to-chk=0/1)
    Syncing filesystem writes to disc.
        Please wait, this may take a while...
    Setting up /EFI/BOOT
    Updating boot config files.
    Initializing persistent overlay...
    500+0 records in
    500+0 records out
    524288000 bytes (524 MB, 500 MiB) copied, 0.354372 s, 1.5 GB/s
    Initializing persistent /home
    500+0 records in
    500+0 records out
    524288000 bytes (524 MB, 500 MiB) copied, 0.346354 s, 1.5 GB/s
    Formatting unencrypted home.img
    mke2fs 1.44.6 (5-Mar-2019)
    Creating filesystem with 512000 1k blocks and 128016 inodes
    Filesystem UUID: b32a4987-627e-4131-a863-7f6c9bcc2178
    Superblock backups stored on blocks: 
    	8193, 24577, 40961, 57345, 73729, 204801, 221185, 401409
    Allocating group tables: done                            
    Writing inode tables: done                            
    Creating journal (8192 blocks): done
    Writing superblocks and filesystem accounting information: done 
    tune2fs 1.44.6 (5-Mar-2019)
    Setting maximal mount count to -1
    Setting interval between checks to 0 seconds
    Installing boot loader...
    Target device is now set up with a Live image!

  4. Boot: Insert the USB stick into a bootable USB port on your computer. Set the option to "boot from USB" in your computer's BIOS setup, and then start up the computer.

  • To create more Sugar Sticks on other 2 GB or greater USB or SD devices, while running Sugar on a Stick, one may run the Terminal Activity, and execute this command as the root user:
    livecd-iso-to-disk --reset-mbr --overlay-size-mb 500 --home-size-mb 500 --delete-home --unencrypted-home /run/initramfs/livedev /dev/sd?1
Replace /dev/sd?1 with a new device node for the second USB/SD device that you want to load with Sugar on a Stick.

Detailed installation instructions for GNU/Linux and booting instructions are available. There is also a guide to exploring Sugar. GNU/Linux users may also want to install the Sugar packages on their favorite distro, apart from Sugar on a Stick.

Apple Mac OS X


Download Mirabell.png

USB flash drive.jpg

The instructions below are based on the Ubuntu Web page at <>.

  1. Prepare: These instructions are for 32-bit and 64-bit processors.

  2. Download the latest Sugar on a Stick .iso file.

  3. Load:
    Here is a simple way to load a bootable USB on a Mac.
    1. Enter the Terminal: /Applications/Utilities/Terminal.
    2. Type diskutil list. You should see all the disk drives you have inserted into your computer.
    3. Insert the disk drive to which you want to write Sugar on a Stick.
    4. Type diskutil list again. You should see that your USB drive has been added to the list. If not, wait a while and repeat.
    5. Type hdiutil convert -format UDRW -o <Sugar on a Stick image file>.img <Sugar on a Stick image file> to convert the image into a bootable format.
    6. Type sudo diskutil unmountDisk <device name> to unmount the disk (it will not be ejected).
    7. Type sudo dd if=<Sugar on a Stick image file>.img.dmg of=<device name> bs=1m. sudo will ask for your password, and then dd will start writing the disk file.
    8. When dd finishes writing the disk file, type sudo diskutil eject <device name>.
  4. Boot: Insert the USB stick into a USB port on your computer, then reboot and press and hold the Option key while rebooting. You should see a list of all the EFI-recognizable USB drives that can be bootstrapped. If Sugar on a Stick is not one such drive, it cannot be bootstrapped: you need rEFInd (a fork of rEFIt).

  • Have a MacBook? Consider these options:
Usb1.png MacBook Persistent SoaS v5 USB EFI Boot
Bootable CD of Trisquel 4.5 for MacBook Air
See other installation variations at Sugar Creation Kit
Apple.gif Burning a CD from an .iso file on a Mac
  • Have an iBook or PowerPC Mac?
See Ubuntu/PPC and fedora:Architectures/PowerPC.

Alternative installation instructions for Mac OS X. Also, these older installation instructions and booting instructions may be consulted.
There is also a guide to exploring Sugar.

Advanced users

Do you have an OLPC XO?

  • Experiment with Updating XOs to the latest Sugar on a Stick release.

Some alternate installations

  • Once you download, and then burn or load a Sugar on a Stick (SoaS) .iso file, and boot it, the running Fedora 30 SoaS Live CD/USB may be used to install Fedora with Sugar to a hard disk or a 4 GB USB stick with the liveinst command.
- You start with a SoaS LiveOS image, and then load an uncompressed version onto the hard disk or USB stick.

  • If you have a high-speed Internet connection,
    Fedora with the Sugar graphical learning environment may be installed to a hard disk or a a 4 GB USB stick with a Netinstall CD.
- Not a compressed LiveOS image like SoaS, but all of Sugar.
- This requires a high-speed Internet connection for software component downloading during installation.

Do you use GNU/Linux?

Sugar is supported by several GNU/Linux distributions. Sugar Labs does not support any specific distribution, but does focus development on Fedora and Debian, which helps SoaS and Ubuntu.

Logo Name Notes
Soas-avocado.svg Sugar on a Stick Live system of the Sugar Learning Environment
Fedora-small.jpg Fedora Fedora 34
Ubuntu-small.jpg Ubuntu Ubuntu 18.04 Bionic
Debian-small.jpg Debian Debian Stretch, see also Live Build
Olpc logo.png OLPC OS 16.04 OLPC OS for OLPC NL3 laptops based on Ubuntu 16.04 Xenial
Olpc logo.png OLPC OS 13.x OLPC OS for OLPC XO laptops based on Fedora 18
Suse-small.jpg openSUSE Part of an Linux for Education (Li-f-e) series
Trisquel icon.png Trisquel Toast Based on Ubuntu
Please note:
  • Development changes occur rapidly, and the text here lags the current state of systems development.
  • For the latest information on any development project, visit their work sites.

Are you a developer?

Gear.png Please see this developer documentation website for the sugar-build development environment.

Some additional references you may find useful:

Virtual Machines on all platforms


VirtualBox Appliances

More Virtual Appliances

Sugar included in other GNU/Linux operating systems, and older versions.

Also includes some VMware Player Appliances

If you run into problems, you may want to consult the Talk:VirtualBox page for help.

Are you preparing a deployment without Internet access?

Sugar Creation Kit.png
See Sugar Creation Kit

Are you looking for Sugar Activities?

Visit the Sugar Activity Library <imagemap>

File:Sugarlabs_mainpage_02.png rect 14 14 38 47 Calculate rect 74 15 107 44 Chat rect 137 16 171 43 Implode rect 201 14 238 46 Distance rect 265 12 298 47 Etoys rect 11 79 41 108 Moon rect 74 78 106 110 Paint rect 140 78 170 109 Pippy rect 201 80 235 108 Read rect 266 82 298 107 Record rect 11 143 41 172 TamTam Synth Lab rect 75 146 105 169 Terminal rect 142 140 166 173 Turtle Blocks rect 201 144 235 171 WikiBrowse rect 269 142 299 173 Write default Sugar Activity Library desc none </imagemap>