aboutsummaryrefslogtreecommitdiffstats
path: root/modules/Installing/pages/manual.adoc
diff options
context:
space:
mode:
Diffstat (limited to 'modules/Installing/pages/manual.adoc')
-rw-r--r--modules/Installing/pages/manual.adoc40
1 files changed, 20 insertions, 20 deletions
diff --git a/modules/Installing/pages/manual.adoc b/modules/Installing/pages/manual.adoc
index 4617eaa..07afd8c 100644
--- a/modules/Installing/pages/manual.adoc
+++ b/modules/Installing/pages/manual.adoc
@@ -4,7 +4,7 @@ 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.
-// MAINT: kbd-bkeymaps, loadkmap, setup-keymap
+// COMBAK: 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.
@@ -26,7 +26,7 @@ setup-keymap us us <1>
----
<1> this will copy and use `/usr/share/bkeymaps/us/us.bmap.gz`
-// MAINT: setup-hostname
+// COMBAK: setup-hostname
== Hostname
Your hostname is the name of your computer.
It is important that hostnames on your local area network be unique.
@@ -62,7 +62,7 @@ Now that you are done, you should apply the hostname using either `rc-service ho
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.
-// MAINT: setup-interfaces
+// COMBAK: 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.
@@ -72,7 +72,7 @@ However, in the scenario that you have no choice, before you can configure the n
To do so, it is recommended that you use the `setup-interfaces` utility.
In it, you should select your wireless interface when prompted (it will usually be called something like `wlan0`) and answer the questions (for more details on that, see the next section).
-// MAINT: setup-interfaces running wpa_supplicant by hand
+// COMBAK: setup-interfaces running wpa_supplicant by hand
[CAUTION]
====
This will *not* persist across a reboot.
@@ -148,7 +148,7 @@ Once all of the above is accounted for, you can now start the networking configu
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`.
-// MAINT: musl/tzdata
+// COMBAK: 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`.
@@ -167,7 +167,7 @@ install -Dm 0644 /usr/share/zoneinfo/America/New_York /etc/zoneinfo/America/New_
----
// TODO: alpine seems to have relics from uclibc, things like /etc/TZ, and the lack of $TZ
-// MAINT: environment variable handling
+// COMBAK: environment variable handling
Finally, you will need to add the TZ environment variable to your system.
You can do this by running the following, with the same timezone example:
@@ -180,7 +180,7 @@ echo "export TZ='$TZ'" >> /etc/profile.d/timezone.sh
Alternatively, you may use `setup-timezone`, which will copy the file over for you.
-// MAINT: setup-timezone, baselayout
+// COMBAK: setup-timezone, baselayout
[WARNING]
====
`setup-timezone`, as it is now, will *not* set up the `TZ` environment variable.
@@ -190,17 +190,17 @@ 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
+// COMBAK: alpine images
By default, your boot medium will come with a built-in repository that is on the boot medium itself.
However, now that you have networking, you may wish to install packages outside the relatively small pool available on the boot medium.
Repositories for the package manager (`apk`) are configured in a file named `/etc/apk/repositories`, and valid signing keys are located under `/etc/apk/keys/`.
Your boot medium should come with valid pre-configured keys, but no external repositories.
-// MAINT: mirrors
+// COMBAK: mirrors
Currently, you can see the list of available mirrors and their status over at https://mirrors.alpinelinux.org/[mirrors.alpinelinux.org].
NOTE: Do not worry about the lack of "https" in the mirrors - all packages are signed, so as long as you do not add any untrustworthy keys, your package manager will refuse to install any illegitimate packages.
-// MAINT: release, "default" repositories
+// COMBAK: release, "default" repositories
Here is an example `/etc/apk/repositories` file, that uses all stable repositories from the primary mirror of the latest release version:
[source]
@@ -208,7 +208,7 @@ Here is an example `/etc/apk/repositories` file, that uses all stable repositori
include::example$repositories.apk[]
----
-// MAINT: setup-apkrepos
+// COMBAK: setup-apkrepos
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
@@ -217,7 +217,7 @@ 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.
-// MAINT: setup-sshd
+// COMBAK: setup-sshd
== 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.
@@ -231,7 +231,7 @@ 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.
-// MAINT: setup-ntp
+// COMBAK: setup-ntp
== NTP
It may be useful to make sure that your clock is correct.
This can be achieved by using an NTP daemon.
@@ -239,7 +239,7 @@ Some of the common ones are `chronyd` and `openntpd`.
You can install them by using `apk add name`, where name is the desired daemon.
After that, you may want to start it, and possibly enable it - using `rc-service name start` and `rc-update add name` respectively.
-// MAINT: chronyd PID file bug
+// COMBAK: chronyd PID file bug
[WARNING]
====
Currently, `chronyd` is bugged.
@@ -249,7 +249,7 @@ 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.
-// MAINT: parted availability, fdisk, setup-disk
+// COMBAK: parted availability, fdisk, setup-disk
== Partitioning Your Disk
=== `setup-disk`
@@ -257,7 +257,7 @@ The `setup-disk` utility can do the rest of this work for you.
It will make a partition table on your hard drive, partition it as per a specification, format the partitions with filesystems, set up the base system, and install the bootloader.
This section describes how to use it, as well as the various tweakables.
-// MAINT: setup-disk stability
+// COMBAK: setup-disk stability
[CAUTION]
====
As it is currently, setup-disk should work for typical single-disk non-UEFI setups.
@@ -271,7 +271,7 @@ However, in other cases, it is recommended that you at least consider doing this
These are not covered in this handbook.
====
-// MAINT: setup-disk
+// COMBAK: 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`.
@@ -279,7 +279,7 @@ This is an incomplete listing - it lacks anything mentioning non-disk installati
// TODO: add xref to setup-disk manual, developer handbook page on it
If you need those, head over to the manual or developer pages.
-// MAINT: setup-disk defaults and allowed values
+// COMBAK: setup-disk defaults and allowed values
.Environment Variables:
BOOTFS:: The filesystem to use on `/boot`, defaults to ext4, also allows ext2, ext3, (flat) btrfs, xfs and vfat (required on UEFI).
BOOTLOADER:: Bootloader to use. Defaults to syslinux, but also allows using grub, unless UEFI is used, in which case grub is required.
@@ -309,7 +309,7 @@ Because of this, that is the utility we will be using in this section.
Begin by installing it, using `apk add parted`.
This is also the part of the handbook in which you must determine whether you need (or want) to use UEFI.
-// MAINT: /sys/firmware/efi
+// COMBAK: /sys/firmware/efi
This decision will be left up to you, but you can determine whether or not you are currently booted using UEFI by checking if the `/sys/firmware/efi` folder exists.
In case this is difficult, you may use the following snippet to get a direct answer:
@@ -442,7 +442,7 @@ 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}
-// MAINT: setup-disk
+// COMBAK: 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.