Difference between pages "Funtoo:Metro/Data Model" and "Funtoo Linux Installation"

From Funtoo
< Funtoo:Metro(Difference between pages)
Jump to navigation Jump to search
 
 
Line 1: Line 1:
== Goals ==
== Introduction ==


The Metro Data Model has been designed to provide you with an optimal way to organize build data.
This document was written to help you install Funtoo Linux as concisely as possible, with a minimum number of distracting options regarding system configuration.  


Here are the primary goals for the data model:
These docs assume you have a "PC compatible" computer system with a standard PC BIOS. Many new computers support UEFI for booting, which is a new firmware interface that replaces the old-fashioned MBR-based BIOS. If you have a system with UEFI, you will want to use this documentation along with the [[UEFI Install Guide]], which will augment these instructions and explain how to get your system to boot. You may need to change your PC BIOS settings to enable or disable UEFI booting. The [[UEFI Install Guide]] has more information on this, and steps on how to determine if your system supports UEFI.


# Provide useful ways to organize data
We also offer a [[ZFS Install Guide]], which augment the instructions on this page for those who want to install Funtoo Linux on ZFS.  If you are installing Funtoo Linux on [[Funtoo Linux Installation on ARM|ARM]] architecture, please see [[Funtoo Linux Installation on ARM]] for notable differences regarding ARM support. An experimental Funtoo Linux build also exists for [[Funtoo Linux Installation on SPARC|SPARC]] platforms. See [[Funtoo Linux Installation on SPARC]].
# Use mechanisms and syntax that maximize maintainability of the data over time
# Reduce and (ideally) eliminate side-effects at every opportunity


To attain these goals, I've used a functional data model, where an element (variable) can be defined only once, and cannot be redefined.
If you've had previous experience installing Gentoo Linux then a lot of steps will be familiar, but you should still read through as there are a few differences.


''By default, the Metro parser operates in &quot;strict&quot; mode, which means that it will throw an error if a variable has been referenced that has not been defined. This &quot;strict&quot; mode is actually very useful in catching errors that might otherwise go unnoticed and result in broken builds.''
== Installation Overview ==


In addition, the Metro parser was designed so that the order in which data elements are defined is not important, even if they reference one another. This was done to eliminate side-effects related to data ordering, where changing the order in which things are defined in a file can change the behavior of or break your code.
This is a basic overview of the Funtoo installation process:


Versions of Metro prior to 1.4 contained limited support for conditional logic. After some experimentation, I've decided that the conditional support is not necessary, and it is not used by Metro 1.4. However, support for conditionals still exist in the parser, but will be removed when the parser is rewritten.
# [[#Live CD|Download and boot the live CD of your choice]].
# [[#Prepare Hard Disk|Prepare your disk]].
# [[#Creating filesystems|Create]] and [[#Mounting filesystems|mount]] filesystems.
# [[#Installing the Stage 3 tarball|Install the Funtoo stage tarball]] of your choice.
# [[#Chroot into Funtoo|Chroot into your new system]].
# [[#Downloading the Portage tree|Download the Portage tree]].
# [[#Configuring your system|Configure your system]] and [[#Configuring your network|network]].
# [[#Configuring and installing the Linux kernel|Install a kernel]].
# [[#Installing a Bootloader|Install a bootloader]].
# [[#Finishing Steps|Complete final steps]].
# [[#Restart your system|Reboot and enjoy]].


=== Live CD ===


== First Look ==
Funtoo doesn't provide an "official" Funtoo Live CD, but there are plenty of good ones out there to choose from. A great choice is the Gentoo-based [http://www.sysresccd.org/ SystemRescueCd] as it contains lots of tools and utilities and supports both 32-bit and 64-bit systems.


Here is some sample Metro data:
It is also possible to install Funtoo Linux using many other Linux-based live CDs. Generally, any modern bootable Linux live CD or live USB media will work. See [[Requirements|requirements]] for an overview of what the Live Media must provide to allow a problem-free install of Funtoo Linux.


<pre>path: /usr/bin</pre>
To begin a Funtoo Linux installation, download SystemRescueCD from:
Above, we have defined the element <tt>path</tt> to have the value <tt>/usr/bin</tt>. <tt>path</tt> is a single-line element, and the Metro parser takes care of trimming any trailing whitespace that may be on the line. You can also define single-line elements that have values that consist of multiple whitespace-separated values:


