diff options
author | Chloe Kudryavtsev <toast@toastin.space> | 2019-03-07 15:32:40 -0500 |
---|---|---|
committer | Chloe Kudryavtsev <toast@toastin.space> | 2019-03-07 15:32:40 -0500 |
commit | 689210145bab6fcbb56f20bb3f0c907621949136 (patch) | |
tree | a88f390d56d90b97103ab3052e656eac84c13c39 /modules/Installing | |
parent | 32e304f01e33fe93d117d3ae9aa82e37f9138582 (diff) | |
download | user-handbook-689210145bab6fcbb56f20bb3f0c907621949136.tar.bz2 user-handbook-689210145bab6fcbb56f20bb3f0c907621949136.tar.xz |
[Style] consistency pass
Diffstat (limited to 'modules/Installing')
-rw-r--r-- | modules/Installing/pages/manual.adoc | 41 | ||||
-rw-r--r-- | modules/Installing/pages/medium.adoc | 11 | ||||
-rw-r--r-- | modules/Installing/pages/setup_alpine.adoc | 5 |
3 files changed, 13 insertions, 44 deletions
diff --git a/modules/Installing/pages/manual.adoc b/modules/Installing/pages/manual.adoc index dcaca67..4617eaa 100644 --- a/modules/Installing/pages/manual.adoc +++ b/modules/Installing/pages/manual.adoc @@ -4,9 +4,8 @@ If you're here, it's because you want to install alpine semi-automatically, or b Either way, this section of the handbook describes, step by step, how to get a system up and running. In this section you will find the usage of the various `setup-*` utilities, as well as explanations as to what they do. -== Keyboard Layout // MAINT: kbd-bkeymaps, loadkmap, setup-keymap - +== Keyboard Layout Keyboard layout is controlled by the `loadkmap` service file. In `/etc/conf.d/loadkmap` a variable (`KEYMAP`) is defined. The file this variable points to is the keymap that will be loaded. @@ -27,9 +26,8 @@ setup-keymap us us <1> ---- <1> this will copy and use `/usr/share/bkeymaps/us/us.bmap.gz` -== Hostname // MAINT: setup-hostname - +== Hostname Your hostname is the name of your computer. It is important that hostnames on your local area network be unique. If you need recommendations as to what to make your hostname, you can refer to https://tools.ietf.org/html/rfc1178[RFC 1178]. @@ -59,15 +57,13 @@ For example, if you were to set your hostname to "alpine", with no particular do Now that you are done, you should apply the hostname using either `rc-service hostname restart` or `/etc/init.d/hostname restart`. -== Networking // TODO: rewrite this whole section, once wpa_cli etc is fixed - +== Networking Before you configure the rest of the system, you should set up networking. This will allow you, for instance, to fetch bootloaders, configure sshd (to continue this setup from the comfort of a different, graphically-enabled machine), and other such desirable features. -=== Configure Wireless Networking // MAINT: setup-interfaces - +=== Configure Wireless Networking If your system does not have an ethernet port (or connection) available, you will need to set up wireless connectivity. It is strongly recommended that you try to avoid this. @@ -86,7 +82,6 @@ You can find guides around various wireless networking management solutions (inc ==== === DHCP - In most cases, you will want to use DHCP. If you are on a professional network, or have a common home router, you very likely have it available. It is also very common on networks in general. @@ -99,7 +94,6 @@ In case this doesn't work (or you're on a wireless network), you may need to run In such a scenario, the script will ask you questions about your network topology, that you can answer. === Static IP - In some cases, your network will not have DHCP available. In that scenario, you will need to edit `/etc/network/interfaces` and `/etc/resolv.conf` on your own. If you ran `setup-interfaces`, it will have asked you if you want to do any manual editing of the network configuration. @@ -128,7 +122,6 @@ include::example$static.interfaces[] ---- === DNS - If you did not end up using DHCP, you will also need to set up DNS. This is done by editing the `/etc/resolv.conf` file. In most cases, you can use `1.1.1.1`, `8.8.8.8` or `9.9.9.9` as your DNS server. @@ -151,14 +144,12 @@ Feel free to leave the answer blank, as it is optional. ==== === Applying Configuration - Once all of the above is accounted for, you can now start the networking configuration. This is done by running `rc-service networking start`. If desired, you can also set it to load during boot, using `rc-update add networking boot`. -== Timezone // MAINT: musl/tzdata - +== Timezone Unless you live in the GMT timezone, you may be interested in having your device know where you (or it) is located, time-wise. On musl, the timezone is defined by the `TZ` environment variable, which should either mention a POSIX-style timezone, directly point at a file, or have a standard `Area/SubArea` definition, which must be found under `/usr/share/zoneinfo`, `/share/zoneinfo` or `/etc/zoneinfo`. @@ -198,7 +189,6 @@ This is a technical difference, that you likely do not need to worry about, but ==== == Repositories - If you want to be able to install packages, you're going to want to have some repositories. // MAINT: alpine images By default, your boot medium will come with a built-in repository that is on the boot medium itself. @@ -222,20 +212,16 @@ include::example$repositories.apk[] Assuming your network configuration is done, you may also use the `setup-apkrepos` utility, which will fetch a list of valid repositories, and give you a choice between them (and options such as "random"). == Root Password - At this point, you should set up a root password. This is easy to do - simply run `passwd` and follow the prompts. NOTE: You will not see your own typing - this is normal, it is obscured to stop people from being able to peek at your screen, even if just to see the number of characters in your passwords. -== SSH // MAINT: setup-sshd - -// MAINT: Alpine CD getting a default graphical interface / moving from getty +== SSH SSH is very convenient to have - it means you can be in the comfort of your terminal emulator, rather than a raw getty (the full-screen emulator that shows up when booting up an alpine install medium). Now that we have networking, we can set up an ssh daemon. -// MAINT: available sshd There are currently two primary secure shell daemons available - openssh and dropbear. The latter is more simple, but has its own (incompatible) key format, and can only be configured through command line arguments - as such, it is not recommended for beginners. You can install either one using `apk add name`, where name is either "dropbear" or "openssh" respectively. @@ -245,9 +231,8 @@ WARNING: By default, you cannot use SSH to log in as root using a password. Note that this can also be done for you by the `setup-sshd` utility - it will ask you which one you would like, install, start and enable it for you. -== NTP // MAINT: setup-ntp - +== NTP It may be useful to make sure that your clock is correct. This can be achieved by using an NTP daemon. Some of the common ones are `chronyd` and `openntpd`. @@ -264,9 +249,8 @@ As such, temporarily, it is recommended that you use the `setup-ntp` script and Note that this can also be done for you by the `setup-ntp` utility - it will ask you which one you would like, install, start and enable it for you. -== Partitioning Your Disk // MAINT: parted availability, fdisk, setup-disk - +== Partitioning Your Disk === `setup-disk` The `setup-disk` utility can do the rest of this work for you. @@ -287,8 +271,8 @@ However, in other cases, it is recommended that you at least consider doing this These are not covered in this handbook. ==== -==== Options and Settings // MAINT: setup-disk +==== Options and Settings `setup-disk` is configured through command line arguments, as well as environment variables. In most cases, if you want setup-disk to do all the work for you, you should not need to specify anything beyond `-m sys`, as in `setup-disk -m sys`. This is an incomplete listing - it lacks anything mentioning non-disk installations, as well as anything overly complex (such as automatic lvm/raid). @@ -317,7 +301,6 @@ Any missing information will be queried from you by `setup-disk`, so only change In the scenario where the bootloader installation causes problems, see the sections that follow. === Parted - :ex_3_sda3: Notice how the `3` in `/dev/sda3` comes from the fact that this is the 3rd partition we created (it also has the 3 in the number in the above planning table). Parted is GNU's PARTition EDitor. @@ -367,7 +350,6 @@ p mklabel msdos <2> <2> Parted supports both interactive and non-interactive commands. This is the equivalent to running `parted -a optimal /dev/sda`, then entering `mklabel msdos` into the prompt, or entering `mklabel` into the prompt, and answering `msdos` to the incoming question. The specifics as to how you perform the below are up to you. ==== BIOS + MS-DOS - Under a BIOS setup with an MS-DOS partition table, we can only have 4 primary partitions, and are limited to 2TB disks. Extended partitions are outside of the scope of this handbook. Under BIOS+MS-DOS, we can use the MBR for installing the bootloader, so we only need to worry about the actual data partitions. @@ -399,7 +381,6 @@ mkfs.ext4 /dev/sda3 <2> <2> {ex_3_sda3} ==== BIOS + GPT - Under a BIOS setup with a GPT partition table, we do not have an MBR, so we will need to create one. Here is an example of a partitioning scheme: @@ -432,7 +413,6 @@ mkfs.ext4 /dev/sda4 <2> {ex_3_sda3} ==== UEFI + GPT - Under a UEFI setup, you need to use GPT with an ESP partition. It must be FAT32 formatted, and can be used as your boot partition. Here is an example of a partitioning scheme: @@ -462,9 +442,8 @@ mkfs.ext4 /dev/sda3 <2> <1> This last section creates the filesystems. In this example, we use ext4 for `/boot` and `/` - you can use any of the supported filesystems. <2> {ex_3_sda3} -=== Finalizing // MAINT: setup-disk - +=== Finalizing Now that your filesystems are formatted, you have to mount them under a mountpoint (usually `/mnt`). "Mounting" a filesystem is like assigning a drive letter to a hard drive, but can be done under any directory. Here is an example of how you would mount the <<_uefi_gpt>> set under `/mnt`: diff --git a/modules/Installing/pages/medium.adoc b/modules/Installing/pages/medium.adoc index 5497567..3bcf692 100644 --- a/modules/Installing/pages/medium.adoc +++ b/modules/Installing/pages/medium.adoc @@ -2,7 +2,6 @@ :experimental: // TODO: make sure experimental is enabled on Antora == Available Options - === Architecture Computer hardware, and CPUs in particular, come in several different architectures. A very common consumer architecture is known as x86_64 - the traditional Intel x86 architecture with AMD's 64-bit extensions. @@ -18,8 +17,8 @@ s390x:: IBM Z-Systems and Mainframes // TODO: mention that aarch64 is supposed to support EFI Under some circumstances, you may also use armhf and aarch64 architectures - relevant to ARM chips, 32bit and 64bit respectively. -=== Image Type // MAINT: downloads page +=== Image Type Alpine offers a variety of downloadable https://alpinelinux.org/downloads/[images]. The image varieties relevant to this handbook are as follows: @@ -44,9 +43,8 @@ If you aren't sure what image to use, you should use extended, assuming your arc Otherwise, you should use the standard image. == Downloading - -=== Obtaining the Chosen Media // MAINT: downloads page +=== Obtaining the Chosen Media Image downloads are available at https://alpinelinux.org/downloads/[alpinelinux.org]. Press the button under your chosen image type, that corresponds to your target architecture. This will link to a direct download of your image. @@ -104,12 +102,10 @@ gpg --verify alpine.iso.asc alpine.iso ---- == Using the Image - A `.iso` file on its own is not very useful. You can either flash it to a usb stick, or burn it to a physical cd/dvd. === USB Drive - On Windows and MacOS hosts, it is most convenient to use a dedicated utility, such as https://www.balena.io/etcher/[Etcher]. See that project's documentation in case any further details are required. @@ -139,7 +135,6 @@ You can find more details on those in the dd manual page (`dd(1)`). ==== === Burning to a CD/DVD - Another way to utilize the `.iso` file is by burning it on a CD or DVD. This is also useful on older systems, that do not know how to boot from a USB drive. @@ -148,7 +143,6 @@ On MacOS, you can select the `.iso` file, and then press menu:File[Burn Disk Ima On Windows 8 and above, you can right-click the `.iso` file, and then press btn:[Burn Disk Image]. ==== [Linux] Burning an Image File - On Linux hosts, there are no default built-in tools to burn images. This handbook recommends using k3b - a graphical utility inside of which one can select menu:Tools[Burn CD Image]. @@ -163,7 +157,6 @@ cdrecord dev=/dev/sr0 alpine.iso <1> <1> This needs to be run as root, unless your user has write access to the output block device. == Booting - Once you have prepared your appropriate installation medium, you need to boot into the Alpine Linux live environment. During the bootup of your system, you should have the option to enter BIOS/UEFI settings, alongside what is often called "One Time Boot Override", or "Boot Selection". diff --git a/modules/Installing/pages/setup_alpine.adoc b/modules/Installing/pages/setup_alpine.adoc index 7fbd6e7..8740c83 100644 --- a/modules/Installing/pages/setup_alpine.adoc +++ b/modules/Installing/pages/setup_alpine.adoc @@ -1,5 +1,5 @@ -= `setup-alpine` // MAINT: this whole page, on alpine-conf += `setup-alpine` Now that you are booted in, you can log-in without a password as the root user. Alpine has a script called `setup-alpine`, which performs basic installation procedures. @@ -8,7 +8,6 @@ However, no script is perfect, so it is recommended that if your use-case is not For example, if you have no access to a wired network, you will need to configure xref:manual.adoc#_networking[Networking] yourself. == `setup-alpine -q` - The q, or "quick" mode of the `setup-alpine` script allows one to get a trivial system configuration running quickly, to then proceed with other installation tasks, possibly remotely. Under quick mode, `setup-alpine` will: @@ -40,7 +39,6 @@ The steps quick mode skips are, in order: - Configuring apk's caching mechanism == Full `setup-alpine` - `setup-alpine` in normal mode will do all of the abovementioned steps, under some conditions, and will rely much less on default values. It is recommended to use this mode directly if your scenario is trivial. @@ -54,7 +52,6 @@ If all of these apply, you can simply run `setup-alpine` and follow the prompts If they do not, it may still be appropriate, but you will need to customize its behavior with an answer file and/or environment variables. == Answer Files - You can preprogram various answers to `setup-alpine` 's questions. Here is the answer file it generates for you if you ask it to. |