aboutsummaryrefslogtreecommitdiffstats
path: root/modules/Installing/pages/setup_alpine.adoc
blob: 9c929b6c9db67427c20ef87b48e110c8efd4dda1 (plain)
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
// COMBAK: 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.
This section of the handbook describes its operation modes, as well as how to use it.
However, no script is perfect, so it is recommended that if your use-case is not so simple, or you run into issues using it, to proceed to the xref:manual.adoc[next section] which covers manual setup.
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:

- Setup your xref:manual.adoc#_keyboard_layout[Keyboard Layout]
- Initialize your xref:manual.adoc#_hostname[Hostname] to the default "alpine" value
- Set your primary (autodetected) interface to use xref:manual.adoc#_dhcp[DHCP], and start networking
- Enable various relevant system services, and start them
- Generate a valid `/etc/hosts` file
- Enable the default xref:manual.adoc#_repositories[repository]

[WARNING]
====
`setup-alpine`'s networking set-up will *not* work by itself for wifi.
If you have no access to an ethernet port and cable, refer to the section on xref:manual.adoc#_networking[configuring networking manually].
====

Quick mode is useful to get a system online and operational very quickly (thus the name) to then go on to use it manually.

The steps quick mode skips are, in order:

- Setting a xref:manual.adoc#_root_password[root password]
- Setting the xref:manual.adoc#_timezone[timezone]
- Setting up an optional proxy
- Enabling xref:manual.adoc#_ssh[SSH]
- Enabling xref:manual.adoc#_ntp[NTP] synchronization
- Configuring the xref:manual.adoc#_setup_disk[disk], if any
- Configuring lbu
- 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.
A trivial scenario is defined as such:

- You have a single (currently) physical disk and you want to install to it
- Your primary network connection is wired, and it is DHCP-compatible
- You do not significantly care about what bootloader or filesystem you use

If all of these apply, you can simply run `setup-alpine` and follow the prompts to set up your system.
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.

// EDITOR NOTE: this include will only show up in Antora
[source,sh]
----
include::example$setup_example.sh[]
----

You can also add extra environment variables to configure the behavior of any given utility.
// TODO: link developer handbook section on setup-alpine
For more details on those, see the xref:manual.adoc[next section] of the user handbook, or the developer handbook on the technical details of those utilities.