<pre>options: ccache replace</pre>
* Main US mirror: [http://ftp.osuosl.org/pub/funtoo/distfiles/sysresccd/sysresccd-3.7.1_zfs_0.6.2.iso The Oregon State University Open Source Lab]
Sometimes, you need to define an element but leave it blank. To do this, don't specify any values after the colon:
* Main EU mirror: [http://ftp.heanet.ie/mirrors/funtoo/distfiles/sysresccd/sysresccd-3.7.1_zfs_0.6.2.iso HEAnet] or use your preferred live media. Insert it into your disc drive, and boot from it. If using an older version of SystemRescueCD, '''be sure to select the <tt>rescue64</tt> kernel at the boot menu if you are installing a 64-bit system'''. By default, SystemRescueCD used to boot in 32-bit mode though the latest version attempts to automatically detect 64-bit processors.


<pre>options:</pre>
=== Prepare Hard Disk ===
In Metro, the <tt>/</tt> character is used to delineate various classes of elements, as follows:
==== Partitions ====


<pre>path/mirror: /home/mirror/linux
Funtoo Linux fully supports traditional MBR partitions, as well as newer GPT/GUID partition formats. Funtoo Linux recommends the use of the GPT partitioning scheme, since it is newer and more flexible. Here are the various trade-offs between each partitioning scheme:
path/mirror/snapshot: /home/mirror/linux/snapshots
path/metro: /usr/lib/metro</pre>
Above, we see the proper Metro convention for specifying paths. Each path has a prefix of <tt>path/</tt>. We have a <tt>path/mirror</tt> element but also have a <tt>path/mirror/snapshot</tt> element. The <tt>/</tt> is used to organize our data into logical groups. This is not enforced by Metro but is presented here as a best practice.


The data above could also be represented using a ''section annotation'', as follows:
===== GPT Partitions =====


<pre>[section path]
* Newer, preferred format for Linux systems
* Supports 2 TB+ hard drives for booting
* Supports hundreds of partitions per disk of any size
* Requires legacy BIOS boot partition (~32 MB) to be created if system does not use EFI
* Requires bootloader with support for GPT such as GRUB 2, EXTLINUX, or a patched version of GRUB Legacy


mirror: /home/mirror/linux
===== MBR Partitions =====
mirror/snapshot: /home/mirror/linux/snapshots
metro: /usr/lib/metro</pre>
Above, the <tt>[section path]</tt> line is a section annotation, and it tells the Metro parser that the <tt>path/</tt> prefix should be applied to all following data elements. A section annotation is in effect until another section annotation is encountered by the parser.


While our data above is getting more organized, there is some redundancy in our data, which generally isn't a good thing. Here's an example of how to make our data a bit more compact:
* Legacy, DOS partitioning scheme
* Only 4 primary partitions per disk; after that, you must use "logical" partitions
* Does not support 2 TB+ disks for booting
* Compatible with certain problematic systems (such as the HP ProBook 4520)
* Dual-boot with Windows for BIOS systems (Windows handle GPT only on true EFI systems, whatever version it is)
* Multiple boot loader options, e.g. GRUB 2, GRUB Legacy, lilo


<pre>[section path]
{{fancyimportant|If you plan to use partitions of 2 TB or greater, you ''must'' partition using the GPT/GUID format. Also note that there are small percentage of PCs that will not boot properly with GPT. For these systems, using MBR partitions or a primary drive with an MBR partition may be required in order to boot.}}


mirror: /home/mirror/linux
==== Partitioning Using gdisk ====
mirror/snapshot: $[path/mirror]/snapshots
metro: /usr/lib/metro</pre>
Above, we have used an ''element reference'' of <tt>$[path/mirror]</tt> to reference our <tt>path/mirror</tt> element. What this means is that <tt>path/snapshot</tt> will have a value of <tt>/home/mirror/linux/snapshots</tt>.


Also, it's worth pointing out that we could just have well written:
===== Notes Before We Begin =====


These install instructions assume you are installing Funtoo Linux to an empty hard disk using GUID partition tables (GPT). If you are installing Funtoo Linux on a machine where another OS is installed, or there is an existing Linux distribution on your system that you want to keep, then you will need to adapt these instructions to suit your needs.


<pre>[section path]
If you are going to create a legacy MBR partition table instead of GUID/GPT, you will use the <tt>fdisk</tt> command instead of <tt>gdisk</tt>, and you will not need to create the GRUB boot loader partition. See the table under [[#Partitioning Recommendations|Partitioning Recommendations]], in particular the
'''MBR Block Device (<tt>fdisk</tt>)''' and '''MBR Code''' columns. <tt>fdisk</tt> works just like <tt>gdisk</tt>, but creates legacy MBR partition tables instead of the newer GPT/GUID partition tables.


mirror/snapshot: $[path/mirror]/snapshots
Advanced users may be interested in the following topics:
mirror: /home/mirror/linux
metro: /usr/lib/metro</pre>
In other words, it's perfectly OK to use the element reference of <tt>$[path/mirror]</tt> on a line ''before'' the actual definition of <tt>path/mirror</tt>. Metro doesn't care about the order in which data is defined.


Metro provides another way to organize your data in an efficient way. Supposing that you had a lot of <tt>path/mirror</tt>-related data, then it might be useful to organize your data as follows:
* [[GUID Booting Guide]]
* [[Rootfs over encrypted lvm]]
* [[Rootfs over encrypted lvm over raid-1 on GPT]]
* '''NEW!''' '''[[ZFS Install Guide]] (Also contains instructions for Rootfs over Encrypted ZFS!)'''


<pre>[section path]
===== Using gdisk =====


metro: /usr/lib/metro
The first step after booting SystemRescueCd is to use <tt>gdisk</tt> to create GPT (also known as GUID) partitions, specifying the disk you want to use, which is typically <tt>/dev/sda</tt>, the first disk in the system:


[section path/mirror]
<console># ##i##gdisk /dev/sda</console>
You should find <tt>gdisk</tt> very similar to <tt>fdisk</tt>. Here is the partition table we want to end up with:


: /home/mirror/linux
<console>Command (? for help): ##i##p
snapshot: $[]/snapshot
Disk /dev/sda: 234441648 sectors, 111.8 GiB
source: $[]/$[source/subarch]/funtoo-$[source/subarch]-$[source/version]/$[source/name].tar.bz2</pre>
Logical sector size: 512 bytes
Above, we have used two new parser features. Inside <tt>[section path/mirror]</tt>, we can define the <tt>path/mirror</tt> element itself by using a blank element name, followed by a <tt>:</tt>. The next parser feature we see above is that we can use <tt>$[]</tt> to reference the value of the <tt>path/mirror</tt> value. <tt>$[]</tt> will always reference the value of the element specified in the section annotation. Also note that as of Metro 1.1, <tt>$[:]</tt> can be used as an alternate form of <tt>$[]</tt>. In addition, as of Metro 1.2.4, <tt>$[:foo]</tt> can be used as an alternate form of <tt>$[section-name/foo]</tt>.
Disk identifier (GUID): A4E5208A-CED3-4263-BB25-7147DC426931
Partition table holds up to 128 entries
First usable sector is 34, last usable sector is 234441614
Partitions will be aligned on 2048-sector boundaries
Total free space is 2014 sectors (1007.0 KiB)


== Collect Annotations ==
Number  Start (sector)    End (sector)  Size      Code  Name
  1            2048          206847  500.0 MiB  8300  Linux filesystem
  2          206848          272383  32.0 MiB    EF02  BIOS boot partition
  3          272384        8660991  4.0 GiB    8200  Linux swap
  4        8660992      234441614  107.7 GiB  8300  Linux filesystem


Many scripting languages have the notion of an &quot;include&quot; file, or &quot;importing&quot; additional data from a remote file. Metro has this concept as well, but it is implemented in a somewhat different way. You can tell Metro to include data from another file by using a ''collect annotation''.
Command (? for help): </console>


A collect annotation looks like this:
Above, you'll see that we have a 500 MiB boot partition, a 32 MiB "BIOS boot partition" (also known as the GRUB boot loader partition), 4 GiB of swap, and the remaining disk used by a 107.7 GiB root partition.


<pre>[collect $[path/metro]/myfile.txt]</pre>
===== For new <tt>gdisk</tt> users =====
Now, we called these things &quot;collect annotations&quot; for a reason - in Metro, they work slightly differently than most languages implement <tt>include</tt> and <tt>import</tt>. The main difference is that in Metro, a collect annotation does not happen right away. Instead, Metro will add the file to be collected (in this case, that would be the file <tt>/usr/lib/metro/myfile.txt</tt>, or whatever <tt>$[path/metro]/myfile.txt</tt> evaluates to) to a ''collection queue''. This means that Metro will read in the contents of the file at some point in time, and the data in the file will be available to you by the time the parsing is complete. But because Metro doesn't care about the order in which data is defined, it doesn't have the same concept of &quot;read in the data - right now!&quot; that an include or import statement does in other languages.


=== Conditional Collect Annotations ===
These partitions were created using the "<tt>n</tt>" command from within <tt>gdisk</tt>. The <tt>gdisk</tt> commands to create the partition table above are as follows. Adapt sizes as necessary, although these defaults will work for most users. The partition codes entered below can be found in the [[#Partitioning Recommendations|Partitioning Recommendations]] table below, in the GPT Code column.


Metro no longer officially supports conditional collect annotations; however, simple collect annotations can be used to make conditional decisions in Metro, as follows:
Within <tt>gdisk</tt>, follow these steps:


<pre>[collect ./snapshots/$[snapshot/type]]</pre>
'''Create Partition 1''' (boot):
Above, Metro will collect from a file based on the value of the <tt>$[snapshot/type]</tt> element. This allows for varying definitions of elements to exist dependent on the value of <tt>$[snapshot/type]</tt>.


Above, Metro will raise an exception if <tt>$[snapshot/type]</tt> is undefined or has a value that does not map to a file on disk. If it is possible that <tt>$[snapshot/type]</tt> may not be defined, use the following format:
<console>
Command: ##i##n ↵
Partition Number: ##i##1 ↵
First sector: ##i##↵
Last sector: ##i##+500M ↵
Hex Code: ##i##↵
</console>


<pre>[collect ./snapshots/$[snapshot/type:zap]]</pre>
'''Create Partition 2''' (GRUB):
Using the <tt>:zap</tt> modifier, the entire collect argument will be replaced with the empty string if <tt>$[snapshot/type]</tt> is undefined. If Metro is asked to collect an empty string, it will not throw an exception. So this is a handy way to conditionally disable collection of a file. But please note that for all non-null values of <tt>$[snapshot/type]</tt>, a corresponding file must exist on disk in <tt>./snapshots/</tt> or Metro will throw an exception. <tt>:zap</tt> is explained in more detail in the &quot;Special Variable Expansion&quot; section, below.


== Multi-line elements ==
<console>
Command: ##i##n ↵
Partition Number: ##i##2 ↵
First sector: ##i##↵
Last sector: ##i##+32M ↵
Hex Code: ##i##EF02 ↵
</console>


Metro supports multi-line elements and they are the foundation of Metro's ''template'' engine. A multi-line element can be defined as follows, by using square brackets to delimit multi-line data:
'''Create Partition 3''' (swap):


<pre>myscript: [
<console>
#!/bin/bash
Command: ##i##n ↵
echo $*
Partition Number: ##i##3 ↵
]</pre>
First sector: ##i##↵
The terminating closing square bracket should be on a line all by itself.
Last sector: ##i##+4G ↵
Hex Code: ##i##8200 ↵
</console>


One of the very useful things about multi-line elements is that they support Metro element references:
'''Create Partition 4''' (root):


<pre>myscript: [
<console>
#!/bin/bash
Command: ##i##n ↵
echo Metro's path/metro setting is $[path/metro].
Partition Number: ##i##4 ↵
]</pre>
First sector: ##i##↵
In the above multi-line element, the <tt>$[path/metro]</tt> reference will be expanded to contain the appropriate value of the element. It is possible to expand single-line elements inside multi-line elements simply by referencing them using a dollar sign and square brackets.
Last sector: ##i##↵##!i## (for rest of disk)
Hex Code: ##i##↵
</console>


Metro also allows you to expand multi-line elements inside other multi-line elements. Here's an example of how that works:
Along the way, you can type "<tt>p</tt>" and hit Enter to view your current partition table. If you make a mistake, you can type "<tt>d</tt>" to delete an existing partition that you created. When you are satisfied with your partition setup, type "<tt>w</tt>" to write your configuration to disk:


<pre>myscript: [
'''Write Partition Table To Disk''':
#!/bin/bash
$[[steps/setup]]
echo Hi There :)
]</pre>


[[Category:Metro]]
<console>
Command: ##i##w ↵
Do you want to proceed? (Y/N): ##i##Y ↵
</console>
 
The partition table will now be written to disk and <tt>gdisk</tt> will close.
 
Now, your GPT/GUID partitions have been created, and will show up as the following ''block devices'' under Linux:
 
* <tt>/dev/sda1</tt>, which will be used to hold the <tt>/boot</tt> filesystem,
* <tt>/dev/sda2</tt>, which will be used directly by the new GRUB,
* <tt>/dev/sda3</tt>, which will be used for swap space, and
* <tt>/dev/sda4</tt>, which will hold your root filesystem.
 
===== For Previous fdisk users =====
 
If you have installed Gentoo Linux before, the one thing that is likely new to you here is the GRUB boot loader partition, which is listed as "BIOS boot partition" within <tt>gdisk</tt>. This partition is required for GRUB 2 to boot GPT/GUID boot disks. What is it? In GRUB-speak, this partition is essentially the location of the meat of GRUB's boot loading code. If you've used GRUB Legacy in the past, this partition is where the new GRUB stores the equivalent of the <tt>stage1_5</tt> and <tt>stage2</tt> files in legacy GRUB. Since GPT-based partition tables have less dead space at the beginning of the disk than their MBR equivalents, an explicitly defined partition of code <tt>EF02</tt> is required to hold the guts of the boot loader.
 
In all other respects, the partition table is similar to that which you might create for an MBR-based disk during a Gentoo Linux installation. We have a boot and a root partition with code <tt>0700</tt>, and a Linux swap partition with code <tt>8200</tt>.
 
===== Partitioning Recommendations =====
 
Below are our partitioning recommendations in table form. For GPT-based partitions, use the GPT Block Device and GPT Code columns with <tt>gdisk</tt>. For legacy MBR-based partitions, use the MBR Block Device and MBR code columns with <tt>fdisk</tt>:
 
{| {{table}}
!Partition
!Size
!MBR Block Device (<tt>fdisk</tt>)
!GPT Block Device (<tt>gdisk</tt>)
!Filesystem
!MBR Code
!GPT Code
|-
|<tt>/boot</tt>
|500 MB
|<tt>/dev/sda1</tt>
|<tt>/dev/sda1</tt>
|ext2
|83
|8300
|-
|GRUB boot loader partition
|32 MB
| ''not required for MBR''
|<tt>/dev/sda2</tt>
|For GPT/GUID only, skip for MBR - no filesystem.
|''N/A''
|EF02
|-
|swap
|2x RAM for low-memory systems and production servers; otherwise 2GB.
|<tt>/dev/sda2</tt>
|<tt>/dev/sda3</tt>
|swap (default)
|82
|8200
|-
|<tt>/</tt> (root)
|Rest of the disk, minimum of 10GB.
|<tt>/dev/sda3</tt>
|<tt>/dev/sda4</tt>
|ext4 recommended, alternatively XFS
|83
|8300
|-
|<tt>/home</tt> (optional)
|User storage and media. Typically most of the disk.
|<tt>/dev/sda4</tt> (if created)
|<tt>/dev/sda5</tt> (if created)
|ext4 recommended, alternatively XFS
|83
|8300
|-
| LVM (optional)
| If you want to create an LVM volume.
| <tt>/dev/sda4</tt> (PV, if created)
| <tt>/dev/sda5</tt> (PV, if created)
| LVM PV
| 8E
| 8E00
|}
 
==== Creating filesystems ====
 
Before your newly-created partitions can be used, the block devices need to be initialized with filesystem ''metadata''. This process is known as ''creating a filesystem'' on the block devices. After filesystems are created on the block devices, they can be mounted and used to store files.
 
You will not create a filesystem on your swap partition, but will initialize it using the <tt>mkswap</tt> command so that it can be used as disk-based virtual memory. Then we'll run the <tt>swapon</tt> command to make your newly-initialized swap space active within the live CD environment, in case it is needed during the rest of the install process.
 
Note that we will not create a filesystem on the GRUB boot loader partition, as GRUB writes binary data directly to that partition when the boot loader is installed, which we'll do later.
 
You can see the commands you will need to type below. Like the rest of this document, it assumes that you are using a GPT partitioning scheme. If you are using MBR, your root filesystem will likely be created on <tt>/dev/sda3</tt> instead and you will need to adjust the target block devices. If you are following our recommendations, then simply do this:
 
<console>
# ##i##mke2fs -t ext2 /dev/sda1
# ##i##mkfs.ext4 /dev/sda4
# ##i##mkswap /dev/sda3
# ##i##swapon /dev/sda3
</console>
 
 
XFS filesystem is incompatible with CONFIG_USER_NS config option in kernel (required for LXC)
for XFS filesystem:
<console>
# ##i##mke2fs -t ext2 /dev/sda1
# ##i##mkfs.xfs /dev/sda4
# ##i##mkswap /dev/sda3
# ##i##swapon /dev/sda3
</console>
 
 
==== Mounting filesystems ====
 
Mount the newly-created filesystems as follows, creating <tt>/mnt/funtoo</tt> as the installation mount point:
 
<console>
# ##i##mkdir /mnt/funtoo
# ##i##mount /dev/sda4 /mnt/funtoo
# ##i##mkdir /mnt/funtoo/boot
# ##i##mount /dev/sda1 /mnt/funtoo/boot
</console>
 
Optionally, if you have a separate filesystem for <tt>/home</tt> or anything else:
 
<console>
# ##i##mkdir /mnt/funtoo/home
# ##i##mount /dev/sda5 /mnt/funtoo/home
</console>
 
If you have <tt>/tmp</tt> or <tt>/var/tmp</tt> on a separate filesystem, be sure to change the permissions of the mount point to be globally-writeable after mounting, as follows:
 
<console>
# ##i##chmod 1777 /mnt/funtoo/tmp
</console>
 
=== Installing the Stage 3 tarball ===
==== Stage 3 tarball ====
 
After creating filesystems, the next step is downloading the initial Stage 3 tarball. The Stage 3 is a pre-compiled system used as a starting point to install Funtoo Linux. Visit the [[Download]] page and copy the URL to the Stage 3 tarball you want to use. We will download it soon.
 
{{fancyimportant|If your system's date and time are too far off (typically by months or years,) then it may prevent Portage from properly downloading source tarballs. This is because some of our sources are downloaded via HTTPS, which use SSL certificates and are marked with an activation and expiration date.}}
 
Now is a good time to verify the date and time are correctly set to UTC. Use the <tt>date</tt> command to verify the date and time:
 
<console>
# ##i##date
Fri Jul 15 19:47:18 UTC 2011
</console>
 
If the date and/or time need to be corrected, do so using <tt>date MMDDhhmmYYYY</tt>, keeping in mind <tt>hhmm</tt> are in 24-hour format. The example below changes the date and time to "July 16th, 2011 @ 8:00PM" UTC:
 
<console>
# ##i##date 071620002011
Fri Jul 16 20:00:00 UTC 2011
</console>
 
Once you are in your Funtoo Linux root filesystem, use <tt>wget</tt> to download the Stage 3 tarball you have chosen from the [[Download]] page to use as the basis for your new Funtoo Linux system. It should be saved to the <tt>/mnt/funtoo</tt> directory as follows:
 
<console># ##i##cd /mnt/funtoo
# ##i##wget http://ftp.osuosl.org/pub/funtoo/funtoo-current/x86-64bit/generic_64/stage3-latest.tar.xz
</console>
 
 
Note that 64-bit systems can run 32-bit or 64-bit stages, but 32-bit systems can only run 32-bit stages. Make sure that you select a Stage 3 build that is appropriate for your CPU. If you are not certain, it is a safe bet to choose the <tt>generic_64</tt> or <tt>generic_32</tt> stage. Consult the [[Download]] page for more information.
 
Once the stage is downloaded, extract the contents with the following command, substituting in the actual name of your stage 3 tarball:
<console>
# ##i##tar xJpf stage3-latest.tar.xz
</console>
 
{{fancyimportant|It is very important to use <tt>tar</tt>'s "<tt>p</tt>" option when extracting the Stage 3 tarball - it tells <tt>tar</tt> to ''preserve'' any permissions and ownership that exist within the archive. Without this option, your Funtoo Linux filesystem permissions will be incorrect.}}
 
=== Chroot into Funtoo ===
Before chrooting into your new system, there's a few things that need to be done first. You will need to mount /proc and /dev inside your new system. Use the following commands:
<console>
# ##i##cd /mnt/funtoo
# ##i##mount -t proc none proc
# ##i##mount --rbind /sys sys
# ##i##mount --rbind /dev dev
</console>
 
You'll also want to copy over <tt>resolv.conf</tt> in order to have proper DNS name resolution from inside the chroot:
<console>
# ##i##cp /etc/resolv.conf etc
</console>
 
Now you can chroot into your new system. Use <tt>env</tt> before <tt>chroot</tt> to ensure that no environment variables from the installation media are used by your new system:
 
<console>
# ##i##env -i HOME=/root TERM=$TERM /bin/bash
# ##i##chroot . /bin/bash -l
</console>
 
{{fancynote|Users of live CDs with 64-bit kernels: Some software may use <tt>uname -r</tt> to check whether the system is 32 or 64-bit. You may want append linux32 to the chroot command as a workaround, but it's generally not needed.}}
{{fancyimportant|If you receive the error "<tt>chroot: failed to run command `/bin/bash': Exec format error</tt>", it is probably because you are running a 32-bit kernel and trying to execute 64-bit code. SystemRescueCd boots with a 32-bit kernel by default.}}
 
It's also a good idea to change the default command prompt while inside the chroot. This will avoid confusion if you have to change terminals. Use this command:
<console>
# ##i##export PS1="(chroot) $PS1"
</console>
 
Congratulations! You are now chrooted inside a Funtoo Linux system. Now it's time to get Funtoo Linux properly configured so that Funtoo Linux will boot successfully when your system is restarted.
 
=== Downloading the Portage tree ===
 
{{fancynote|For an alternative way to do this, see [[Installing Portage From Snapshot]].}}
Now it's time to install a copy of the Portage repository, which contains package scripts (ebuilds) that tell portage how to build and install thousands of different software packages. To create the Portage repository, simply run <tt>emerge --sync</tt> from within the chroot. This will automatically clone the portage tree from [http://github.com/ GitHub]:
 
<console>
(chroot) # ##i##emerge --sync
</console>
 
{{fancyimportant|If you receive the error with initial <tt>emerge --sync</tt> due to git protocol restrictions, change <tt>SYNC</tt> variable in <tt>/etc/portage/make.conf</tt>}}
<pre>
SYNC="https://github.com/funtoo/ports-2012.git"
</pre>
 
 
=== Configuring your system ===
As is expected from a Linux distribution, Funtoo Linux has its share of configuration files. The one file you are absolutely required to edit in order to ensure that Funtoo Linux boots successfully is <tt>/etc/fstab</tt>. The others are optional. Here are a list of files that you should consider editing:
 
{| {{table}}
!File
!Do I need to change it?
!Description
|-
|<tt>/etc/fstab</tt>
|'''YES - required'''
|Mount points for all filesystems to be used at boot time. This file must reflect your disk partition setup. We'll guide you through modifying this file below.
|-
|<tt>/etc/localtime</tt>
|''Maybe - recommended''
|Your timezone, which will default to UTC if not set. This should be a symbolic link to something located under /usr/share/zoneinfo (e.g. /usr/share/zoneinfo/America/Montreal)
|-
|<tt>/etc/make.conf<br/>/etc/portage/make.conf&nbsp;(new&nbsp;location)</tt>
|''Maybe - recommended''
|Parameters used by gcc (compiler), portage, and make. It's a good idea to set MAKEOPTS. This is covered later in this document.
|-
|<tt>/etc/conf.d/hostname</tt>
|''Maybe - recommended''
|Used to set system hostname. Set to the fully-qualified (with dots) name. Defaults to <tt>localhost</tt> if not set.
|-
|<tt>/etc/hosts</tt>
|''No''
| You no longer need to manually set the hostname in this file. This file is automatically generated by <tt>/etc/init.d/hostname</tt>.
|-
|<tt>/etc/conf.d/keymaps</tt>
|Optional
|Keyboard mapping configuration file (for console pseudo-terminals). Set if you have a non-US keyboard. See [[Funtoo Linux Localization]].
|-
|<tt>/etc/conf.d/hwclock</tt>
|Optional
|How the time of the battery-backed hardware clock of the system is interpreted (UTC or local time). Linux uses the battery-backed hardware clock to initialize the system clock when the system is booted.
|-
|<tt>/etc/conf.d/modules</tt>
|Optional
|Kernel modules to load automatically at system startup. Typically not required. See [[Additional Kernel Resources]] for more info.
|-
|<tt>profiles</tt>
|Optional
|Some useful portage settings that may help speed up intial configuration.
|}
 
If you're installing an English version of Funtoo Linux, you're in luck as most of the configuration files can be used as-is. If you're installing for another locale, don't worry. We will walk you through the necessary configuration steps on the [[Funtoo Linux Localization]] page, and if needed, there's always plenty of friendly, helpful support. (See [[#Community portal|Community]])
 
Let's go ahead and see what we have to do. Use <tt>nano -w <name_of_file></tt> to edit files -- the "<tt>-w</tt>" disables word-wrapping, which is handy when editing configuration files. You can copy and paste from the examples.
 
{{fancywarning|It's important to edit your <tt>/etc/fstab</tt> file before you reboot! You will need to modify both the "fs" and "type" columns to match the settings for your partitions and filesystems that you created with <tt>gdisk</tt> or <tt>fdisk</tt>. Skipping this step may prevent Funtoo Linux from booting successfully.}}
 
==== /etc/fstab ====
 
<tt>/etc/fstab</tt> is used by the <tt>mount</tt> command which is ran when your system boots. Statements of this file inform <tt>mount</tt> about partitions to be mounted and how they are mounted. In order for the system to boot properly, you must edit <tt>/etc/fstab</tt> and ensure that it reflects the partition configuration you used earlier:
 
<console>
(chroot) # ##i##nano -w /etc/fstab
</console>
 
You can use arrow keys to move around and hit Control-X to exit. If you want to save your changes, type "<tt>Y</tt>" when asked if you want to save the modified buffer, or hit Control-O before closing <tt>nano</tt>. Otherwise your changes will be discarded.
 
<pre>
# The root filesystem should have a pass number of either 0 or 1.
# All other filesystems should have a pass number of 0 or greater than 1.
#
# NOTE: If your BOOT partition is ReiserFS, add the notail option to opts.
#
# See the manpage fstab(5) for more information.
#
# <fs>     <mountpoint>  <type>  <opts>        <dump/pass>
 
/dev/sda1    /boot        ext2    noatime        1 2
/dev/sda3    none          swap    sw            0 0
/dev/sda4    /            ext4    noatime        0 1
#/dev/cdrom  /mnt/cdrom    auto    noauto,ro      0 0
</pre>
 
==== /etc/localtime ====
 
<tt>/etc/localtime</tt> is used to specify the timezone that your machine is in, and defaults to UTC. If you would like your Funtoo Linux system to use local time, you should replace <tt>/etc/localtime</tt> with a symbolic link to the timezone that you wish to use.
 
<console>
(chroot) # ln -sf /usr/share/zoneinfo/America/Montreal /etc/localtime
</console>
 
The above sets the timezone to Eastern Time Canada. Go to <tt>/usr/share/zoneinfo</tt> to see which values to use.
 
==== /etc/make.conf ====
 
{{fancynote|This file is the symlink to /etc/portage/make.conf, new default location, edit /etc/portage/make.conf.}}
 
MAKEOPTS can be used to define how many parallel compilations should occur when you compile a package, which can speed up compilation significantly. A rule of thumb is the number of CPUs (or CPU threads) in your system plus one. If for example you have a dual core processor without [[wikipedia:Hyper-threading|hyper-threading]], then you would set MAKEOPTS to 3:
 
<pre>
MAKEOPTS="-j3"
</pre>
 
If you are unsure about how many processors/threads you have then use /proc/cpuinfo to help you.
<console>
(chroot) # ##i##grep "processor" /proc/cpuinfo | wc -l
16
</console>
 
Set MAKEOPTS to this number plus one:
 
<pre>
MAKEOPTS="-j17"
</pre>
 
USE flags define what functionality is enabled when packages are built. It is not recommended to add a lot of them during installation; you should wait until you have a working, bootable system before changing your USE flags. A USE flag prefixed with a minus ("<tt>-</tt>") sign tells Portage not to use the flag when compiling.  A Funtoo guide to USE flags will be available in the future. For now, you can find out more information about USE flags in the [http://www.gentoo.org/doc/en/handbook/handbook-amd64.xml?part=2&chap=2 Gentoo Handbook].
 
LINGUAS tells Portage which local language to compile the system and applications in (those who use LINGUAS variable like OpenOffice). It is not usually necessary to set this if you use English. If you want another language such as French (fr) or German (de), set LINGUAS appropriately:
 
<pre>
LINGUAS="fr"
</pre>
 
==== /etc/conf.d/hwclock ====
If you dual-boot with Windows, you'll need to edit this file and change '''clock''' to '''local''', because Windows will set your hardware clock to local time every time you boot Windows. Otherwise you normally wouldn't need to edit this file.
<console>
(chroot) # ##i##nano -w /etc/conf.d/hwclock
</console>
 
==== Localization ====
 
By default, Funtoo Linux is configured with Unicode (UTF-8) enabled, and for the US English locale and keyboard. If you would like to configure your system to use a non-English locale or keyboard, see [[Funtoo Linux Localization]].
 
==== Profiles ====
 
[[Funtoo 1.0 Profile|Funtoo profiles]] are used to define defaults for Portage specific to your needs. There are 4 basic profile types: arch, build, [[Flavors and Mix-ins|flavor, and mix-ins]]:
 
;arch: typically <tt>x86-32bit</tt> or <tt>x86-64bit</tt>, this defines the processor type and support of your system. This is defined when your stage was built and should not be changed.
;build: defines whether your system is a <tt>current</tt>, <tt>stable</tt> or <tt>experimental</tt> build. <tt>current</tt> systems will have newer packages unmasked than <tt>stable</tt> systems.
;flavor: defines the general type of system, such as <tt>server</tt> or <tt>desktop</tt>, and will set default USE flags appropriate for your needs.
;mix-ins: define various optional settings that you may be interested in enabling.
 
One arch, build and flavor must be set for each Funtoo Linux system, while mix-ins are optional and you can enable more than one if desired.
 
Remember that profiles can often be inherited. For example, the <tt>desktop</tt> flavor inherits the <tt>workstation</tt> flavor settings, which in turn inherits the <tt>X</tt> and <tt>audio</tt> mix-ins. You can view this by using eselect:
 
<console>
(chroot) # ##i##eselect profile show
Currently set profiles:
    arch: gentoo:funtoo/1.0/linux-gnu/arch/x86-64bit
  build: gentoo:funtoo/1.0/linux-gnu/build/current
  flavor: gentoo:funtoo/1.0/linux-gnu/flavor/desktop
mix-ins: gentoo:funtoo/1.0/linux-gnu/mix-ins/kde
 
Automatically enabled profiles:
mix-ins: gentoo:funtoo/1.0/linux-gnu/mix-ins/print
mix-ins: gentoo:funtoo/1.0/linux-gnu/mix-ins/X
mix-ins: gentoo:funtoo/1.0/linux-gnu/mix-ins/audio
mix-ins: gentoo:funtoo/1.0/linux-gnu/mix-ins/dvd
mix-ins: gentoo:funtoo/1.0/linux-gnu/mix-ins/media
mix-ins: gentoo:funtoo/1.0/linux-gnu/mix-ins/console-extras
 
 
</console>
 
To view installed profiles:
<console>
(chroot) # ##i##eselect profile list
</console>
 
To change the profile flavor:
<console>
(chroot) # ##i##eselect profile set-flavor 7
</console>
 
To add a mix-in:
 
<console>
(chroot) # ##i##eselect profile add 10
</console>
 
=== Configuring and installing the Linux kernel ===
 
Now it's time to build and install a Linux kernel, which is the heart of any Funtoo Linux system. In the past, the process of creating a kernel that actually booted your system could be time-consuming and require a great deal of trial and error. Fortunately, Funtoo Linux offers an option to automatically build a kernel for you that will boot nearly all systems.
 
If you are unfamiliar with how to manually configure your own kernel, or you simply want to get your system up and running quickly, you can emerge <tt>debian-sources</tt> with the <tt>binary</tt> USE flag set, which will automatically build the kernel and an initrd that will boot nearly all Funtoo Linux systems. This kernel is based on a linux-3.2 LTS official debian kernel package and is an easy way to get your system up and running relatively quickly.
 
Click [http://wiki.debian.org/DebianKernel here] for a list of all architectures the Debian kernel supports.
 
{{fancyimportant|<tt>debian-sources</tt> with <tt>binary</tt> USE flag requires at least 12GB in /var/tmp}}
 
<console>
(chroot) # ##i##echo "sys-kernel/debian-sources binary" >> /etc/portage/package.use
(chroot) # ##i##emerge debian-sources
</console>
 
All done!
 
{{fancynote|NVIDIA card users: the <tt>binary</tt> USE flag installs the Nouveau drivers which cannot be loaded at the same time as the proprietary drivers, and cannot be unloaded at runtime because of KMS. You need to blacklist it under <tt>/etc/modprobe.d/</tt>.}}
{{fancynote|For an overview of other kernel options for Funtoo Linux, see [[Funtoo Linux Kernels]]. There maybe modules that the Debian kernel doesn't include, a situation where [http://www.funtoo.org/wiki/Funtoo_Linux_Kernels#Using_Debian-Sources_with_Genkernel genkernel] would be useful. Also be sure to see [[:Category:Hardware Compatibility|hardware compatibility]] information. We have compiled a very good reference for [[Dell PowerEdge 11G Servers]] that includes kernel compatibility information as well..}}
 
 
The next step is to configure your boot loader so that your new kernel loads when the system boots.
 
=== Installing a Bootloader ===
 
==== Installing Grub ====
 
The boot loader is responsible for loading the kernel from disk when your computer boots. For new installations, GRUB 2 and Funtoo's boot-update tool should be used as a boot loader. GRUB supports both GPT/GUID and legacy MBR partitioning schemes.
 
To use this recommended boot method, first emerge <tt>boot-update</tt>. This will also cause <tt>grub-2</tt> to be merged, since it is a dependency of <tt>boot-update</tt>.
 
<console>
(chroot) # ##i##emerge boot-update
</console>
 
Then, edit <tt>/etc/boot.conf</tt> and specify "<tt>Funtoo Linux genkernel</tt>" as the <tt>default</tt> setting at the top of the file, replacing <tt>"Funtoo Linux"</tt>.
 
<tt>/etc/boot.conf</tt> should now look like this:
 
<pre>
boot {
        generate grub
        default "Funtoo Linux genkernel"
        timeout 3
}
 
"Funtoo Linux" {
        kernel bzImage[-v]
        # params += nomodeset
}
 
"Funtoo Linux genkernel" {
        kernel kernel[-v]
        initrd initramfs[-v]
        params += real_root=auto
        # params += nomodeset
}
</pre>
Please read <tt>man boot.conf</tt> for further details.
 
===== Running grub-install and boot-update =====
 
Finally, we will need to actually install the GRUB boot loader to your disk, and also run <tt>boot-update</tt> which will generate your boot loader configuration file:
 
<console>
(chroot) # ##i##grub-install --no-floppy /dev/sda
(chroot) # ##i##boot-update
</console>
 
You only need to run <tt>grub-install</tt> when you first install Funtoo Linux, but you need to re-run <tt>boot-update</tt> every time you modify your <tt>/etc/boot.conf</tt> file, so your changes are applied on next boot.
 
OK - your system should be ready to boot! Well, there are a few more loose ends...
 
==== Installing Syslinux/Extlinux ====
 
An alternate Bootloader is Extlinux, for installing it see the [[Extlinux|extlinux Guide]].
 
=== Configuring your network ===
 
It's important to ensure that you will be able to connect to your local-area network after you reboot into Funtoo Linux. There are three approaches you can use for configuring your network: NetworkManager, dhcpcd, and the [[Funtoo Linux Networking]] scripts. Here's how to choose which one to use based on the type of network you want to set up.
 
==== Wi-Fi ====
 
For laptop/mobile systems where you will be using Wi-Fi and connecting to various networks, NetworkManager is strongly recommended. The Funtoo version of NetworkManager is fully functional even from the command-line, so you can use it even without X or without the Network Manager applet. Here are the steps involved in setting up NetworkManager:
 
<console>
# ##i##emerge linux-firmware
# ##i##emerge networkmanager
# ##i##rc-update add NetworkManager default
</console>
 
Above, we installed linux-firmware which contains a complete collection of available firmware for many hardware devices including Wi-Fi adapters, plus NetworkManager to manage our network connection. Then we added NetworkManager to the <tt>default</tt> runlevel so it will start when Funtoo Linux boots.
 
After you reboot into Funtoo Linux, you will be able to add a Wi-Fi connection this way:
 
<console>
# ##i##addwifi -S wpa -K 'wifipassword' mywifinetwork
</console>
 
The <tt>addwifi</tt> command is used to configure and connect to a WPA/WPA2 Wi-Fi network named <tt>mywifinetwork</tt> with the password <tt>wifipassword</tt>. This network configuration entry is stored in <tt>/etc/NetworkManager/system-connections</tt> so that it will be remembered in the future. You should only need to enter this command once for each Wi-Fi network you connect to.
 
==== Desktop (Wired Ethernet) ====
 
For a home desktop or workstation with wired Ethernet that will use DHCP, the simplest and most effective option to enable network connectivity is to simply add <tt>dhcpcd</tt> to the default runlevel:
 
<console>
# ##i##rc-update add dhcpcd default
</console>
 
When you reboot, <tt>dhcpcd</tt> will run in the background and manage all network interfaces and use DHCP to acquire network addresses from a DHCP server.
 
==== Server (Static IP) ====
 
For servers, the [[Funtoo Linux Networking]] scripts are recommended. They are optimized for static configurations and things like virtual ethernet bridging for virtualization setups. See [[Funtoo Linux Networking]] for information on how to use Funtoo Linux's template-based network configuration system.
 
=== Finishing Steps ===
 
==== Set your root password ====
It's imperative that you set your root password before rebooting so that you can log in.
<console>
(chroot) # ##i##passwd
</console>
 
===Restart your system ===
 
Now is the time to leave chroot, to unmount Funtoo Linux partitions and files and to restart your computer. When you restart, the GRUB boot loader will start, load the Linux kernel and initramfs, and your system will begin booting.
 
Leave the chroot, change directory to /, unmount your Funtoo partitions, and reboot.
<console>
(chroot) # ##i##exit
# ##i##cd /
# ##i##umount -l /mnt/funtoo/boot /mnt/funtoo/dev /mnt/funtoo/proc /mnt/funtoo
# ##i##reboot
</console>
 
You should now see your system reboot, the GRUB boot loader appear for a few seconds, and then see the Linux kernel and initramfs loading. After this, you should see Funtoo Linux itself start to boot, and you should be greeted with a <tt>login:</tt> prompt. Funtoo Linux has been successfully installed!
 
===Next Steps===
 
If you have not used Portage before, then be sure to check out our quick introduction to [[Emerge]].
 
To learn how to customize and start using Funtoo Linux, see [[Funtoo Linux First Steps]].
 
If your system did not boot correctly, see [[Installation Troubleshooting]] for steps you can take to resolve the problem.
 
[[Category:HOWTO]]
[[Category:Install]]

Revision as of 12:52, September 21, 2013

Introduction

This document was written to help you install Funtoo Linux as concisely as possible, with a minimum number of distracting options regarding system configuration.

These docs assume you have a "PC compatible" computer system with a standard PC BIOS. Many new computers support UEFI for booting, which is a new firmware interface that replaces the old-fashioned MBR-based BIOS. If you have a system with UEFI, you will want to use this documentation along with the UEFI Install Guide, which will augment these instructions and explain how to get your system to boot. You may need to change your PC BIOS settings to enable or disable UEFI booting. The UEFI Install Guide has more information on this, and steps on how to determine if your system supports UEFI.

We also offer a ZFS Install Guide, which augment the instructions on this page for those who want to install Funtoo Linux on ZFS. If you are installing Funtoo Linux on ARM architecture, please see Funtoo Linux Installation on ARM for notable differences regarding ARM support. An experimental Funtoo Linux build also exists for SPARC platforms. See Funtoo Linux Installation on SPARC.

If you've had previous experience installing Gentoo Linux then a lot of steps will be familiar, but you should still read through as there are a few differences.

Installation Overview

This is a basic overview of the Funtoo installation process:

  1. Download and boot the live CD of your choice.
  2. Prepare your disk.
  3. Create and mount filesystems.
  4. Install the Funtoo stage tarball of your choice.
  5. Chroot into your new system.
  6. Download the Portage tree.
  7. Configure your system and network.
  8. Install a kernel.
  9. Install a bootloader.
  10. Complete final steps.
  11. Reboot and enjoy.

Live CD

Funtoo doesn't provide an "official" Funtoo Live CD, but there are plenty of good ones out there to choose from. A great choice is the Gentoo-based SystemRescueCd as it contains lots of tools and utilities and supports both 32-bit and 64-bit systems.

It is also possible to install Funtoo Linux using many other Linux-based live CDs. Generally, any modern bootable Linux live CD or live USB media will work. See requirements for an overview of what the Live Media must provide to allow a problem-free install of Funtoo Linux.

To begin a Funtoo Linux installation, download SystemRescueCD from:

  • Main US mirror: The Oregon State University Open Source Lab
  • Main EU mirror: HEAnet or use your preferred live media. Insert it into your disc drive, and boot from it. If using an older version of SystemRescueCD, be sure to select the rescue64 kernel at the boot menu if you are installing a 64-bit system. By default, SystemRescueCD used to boot in 32-bit mode though the latest version attempts to automatically detect 64-bit processors.

Prepare Hard Disk

Partitions

Funtoo Linux fully supports traditional MBR partitions, as well as newer GPT/GUID partition formats. Funtoo Linux recommends the use of the GPT partitioning scheme, since it is newer and more flexible. Here are the various trade-offs between each partitioning scheme:

GPT Partitions
  • Newer, preferred format for Linux systems
  • Supports 2 TB+ hard drives for booting
  • Supports hundreds of partitions per disk of any size
  • Requires legacy BIOS boot partition (~32 MB) to be created if system does not use EFI
  • Requires bootloader with support for GPT such as GRUB 2, EXTLINUX, or a patched version of GRUB Legacy
MBR Partitions
  • Legacy, DOS partitioning scheme
  • Only 4 primary partitions per disk; after that, you must use "logical" partitions
  • Does not support 2 TB+ disks for booting
  • Compatible with certain problematic systems (such as the HP ProBook 4520)
  • Dual-boot with Windows for BIOS systems (Windows handle GPT only on true EFI systems, whatever version it is)
  • Multiple boot loader options, e.g. GRUB 2, GRUB Legacy, lilo
   Important

If you plan to use partitions of 2 TB or greater, you must partition using the GPT/GUID format. Also note that there are small percentage of PCs that will not boot properly with GPT. For these systems, using MBR partitions or a primary drive with an MBR partition may be required in order to boot.

Partitioning Using gdisk

Notes Before We Begin

These install instructions assume you are installing Funtoo Linux to an empty hard disk using GUID partition tables (GPT). If you are installing Funtoo Linux on a machine where another OS is installed, or there is an existing Linux distribution on your system that you want to keep, then you will need to adapt these instructions to suit your needs.

If you are going to create a legacy MBR partition table instead of GUID/GPT, you will use the fdisk command instead of gdisk, and you will not need to create the GRUB boot loader partition. See the table under Partitioning Recommendations, in particular the MBR Block Device (fdisk) and MBR Code columns. fdisk works just like gdisk, but creates legacy MBR partition tables instead of the newer GPT/GUID partition tables.

Advanced users may be interested in the following topics:

Using gdisk

The first step after booting SystemRescueCd is to use gdisk to create GPT (also known as GUID) partitions, specifying the disk you want to use, which is typically /dev/sda, the first disk in the system:

root # gdisk /dev/sda

You should find gdisk very similar to fdisk. Here is the partition table we want to end up with:

Command (? for help): p
Disk /dev/sda: 234441648 sectors, 111.8 GiB
Logical sector size: 512 bytes
Disk identifier (GUID): A4E5208A-CED3-4263-BB25-7147DC426931
Partition table holds up to 128 entries
First usable sector is 34, last usable sector is 234441614
Partitions will be aligned on 2048-sector boundaries
Total free space is 2014 sectors (1007.0 KiB)

Number  Start (sector)    End (sector)  Size       Code  Name
   1            2048          206847   500.0 MiB   8300  Linux filesystem
   2          206848          272383   32.0 MiB    EF02  BIOS boot partition
   3          272384         8660991   4.0 GiB     8200  Linux swap
   4         8660992       234441614   107.7 GiB   8300  Linux filesystem

Command (? for help): 

Above, you'll see that we have a 500 MiB boot partition, a 32 MiB "BIOS boot partition" (also known as the GRUB boot loader partition), 4 GiB of swap, and the remaining disk used by a 107.7 GiB root partition.

For new gdisk users

These partitions were created using the "n" command from within gdisk. The gdisk commands to create the partition table above are as follows. Adapt sizes as necessary, although these defaults will work for most users. The partition codes entered below can be found in the Partitioning Recommendations table below, in the GPT Code column.

Within gdisk, follow these steps:

Create Partition 1 (boot):

Command: n ↵
Partition Number: 1 ↵
First sector: 
Last sector: +500M ↵
Hex Code: 

Create Partition 2 (GRUB):

Command: n ↵
Partition Number: 2 ↵
First sector: 
Last sector: +32M ↵
Hex Code: EF02 ↵

Create Partition 3 (swap):

Command: n ↵
Partition Number: 3 ↵
First sector: 
Last sector: +4G ↵
Hex Code: 8200 ↵

Create Partition 4 (root):

Command: n ↵
Partition Number: 4 ↵
First sector: 
Last sector:  (for rest of disk)
Hex Code: 

Along the way, you can type "p" and hit Enter to view your current partition table. If you make a mistake, you can type "d" to delete an existing partition that you created. When you are satisfied with your partition setup, type "w" to write your configuration to disk:

Write Partition Table To Disk:

Command: w ↵
Do you want to proceed? (Y/N): Y ↵

The partition table will now be written to disk and gdisk will close.

Now, your GPT/GUID partitions have been created, and will show up as the following block devices under Linux:

  • /dev/sda1, which will be used to hold the /boot filesystem,
  • /dev/sda2, which will be used directly by the new GRUB,
  • /dev/sda3, which will be used for swap space, and
  • /dev/sda4, which will hold your root filesystem.
For Previous fdisk users

If you have installed Gentoo Linux before, the one thing that is likely new to you here is the GRUB boot loader partition, which is listed as "BIOS boot partition" within gdisk. This partition is required for GRUB 2 to boot GPT/GUID boot disks. What is it? In GRUB-speak, this partition is essentially the location of the meat of GRUB's boot loading code. If you've used GRUB Legacy in the past, this partition is where the new GRUB stores the equivalent of the stage1_5 and stage2 files in legacy GRUB. Since GPT-based partition tables have less dead space at the beginning of the disk than their MBR equivalents, an explicitly defined partition of code EF02 is required to hold the guts of the boot loader.

In all other respects, the partition table is similar to that which you might create for an MBR-based disk during a Gentoo Linux installation. We have a boot and a root partition with code 0700, and a Linux swap partition with code 8200.

Partitioning Recommendations

Below are our partitioning recommendations in table form. For GPT-based partitions, use the GPT Block Device and GPT Code columns with gdisk. For legacy MBR-based partitions, use the MBR Block Device and MBR code columns with fdisk:

Partition Size MBR Block Device (fdisk) GPT Block Device (gdisk) Filesystem MBR Code GPT Code
/boot 500 MB /dev/sda1 /dev/sda1 ext2 83 8300
GRUB boot loader partition 32 MB not required for MBR /dev/sda2 For GPT/GUID only, skip for MBR - no filesystem. N/A EF02
swap 2x RAM for low-memory systems and production servers; otherwise 2GB. /dev/sda2 /dev/sda3 swap (default) 82 8200
/ (root) Rest of the disk, minimum of 10GB. /dev/sda3 /dev/sda4 ext4 recommended, alternatively XFS 83 8300
/home (optional) User storage and media. Typically most of the disk. /dev/sda4 (if created) /dev/sda5 (if created) ext4 recommended, alternatively XFS 83 8300
LVM (optional) If you want to create an LVM volume. /dev/sda4 (PV, if created) /dev/sda5 (PV, if created) LVM PV 8E 8E00

Creating filesystems

Before your newly-created partitions can be used, the block devices need to be initialized with filesystem metadata. This process is known as creating a filesystem on the block devices. After filesystems are created on the block devices, they can be mounted and used to store files.

You will not create a filesystem on your swap partition, but will initialize it using the mkswap command so that it can be used as disk-based virtual memory. Then we'll run the swapon command to make your newly-initialized swap space active within the live CD environment, in case it is needed during the rest of the install process.

Note that we will not create a filesystem on the GRUB boot loader partition, as GRUB writes binary data directly to that partition when the boot loader is installed, which we'll do later.

You can see the commands you will need to type below. Like the rest of this document, it assumes that you are using a GPT partitioning scheme. If you are using MBR, your root filesystem will likely be created on /dev/sda3 instead and you will need to adjust the target block devices. If you are following our recommendations, then simply do this:

root # mke2fs -t ext2 /dev/sda1 
root # mkfs.ext4 /dev/sda4
root # mkswap /dev/sda3
root # swapon /dev/sda3


XFS filesystem is incompatible with CONFIG_USER_NS config option in kernel (required for LXC) for XFS filesystem:

root # mke2fs -t ext2 /dev/sda1 
root # mkfs.xfs /dev/sda4
root # mkswap /dev/sda3
root # swapon /dev/sda3


Mounting filesystems

Mount the newly-created filesystems as follows, creating /mnt/funtoo as the installation mount point:

root # mkdir /mnt/funtoo
root # mount /dev/sda4 /mnt/funtoo
root # mkdir /mnt/funtoo/boot
root # mount /dev/sda1 /mnt/funtoo/boot

Optionally, if you have a separate filesystem for /home or anything else:

root # mkdir /mnt/funtoo/home
root # mount /dev/sda5 /mnt/funtoo/home

If you have /tmp or /var/tmp on a separate filesystem, be sure to change the permissions of the mount point to be globally-writeable after mounting, as follows:

root # chmod 1777 /mnt/funtoo/tmp

Installing the Stage 3 tarball

Stage 3 tarball

After creating filesystems, the next step is downloading the initial Stage 3 tarball. The Stage 3 is a pre-compiled system used as a starting point to install Funtoo Linux. Visit the Download page and copy the URL to the Stage 3 tarball you want to use. We will download it soon.

   Important

If your system's date and time are too far off (typically by months or years,) then it may prevent Portage from properly downloading source tarballs. This is because some of our sources are downloaded via HTTPS, which use SSL certificates and are marked with an activation and expiration date.

Now is a good time to verify the date and time are correctly set to UTC. Use the date command to verify the date and time:

root # date
Fri Jul 15 19:47:18 UTC 2011

If the date and/or time need to be corrected, do so using date MMDDhhmmYYYY, keeping in mind hhmm are in 24-hour format. The example below changes the date and time to "July 16th, 2011 @ 8:00PM" UTC:

root # date 071620002011
Fri Jul 16 20:00:00 UTC 2011

Once you are in your Funtoo Linux root filesystem, use wget to download the Stage 3 tarball you have chosen from the Download page to use as the basis for your new Funtoo Linux system. It should be saved to the /mnt/funtoo directory as follows:

root # cd /mnt/funtoo
root # wget http://ftp.osuosl.org/pub/funtoo/funtoo-current/x86-64bit/generic_64/stage3-latest.tar.xz


Note that 64-bit systems can run 32-bit or 64-bit stages, but 32-bit systems can only run 32-bit stages. Make sure that you select a Stage 3 build that is appropriate for your CPU. If you are not certain, it is a safe bet to choose the generic_64 or generic_32 stage. Consult the Download page for more information.

Once the stage is downloaded, extract the contents with the following command, substituting in the actual name of your stage 3 tarball:

root # tar xJpf stage3-latest.tar.xz
   Important

It is very important to use tar's "p" option when extracting the Stage 3 tarball - it tells tar to preserve any permissions and ownership that exist within the archive. Without this option, your Funtoo Linux filesystem permissions will be incorrect.

Chroot into Funtoo

Before chrooting into your new system, there's a few things that need to be done first. You will need to mount /proc and /dev inside your new system. Use the following commands:

root # cd /mnt/funtoo
root # mount -t proc none proc
root # mount --rbind /sys sys
root # mount --rbind /dev dev

You'll also want to copy over resolv.conf in order to have proper DNS name resolution from inside the chroot:

root # cp /etc/resolv.conf etc

Now you can chroot into your new system. Use env before chroot to ensure that no environment variables from the installation media are used by your new system:

root # env -i HOME=/root TERM=$TERM /bin/bash
root # chroot . /bin/bash -l
   Note

Users of live CDs with 64-bit kernels: Some software may use uname -r to check whether the system is 32 or 64-bit. You may want append linux32 to the chroot command as a workaround, but it's generally not needed.

   Important

If you receive the error "chroot: failed to run command `/bin/bash': Exec format error", it is probably because you are running a 32-bit kernel and trying to execute 64-bit code. SystemRescueCd boots with a 32-bit kernel by default.

It's also a good idea to change the default command prompt while inside the chroot. This will avoid confusion if you have to change terminals. Use this command:

root # export PS1="(chroot) $PS1"

Congratulations! You are now chrooted inside a Funtoo Linux system. Now it's time to get Funtoo Linux properly configured so that Funtoo Linux will boot successfully when your system is restarted.

Downloading the Portage tree

   Note

For an alternative way to do this, see Installing Portage From Snapshot.

Now it's time to install a copy of the Portage repository, which contains package scripts (ebuilds) that tell portage how to build and install thousands of different software packages. To create the Portage repository, simply run emerge --sync from within the chroot. This will automatically clone the portage tree from GitHub:

(chroot) # emerge --sync
   Important

If you receive the error with initial emerge --sync due to git protocol restrictions, change SYNC variable in /etc/portage/make.conf

SYNC="https://github.com/funtoo/ports-2012.git"


Configuring your system

As is expected from a Linux distribution, Funtoo Linux has its share of configuration files. The one file you are absolutely required to edit in order to ensure that Funtoo Linux boots successfully is /etc/fstab. The others are optional. Here are a list of files that you should consider editing:

File Do I need to change it? Description
/etc/fstab YES - required Mount points for all filesystems to be used at boot time. This file must reflect your disk partition setup. We'll guide you through modifying this file below.
/etc/localtime Maybe - recommended Your timezone, which will default to UTC if not set. This should be a symbolic link to something located under /usr/share/zoneinfo (e.g. /usr/share/zoneinfo/America/Montreal)
/etc/make.conf
/etc/portage/make.conf (new location)
Maybe - recommended Parameters used by gcc (compiler), portage, and make. It's a good idea to set MAKEOPTS. This is covered later in this document.
/etc/conf.d/hostname Maybe - recommended Used to set system hostname. Set to the fully-qualified (with dots) name. Defaults to localhost if not set.
/etc/hosts No You no longer need to manually set the hostname in this file. This file is automatically generated by /etc/init.d/hostname.
/etc/conf.d/keymaps Optional Keyboard mapping configuration file (for console pseudo-terminals). Set if you have a non-US keyboard. See Funtoo Linux Localization.
/etc/conf.d/hwclock Optional How the time of the battery-backed hardware clock of the system is interpreted (UTC or local time). Linux uses the battery-backed hardware clock to initialize the system clock when the system is booted.
/etc/conf.d/modules Optional Kernel modules to load automatically at system startup. Typically not required. See Additional Kernel Resources for more info.
profiles Optional Some useful portage settings that may help speed up intial configuration.

If you're installing an English version of Funtoo Linux, you're in luck as most of the configuration files can be used as-is. If you're installing for another locale, don't worry. We will walk you through the necessary configuration steps on the Funtoo Linux Localization page, and if needed, there's always plenty of friendly, helpful support. (See Community)

Let's go ahead and see what we have to do. Use nano -w <name_of_file> to edit files -- the "-w" disables word-wrapping, which is handy when editing configuration files. You can copy and paste from the examples.

   Warning

It's important to edit your /etc/fstab file before you reboot! You will need to modify both the "fs" and "type" columns to match the settings for your partitions and filesystems that you created with gdisk or fdisk. Skipping this step may prevent Funtoo Linux from booting successfully.

/etc/fstab

/etc/fstab is used by the mount command which is ran when your system boots. Statements of this file inform mount about partitions to be mounted and how they are mounted. In order for the system to boot properly, you must edit /etc/fstab and ensure that it reflects the partition configuration you used earlier:

(chroot) # nano -w /etc/fstab

You can use arrow keys to move around and hit Control-X to exit. If you want to save your changes, type "Y" when asked if you want to save the modified buffer, or hit Control-O before closing nano. Otherwise your changes will be discarded.

# The root filesystem should have a pass number of either 0 or 1.
# All other filesystems should have a pass number of 0 or greater than 1.
#
# NOTE: If your BOOT partition is ReiserFS, add the notail option to opts.
#
# See the manpage fstab(5) for more information.
#
# <fs>	     <mountpoint>  <type>  <opts>         <dump/pass>

/dev/sda1    /boot         ext2    noatime        1 2
/dev/sda3    none          swap    sw             0 0
/dev/sda4    /             ext4    noatime        0 1
#/dev/cdrom  /mnt/cdrom    auto    noauto,ro      0 0

/etc/localtime

/etc/localtime is used to specify the timezone that your machine is in, and defaults to UTC. If you would like your Funtoo Linux system to use local time, you should replace /etc/localtime with a symbolic link to the timezone that you wish to use.

(chroot) # ln -sf /usr/share/zoneinfo/America/Montreal /etc/localtime

The above sets the timezone to Eastern Time Canada. Go to /usr/share/zoneinfo to see which values to use.

/etc/make.conf

   Note

This file is the symlink to /etc/portage/make.conf, new default location, edit /etc/portage/make.conf.

MAKEOPTS can be used to define how many parallel compilations should occur when you compile a package, which can speed up compilation significantly. A rule of thumb is the number of CPUs (or CPU threads) in your system plus one. If for example you have a dual core processor without hyper-threading, then you would set MAKEOPTS to 3:

MAKEOPTS="-j3" 

If you are unsure about how many processors/threads you have then use /proc/cpuinfo to help you.

(chroot) # grep "processor" /proc/cpuinfo | wc -l
16

Set MAKEOPTS to this number plus one:

MAKEOPTS="-j17"

USE flags define what functionality is enabled when packages are built. It is not recommended to add a lot of them during installation; you should wait until you have a working, bootable system before changing your USE flags. A USE flag prefixed with a minus ("-") sign tells Portage not to use the flag when compiling. A Funtoo guide to USE flags will be available in the future. For now, you can find out more information about USE flags in the Gentoo Handbook.

LINGUAS tells Portage which local language to compile the system and applications in (those who use LINGUAS variable like OpenOffice). It is not usually necessary to set this if you use English. If you want another language such as French (fr) or German (de), set LINGUAS appropriately:

LINGUAS="fr"

/etc/conf.d/hwclock

If you dual-boot with Windows, you'll need to edit this file and change clock to local, because Windows will set your hardware clock to local time every time you boot Windows. Otherwise you normally wouldn't need to edit this file.

(chroot) # nano -w /etc/conf.d/hwclock

Localization

By default, Funtoo Linux is configured with Unicode (UTF-8) enabled, and for the US English locale and keyboard. If you would like to configure your system to use a non-English locale or keyboard, see Funtoo Linux Localization.

Profiles

Funtoo profiles are used to define defaults for Portage specific to your needs. There are 4 basic profile types: arch, build, flavor, and mix-ins:

arch
typically x86-32bit or x86-64bit, this defines the processor type and support of your system. This is defined when your stage was built and should not be changed.
build
defines whether your system is a current, stable or experimental build. current systems will have newer packages unmasked than stable systems.
flavor
defines the general type of system, such as server or desktop, and will set default USE flags appropriate for your needs.
mix-ins
define various optional settings that you may be interested in enabling.

One arch, build and flavor must be set for each Funtoo Linux system, while mix-ins are optional and you can enable more than one if desired.

Remember that profiles can often be inherited. For example, the desktop flavor inherits the workstation flavor settings, which in turn inherits the X and audio mix-ins. You can view this by using eselect:

(chroot) # eselect profile show
Currently set profiles:
    arch: gentoo:funtoo/1.0/linux-gnu/arch/x86-64bit
   build: gentoo:funtoo/1.0/linux-gnu/build/current
  flavor: gentoo:funtoo/1.0/linux-gnu/flavor/desktop
 mix-ins: gentoo:funtoo/1.0/linux-gnu/mix-ins/kde

Automatically enabled profiles:
 mix-ins: gentoo:funtoo/1.0/linux-gnu/mix-ins/print
 mix-ins: gentoo:funtoo/1.0/linux-gnu/mix-ins/X
 mix-ins: gentoo:funtoo/1.0/linux-gnu/mix-ins/audio
 mix-ins: gentoo:funtoo/1.0/linux-gnu/mix-ins/dvd
 mix-ins: gentoo:funtoo/1.0/linux-gnu/mix-ins/media
 mix-ins: gentoo:funtoo/1.0/linux-gnu/mix-ins/console-extras


To view installed profiles:

(chroot) # eselect profile list

To change the profile flavor:

(chroot) # eselect profile set-flavor 7

To add a mix-in:

(chroot) # eselect profile add 10

Configuring and installing the Linux kernel

Now it's time to build and install a Linux kernel, which is the heart of any Funtoo Linux system. In the past, the process of creating a kernel that actually booted your system could be time-consuming and require a great deal of trial and error. Fortunately, Funtoo Linux offers an option to automatically build a kernel for you that will boot nearly all systems.

If you are unfamiliar with how to manually configure your own kernel, or you simply want to get your system up and running quickly, you can emerge debian-sources with the binary USE flag set, which will automatically build the kernel and an initrd that will boot nearly all Funtoo Linux systems. This kernel is based on a linux-3.2 LTS official debian kernel package and is an easy way to get your system up and running relatively quickly.

Click here for a list of all architectures the Debian kernel supports.

   Important

debian-sources with binary USE flag requires at least 12GB in /var/tmp

(chroot) # echo "sys-kernel/debian-sources binary" >> /etc/portage/package.use
(chroot) # emerge debian-sources

All done!

   Note

NVIDIA card users: the binary USE flag installs the Nouveau drivers which cannot be loaded at the same time as the proprietary drivers, and cannot be unloaded at runtime because of KMS. You need to blacklist it under /etc/modprobe.d/.

   Note

For an overview of other kernel options for Funtoo Linux, see Funtoo Linux Kernels. There maybe modules that the Debian kernel doesn't include, a situation where genkernel would be useful. Also be sure to see hardware compatibility information. We have compiled a very good reference for Dell PowerEdge 11G Servers that includes kernel compatibility information as well..


The next step is to configure your boot loader so that your new kernel loads when the system boots.

Installing a Bootloader

Installing Grub

The boot loader is responsible for loading the kernel from disk when your computer boots. For new installations, GRUB 2 and Funtoo's boot-update tool should be used as a boot loader. GRUB supports both GPT/GUID and legacy MBR partitioning schemes.

To use this recommended boot method, first emerge boot-update. This will also cause grub-2 to be merged, since it is a dependency of boot-update.

(chroot) # emerge boot-update

Then, edit /etc/boot.conf and specify "Funtoo Linux genkernel" as the default setting at the top of the file, replacing "Funtoo Linux".

/etc/boot.conf should now look like this:

boot {
        generate grub
        default "Funtoo Linux genkernel"
        timeout 3 
}

"Funtoo Linux" {
        kernel bzImage[-v]
        # params += nomodeset
}

"Funtoo Linux genkernel" {
        kernel kernel[-v]
        initrd initramfs[-v]
        params += real_root=auto 
        # params += nomodeset
} 

Please read man boot.conf for further details.

Running grub-install and boot-update

Finally, we will need to actually install the GRUB boot loader to your disk, and also run boot-update which will generate your boot loader configuration file:

(chroot) # grub-install --no-floppy /dev/sda
(chroot) # boot-update

You only need to run grub-install when you first install Funtoo Linux, but you need to re-run boot-update every time you modify your /etc/boot.conf file, so your changes are applied on next boot.

OK - your system should be ready to boot! Well, there are a few more loose ends...

Installing Syslinux/Extlinux

An alternate Bootloader is Extlinux, for installing it see the extlinux Guide.

Configuring your network

It's important to ensure that you will be able to connect to your local-area network after you reboot into Funtoo Linux. There are three approaches you can use for configuring your network: NetworkManager, dhcpcd, and the Funtoo Linux Networking scripts. Here's how to choose which one to use based on the type of network you want to set up.

Wi-Fi

For laptop/mobile systems where you will be using Wi-Fi and connecting to various networks, NetworkManager is strongly recommended. The Funtoo version of NetworkManager is fully functional even from the command-line, so you can use it even without X or without the Network Manager applet. Here are the steps involved in setting up NetworkManager:

root # emerge linux-firmware
root # emerge networkmanager
root # rc-update add NetworkManager default

Above, we installed linux-firmware which contains a complete collection of available firmware for many hardware devices including Wi-Fi adapters, plus NetworkManager to manage our network connection. Then we added NetworkManager to the default runlevel so it will start when Funtoo Linux boots.

After you reboot into Funtoo Linux, you will be able to add a Wi-Fi connection this way:

root # addwifi -S wpa -K 'wifipassword' mywifinetwork

The addwifi command is used to configure and connect to a WPA/WPA2 Wi-Fi network named mywifinetwork with the password wifipassword. This network configuration entry is stored in /etc/NetworkManager/system-connections so that it will be remembered in the future. You should only need to enter this command once for each Wi-Fi network you connect to.

Desktop (Wired Ethernet)

For a home desktop or workstation with wired Ethernet that will use DHCP, the simplest and most effective option to enable network connectivity is to simply add dhcpcd to the default runlevel:

root # rc-update add dhcpcd default

When you reboot, dhcpcd will run in the background and manage all network interfaces and use DHCP to acquire network addresses from a DHCP server.

Server (Static IP)

For servers, the Funtoo Linux Networking scripts are recommended. They are optimized for static configurations and things like virtual ethernet bridging for virtualization setups. See Funtoo Linux Networking for information on how to use Funtoo Linux's template-based network configuration system.

Finishing Steps

Set your root password

It's imperative that you set your root password before rebooting so that you can log in.

(chroot) # passwd

Restart your system

Now is the time to leave chroot, to unmount Funtoo Linux partitions and files and to restart your computer. When you restart, the GRUB boot loader will start, load the Linux kernel and initramfs, and your system will begin booting.

Leave the chroot, change directory to /, unmount your Funtoo partitions, and reboot.

(chroot) # exit
root # cd /
root # umount -l /mnt/funtoo/boot /mnt/funtoo/dev /mnt/funtoo/proc /mnt/funtoo
root # reboot

You should now see your system reboot, the GRUB boot loader appear for a few seconds, and then see the Linux kernel and initramfs loading. After this, you should see Funtoo Linux itself start to boot, and you should be greeted with a login: prompt. Funtoo Linux has been successfully installed!

Next Steps

If you have not used Portage before, then be sure to check out our quick introduction to Emerge.

To learn how to customize and start using Funtoo Linux, see Funtoo Linux First Steps.

If your system did not boot correctly, see Installation Troubleshooting for steps you can take to resolve the problem.