summaryrefslogtreecommitdiff
path: root/src/install/1_begin.xml
blob: d3d78a80879a6cfbb7e4e5d55e83d49d63b3175c (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
<?xml version="1.0" encoding="utf-8"?>
<chapter label="1" id="begin">
    <title>Before You Begin</title>
    <para>Welcome to the Adélie Linux 1.0 Installation Handbook.
        This Handbook describes the process of installing Adélie Linux on your computer.</para>
    <para>If you are installing Adélie Linux on your main computer, you may use another device - such as a mobile phone or a friend's laptop, if available - to reference this Handbook.
        Additionally, most of the contents of this Handbook are available for reading during the installation process.
        Simply choose "Help", or press the <keycap>F1</keycap> key, from any System Installation screen.</para>
    <section>
        <title>Preparing for Installation</title>
        <para>Please back up all of your data before beginning installation.
            While every effort has been made to ensure that the Adélie Linux installation system is safe and error-free, we cannot guarantee that your data will be preserved once you start the installation.
            If you intend on dual-booting your computer with another operating system, such as Mac OS X or Windows, ensure there is adequate disk space available to install Adélie Linux.
            You will need up to 2 GB for a standard desktop installation, or at least 300 MB for a server installation.</para>
        <para>To install Adélie Linux on a desktop or portable computer, you will need a graphical display capable of at least an 800x600 pixel resolution.
            Most displays support this resolution.
            HiDPI (or "Retina") displays are supported only on the Desktop installation media.
            Please note that the server installation media may render incorrectly, or even not at all, when using HiDPI displays.
            You may install server packages using the Desktop installation media if you need to use a HiDPI display during server installation.</para>
        <para>To install Adélie Linux to a server, you will need either a display capable of at least 80x25 text console (720x480), or a supported serial line.
            If you are installing via serial line, be sure to have your server's serial line settings available.
            Most servers default to either 9600 or 115200 baud; Adélie Linux does not reconfigure the serial line, so you will need to know your firmware's default settings.</para>
        <para>If you plan on connecting to the Internet directly from your Adélie Linux computer without using a router (not common),
            ensure you have your Internet access credentials (typically a username and password) available before starting installation.
            Adélie Linux supports connecting to most ADSL providers using PPPoE; and most other Internet providers using Ethernet or Wi-Fi.
            If you use a static IP address (not common), make sure you have your IP address, subnet, default gateway, and nameserver settings before starting installation.</para>
        <para>If your computer came with recovery media, we recommend that you have it available in the very unlikely event you have an issue using the Adélie Linux system, or if your hardware is incompatible.
            Having your recovery media will allow you to quickly restore your computer to its original state.</para>
    </section>
    <section id="media">
        <title>Creating the installation media</title>
        <para>You will need either:</para>
        <itemizedlist>
            <listitem><para>a <hardware>CD drive</hardware> capable of writing (or "burning") a CD, and a blank CD; or</para></listitem>
            <listitem><para>a blank <hardware>USB flash drive</hardware>.</para></listitem>
        </itemizedlist>
        <para>Download the installation media file from <ulink url="https://www.adelielinux.org/download">https://wwww.adelielinux.org/download</ulink>.
            Follow the instructions to choose the media file appropriate for your computer.
            Then, follow the steps below for your current operating environment.</para>
        <section>
            <title>Using Windows</title>
            <para>TODO</para>
        </section>
        <section>
            <title>Using Mac OS X</title>
            <para>TODO</para>
        </section>
        <section>
            <title>Using Linux or BSD</title>
            <para>On Linux or BSD systems, you can use either <command>cdrecord</command> or <command>cdrskin</command> to write the installation image to a CD via the command line.
                Both commands share a similar syntax.</para>
            <para>For example, to burn the image onto a CD at a speed of 4x and with verbose command output, run
                <command>cdrecord -v speed=4 <userinput>[image]</userinput></command>
                or
                <command>cdrskin -v speed=4 <userinput>[image]</userinput></command>,
                replacing <userinput>[image]</userinput> with the file name of the image you want to burn to the CD.</para>
            <para>If there is only one optical disc drive on your system, it should be auto-detected.
                If you have more than one optical disc drive, find the device name using <command>dmesg</command> or <command>lsblk</command>, and specify it with the <varname>dev</varname> option.
                For example, if your optical device is named <literal>/dev/sr0</literal>, run
                <command>cdrecord -v dev=/dev/sr0 speed=4 <userinput>[image]</userinput></command>.</para>
            <para>To write an installation image to a USB flash drive, you may use the <command>dd</command> command.
                You will need to identify the name of the target USB device.
                This can be done by examining the output of the <command>dmesg</command> command, or a program that lists available storage devices (such as <command>lsblk</command> on Linux), before and after connecting the drive to the computer.</para>
            <para>You should always ensure that you have identified the correct USB device name.  Ensure you are using the name of the whole drive (such as <literal>/dev/sde</literal>) and not a partition residing on it (such as <literal>/dev/sde1</literal>).</para>
            <para>Ensure the device is not mounted before running the <command>dd</command> command.  Please note that running the <command>dd</command> command may require superuser privileges.</para>
            <para>Beware that this operation will <emphasis>destroy all data</emphasis> on the target device!</para>
            <para><command>dd if=<userinput>adelie.iso</userinput> of=<userinput>/dev/sdX</userinput> bs=4M &amp;&amp; sync</command></para>
            <para>Replace <literal><userinput>adelie.iso</userinput></literal> with the file name of the image you want to write to the USB media, and <literal><userinput>/dev/sdX</userinput></literal> with the name of the target USB device.   Running the <command>sync</command> command after the <command>dd</command> command ensures that all data has been written to the USB media.</para>
        </section>
    </section>
</chapter>