summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLudovic Courtès <ludo@gnu.org>2019-03-13 21:57:14 +0100
committerLudovic Courtès <ludo@gnu.org>2019-03-13 23:12:43 +0100
commite1c15e8b8e25e14c253ff1212e289565736f6ea7 (patch)
treeb1485078cf13ecf92d24c9d5b5d641457796639f
parent82f29e5b4f91f716755834c5cf7d08dae9852d8d (diff)
doc: Document the graphical installer some more.
* doc/guix.texi (Preparing for Installation): Rewrite to specify the two installation modes. (Guided Graphical Installation): New node. (Manual Installation): New node, with the former sections. (After System Installation): New node. * doc/images/installer-network.png, doc/images/installer-partitions.png, doc/images/installer-resume.png: New files. * doc/local.mk (dist_infoimage_DATA): Add them.
-rw-r--r--doc/guix.texi121
-rw-r--r--doc/images/installer-network.pngbin0 -> 24342 bytes
-rw-r--r--doc/images/installer-partitions.pngbin0 -> 55847 bytes
-rw-r--r--doc/images/installer-resume.pngbin0 -> 35829 bytes
-rw-r--r--doc/local.mk7
5 files changed, 98 insertions, 30 deletions
diff --git a/doc/guix.texi b/doc/guix.texi
index 1b2ef37367b..043aad1b655 100644
--- a/doc/guix.texi
+++ b/doc/guix.texi
@@ -165,10 +165,17 @@ System Installation
165* Hardware Considerations:: Supported hardware. 165* Hardware Considerations:: Supported hardware.
166* USB Stick and DVD Installation:: Preparing the installation medium. 166* USB Stick and DVD Installation:: Preparing the installation medium.
167* Preparing for Installation:: Networking, partitioning, etc. 167* Preparing for Installation:: Networking, partitioning, etc.
168* Proceeding with the Installation:: The real thing. 168* Guided Graphical Installation:: Easy graphical installation.
169* Manual Installation:: Manual installation for wizards.
170* After System Installation:: When installation succeeded.
169* Installing Guix in a VM:: Guix System playground. 171* Installing Guix in a VM:: Guix System playground.
170* Building the Installation Image:: How this comes to be. 172* Building the Installation Image:: How this comes to be.
171 173
174Manual Installation
175
176* Keyboard Layout and Networking and Partitioning:: Initial setup.
177* Proceeding with the Installation:: Installing.
178
172Package Management 179Package Management
173 180
174* Features:: How Guix will make your life brighter. 181* Features:: How Guix will make your life brighter.
@@ -1777,7 +1784,9 @@ available.
1777* Hardware Considerations:: Supported hardware. 1784* Hardware Considerations:: Supported hardware.
1778* USB Stick and DVD Installation:: Preparing the installation medium. 1785* USB Stick and DVD Installation:: Preparing the installation medium.
1779* Preparing for Installation:: Networking, partitioning, etc. 1786* Preparing for Installation:: Networking, partitioning, etc.
1780* Proceeding with the Installation:: The real thing. 1787* Guided Graphical Installation:: Easy graphical installation.
1788* Manual Installation:: Manual installation for wizards.
1789* After System Installation:: When installation succeeded.
1781* Installing Guix in a VM:: Guix System playground. 1790* Installing Guix in a VM:: Guix System playground.
1782* Building the Installation Image:: How this comes to be. 1791* Building the Installation Image:: How this comes to be.
1783@end menu 1792@end menu
@@ -1963,21 +1972,19 @@ Guix System in a virtual machine (VM).
1963@node Preparing for Installation 1972@node Preparing for Installation
1964@section Preparing for Installation 1973@section Preparing for Installation
1965 1974
1966Once you have successfully booted your computer using the installation medium, 1975Once you have booted, you can use the guided graphical installer, which makes
1967you should end up with the welcome page of the graphical installer. The 1976it easy to get started (@pxref{Guided Graphical Installation}). Alternately,
1968graphical installer is a text-based user interface built upon the newt 1977if you are already familiar with GNU/Linux and if you want more control than
1969library. It shall guide you through all the different steps needed to install 1978what the graphical installer provides, you can choose the ``manual''
1970GNU@tie{}Guix System. However, as the graphical installer is still under heavy 1979installation process (@pxref{Manual Installation}).
1971development, you might want to fallback to the original, shell based install
1972process, by switching to TTYs 3 to 6 with the shortcuts CTRL-ALT-F[3-6]. The
1973following sections describe the installation procedure assuming you're using
1974one of those TTYs. They are configured and can be used to run commands as
1975root.
1976 1980
1977TTY2 shows this documentation, browsable using the Info reader commands 1981The graphical installer is available on TTY1. You can obtain root shells on
1978(@pxref{Top,,, info-stnd, Stand-alone GNU Info}). The installation system 1982TTYs 3 to 6 by hitting @kbd{ctrl-alt-f3}, @kbd{ctrl-alt-f4}, etc. TTY2 shows
1979runs the GPM mouse daemon, which allows you to select text with the left mouse 1983this documentation and you can reach it with @kbd{ctrl-alt-f2}. Documentation
1980button and to paste it with the middle button. 1984is browsable using the Info reader commands (@pxref{Top,,, info-stnd,
1985Stand-alone GNU Info}). The installation system runs the GPM mouse daemon,
1986which allows you to select text with the left mouse button and to paste it
1987with the middle button.
1981 1988
1982@quotation Note 1989@quotation Note
1983Installation requires access to the Internet so that any missing 1990Installation requires access to the Internet so that any missing
@@ -1985,12 +1992,65 @@ dependencies of your system configuration can be downloaded. See the
1985``Networking'' section below. 1992``Networking'' section below.
1986@end quotation 1993@end quotation
1987 1994
1988The installation system includes many common tools needed for this task. 1995@node Guided Graphical Installation
1989But it is also a full-blown Guix System, which means that you can 1996@section Guided Graphical Installation
1990install additional packages, should you need it, using @command{guix 1997
1991package} (@pxref{Invoking guix package}). 1998The graphical installer is a text-based user interface. It will guide you,
1999with dialog boxes, through the steps needed to install GNU@tie{}Guix System.
2000
2001The first dialog boxes allow you to set up the system as you use it during the
2002installation: you can choose the language, keyboard layout, and set up
2003networking, which will be used during the installation. The image below shows
2004the networking dialog.
2005
2006@image{images/installer-network,5in,, networking setup with the graphical installer}
2007
2008Later steps allow you to partition your hard disk, as shown in the image
2009below, to choose whether or not to use encrypted file systems, to enter the
2010host name and root password, and to create an additional account, among other
2011things.
2012
2013@image{images/installer-partitions,5in,, partitioning with the graphical installer}
2014
2015Note that, at any time, the installer allows you to exit the current
2016installation step and resume at a previous step, as show in the image below.
2017
2018@image{images/installer-resume,5in,, resuming the installation process}
2019
2020Once you're done, the installer produces an operating system configuration and
2021displays it (@pxref{Using the Configuration System}). At that point you can
2022hit ``OK'' and installation will proceed. On success, you can reboot into the
2023new system and enjoy. @xref{After System Installation}, for what's next!
2024
1992 2025
1993@subsection Keyboard Layout 2026@node Manual Installation
2027@section Manual Installation
2028
2029This section describes how you would ``manually'' install GNU@tie{}Guix System
2030on your machine. This option requires familiarity with GNU/Linux, with the
2031shell, and with common administration tools. If you think this is not for
2032you, consider using the guided graphical installer (@pxref{Guided Graphical
2033Installation}).
2034
2035The installation system provides root shells on TTYs 3 to 6; press
2036@kbd{ctrl-alt-f3}, @kbd{ctrl-alt-f4}, and so on to reach them. It includes
2037many common tools needed to install the system. But it is also a full-blown
2038Guix System, which means that you can install additional packages, should you
2039need it, using @command{guix package} (@pxref{Invoking guix package}).
2040
2041@menu
2042* Keyboard Layout and Networking and Partitioning:: Initial setup.
2043* Proceeding with the Installation:: Installing.
2044@end menu
2045
2046@node Keyboard Layout and Networking and Partitioning
2047@subsection Keyboard Layout, Networking, and Partitioning
2048
2049Before you can install the system, you may want to adjust the keyboard layout,
2050set up networking, and partition your target hard disk. This section will
2051guide you through this.
2052
2053@subsubsection Keyboard Layout
1994 2054
1995@cindex keyboard layout 2055@cindex keyboard layout
1996The installation image uses the US qwerty keyboard layout. If you want 2056The installation image uses the US qwerty keyboard layout. If you want
@@ -2005,7 +2065,7 @@ See the files under @file{/run/current-system/profile/share/keymaps} for
2005a list of available keyboard layouts. Run @command{man loadkeys} for 2065a list of available keyboard layouts. Run @command{man loadkeys} for
2006more information. 2066more information.
2007 2067
2008@subsection Networking 2068@subsubsection Networking
2009 2069
2010Run the following command to see what your network interfaces are called: 2070Run the following command to see what your network interfaces are called:
2011 2071
@@ -2098,7 +2158,7 @@ herd start ssh-daemon
2098Make sure to either set a password with @command{passwd}, or configure 2158Make sure to either set a password with @command{passwd}, or configure
2099OpenSSH public key authentication before logging in. 2159OpenSSH public key authentication before logging in.
2100 2160
2101@subsection Disk Partitioning 2161@subsubsection Disk Partitioning
2102 2162
2103Unless this has already been done, the next step is to partition, and 2163Unless this has already been done, the next step is to partition, and
2104then format the target partition(s). 2164then format the target partition(s).
@@ -2219,7 +2279,7 @@ file in its file system as described above, then the encryption also
2219protects the swap file, just like any other file in that file system. 2279protects the swap file, just like any other file in that file system.
2220 2280
2221@node Proceeding with the Installation 2281@node Proceeding with the Installation
2222@section Proceeding with the Installation 2282@subsection Proceeding with the Installation
2223 2283
2224With the target partitions ready and the target root mounted on 2284With the target partitions ready and the target root mounted on
2225@file{/mnt}, we're ready to go. First, run: 2285@file{/mnt}, we're ready to go. First, run:
@@ -2303,9 +2363,14 @@ in the new system is initially empty; other users' passwords need to be
2303initialized by running the @command{passwd} command as @code{root}, 2363initialized by running the @command{passwd} command as @code{root},
2304unless your configuration specifies otherwise 2364unless your configuration specifies otherwise
2305(@pxref{user-account-password, user account passwords}). 2365(@pxref{user-account-password, user account passwords}).
2366@xref{After System Installation}, for what's next!
2367
2306 2368
2307@cindex upgrading Guix System 2369@node After System Installation
2308From then on, you can update the system whenever you want by running, say: 2370@section After System Installation
2371
2372Success, you've now booted into Guix System! From then on, you can update the
2373system whenever you want by running, say:
2309 2374
2310@example 2375@example
2311guix pull 2376guix pull
@@ -2326,8 +2391,8 @@ explicitly run root's @command{guix}, type @command{sudo -i guix @dots{}}.
2326@end quotation 2391@end quotation
2327 2392
2328Join us on @code{#guix} on the Freenode IRC network or on 2393Join us on @code{#guix} on the Freenode IRC network or on
2329@email{guix-devel@@gnu.org} to share your experience---good or not so 2394@email{guix-devel@@gnu.org} to share your experience!
2330good. 2395
2331 2396
2332@node Installing Guix in a VM 2397@node Installing Guix in a VM
2333@section Installing Guix in a Virtual Machine 2398@section Installing Guix in a Virtual Machine
diff --git a/doc/images/installer-network.png b/doc/images/installer-network.png
new file mode 100644
index 00000000000..bd72f7f3411
--- /dev/null
+++ b/doc/images/installer-network.png
Binary files differ
diff --git a/doc/images/installer-partitions.png b/doc/images/installer-partitions.png
new file mode 100644
index 00000000000..2632e9a209e
--- /dev/null
+++ b/doc/images/installer-partitions.png
Binary files differ
diff --git a/doc/images/installer-resume.png b/doc/images/installer-resume.png
new file mode 100644
index 00000000000..db10169080c
--- /dev/null
+++ b/doc/images/installer-resume.png
Binary files differ
diff --git a/doc/local.mk b/doc/local.mk
index adb7b5102d6..18115fb295e 100644
--- a/doc/local.mk
+++ b/doc/local.mk
@@ -1,6 +1,6 @@
1# GNU Guix --- Functional package management for GNU 1# GNU Guix --- Functional package management for GNU
2# Copyright © 2016 Eric Bavier <bavier@member.fsf.org> 2# Copyright © 2016 Eric Bavier <bavier@member.fsf.org>
3# Copyright © 2012, 2013, 2014, 2015, 2016, 2017, 2018 Ludovic Courtès <ludo@gnu.org> 3# Copyright © 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019 Ludovic Courtès <ludo@gnu.org>
4# Copyright © 2013 Andreas Enge <andreas@enge.fr> 4# Copyright © 2013 Andreas Enge <andreas@enge.fr>
5# Copyright © 2016 Taylan Ulrich Bayırlı/Kammer <taylanbayirli@gmail.com> 5# Copyright © 2016 Taylan Ulrich Bayırlı/Kammer <taylanbayirli@gmail.com>
6# Copyright © 2016, 2018 Mathieu Lirzin <mthl@gnu.org> 6# Copyright © 2016, 2018 Mathieu Lirzin <mthl@gnu.org>
@@ -111,7 +111,10 @@ $(srcdir)/%D%/contributing.%.texi: po/doc/guix-manual.%.po
111infoimagedir = $(infodir)/images 111infoimagedir = $(infodir)/images
112dist_infoimage_DATA = \ 112dist_infoimage_DATA = \
113 $(DOT_FILES:%.dot=%.png) \ 113 $(DOT_FILES:%.dot=%.png) \
114 %D%/images/coreutils-size-map.png 114 %D%/images/coreutils-size-map.png \
115 %D%/images/installer-network.png \
116 %D%/images/installer-partitions.png \
117 %D%/images/installer-resume.png
115 118
116# Try hard to obtain an image size and aspect that's reasonable for inclusion 119# Try hard to obtain an image size and aspect that's reasonable for inclusion
117# in an Info or PDF document. 120# in an Info or PDF document.