https://wiki.alpinelinux.org/w/api.php?action=feedcontributions&feedformat=atom&user=Dju92Alpine Linux - User contributions [en]2026-05-05T13:26:24ZUser contributionsMediaWiki 1.40.0https://wiki.alpinelinux.org/w/index.php?title=Talk:ZFS&diff=26715Talk:ZFS2024-05-13T17:45:15Z<p>Dju92: </p>
<hr />
<div>== Autotrim ==<br />
<br />
In the [[ZFS_scrub_and_trim#Definition_2|Definition]] section:<br><br />
"A manual on-demand TRIM operation can be initiated irrespective of the autotrim pool property setting. See the <b>documentation</b> for the autotrim property <b>above</b> for the types of vdev devices which can be trimmed."<br />
<br />
The documentation needs to be linked to. It's not above. 🤔<br><br />
Thanks, &ndash;[[User:zcrayfish|zcrayfish]] <small>([[User talk:zcrayfish|talk]]•[[Special:Contributions/zcrayfish|contribs]]•[[Special:EmailUser/zcrayfish|send email]])</small> 01:17, 12 May 2024 (UTC)<br />
<br><br />
-----<br />
Indeed, nice catch.<br><br />
i updated the page to correct it, and add the link to the autotrim documentation ;)<br><br />
Dju92</div>Dju92https://wiki.alpinelinux.org/w/index.php?title=ZFS&diff=26714ZFS2024-05-13T17:40:54Z<p>Dju92: Correction + link to autotrim documentation</p>
<hr />
<div>= Introduction =<br />
<br />
On alpine Linux, there in no cron/script provided to scrub (and eventually trim) your pool(s) on a regular basis, like in other Linux distributions.<br><br />
Setting it up is easy and can be done in a few minutes.<br />
<br />
= Scrub =<br />
<br />
== Definition ==<br />
<br />
The scrub examines all data in the specified pools to verify that it checksums correctly. For replicated (mirror, raidz, or draid) devices, ZFS automatically repairs any damage discovered during the scrub<br><br />
When scrubbing a pool with encrypted filesystems the keys do not need to be loaded. However, if the keys are not loaded and an unrepairable checksum error is detected the file name cannot be included in the zpool status -v verbose error report.<br><br />
A scrub is split into two parts: metadata scanning and block scrubbing. The metadata scanning sorts blocks into large sequential ranges which can then be read much more efficiently from disk when issuing the scrub I/O.<br />
<br />
Also see [https://blogs.oracle.com/oracle-systems/post/disk-scrub-why-and-when Oracle - Disk Scrub - Why and When?]<br />
<br />
== Creating the script ==<br />
<br />
This script is used to list the pools, make sure they are online, and no scrub is being done at the time.<br><br />
We will write it in {{path|/usr/libexec/zfs/scrub}}<br><br />
It's taken from debian zfs scripts<br />
<br />
{{cat|/usr/libexec/zfs/scrub|<nowiki>#!/bin/sh -eu<br />
<br />
# directly exit successfully when zfs module is not loaded<br />
if ! [ -d /sys/module/zfs ]; then<br />
exit 0<br />
fi<br />
<br />
# [auto] / enable / disable<br />
PROPERTY_NAME="org.alpine:periodic-scrub"<br />
<br />
get_property () {<br />
# Detect the ${PROPERTY_NAME} property on a given pool.<br />
# We are abusing user-defined properties on the root dataset,<br />
# since they're not available on pools https://github.com/openzfs/zfs/pull/11680<br />
# TODO: use zpool user-defined property when such feature is available.<br />
pool="$1"<br />
zfs get -H -o value "${PROPERTY_NAME}" "${pool}" 2>/dev/null || return 1<br />
}<br />
<br />
scrub_if_not_scrub_in_progress () {<br />
pool="$1"<br />
if ! zpool status "${pool}" | grep -q "scrub in progress"; then<br />
# Ignore errors and continue with scrubbing other pools.<br />
zpool scrub "${pool}" || true<br />
fi<br />
}<br />
<br />
# Scrub all healthy pools that are not already scrubbing as per their configs.<br />
zpool list -H -o health,name 2>&1 | \<br />
awk -F'\t' '$1 == "ONLINE" {print $2}' | \<br />
while read pool<br />
do<br />
# read user-defined config<br />
ret=$(get_property "${pool}")<br />
if [ $? -ne 0 ] || [ "disable" = "${ret}" ]; then<br />
:<br />
elif [ "-" = "${ret}" ] || [ "auto" = "${ret}" ] || [ "enable" = "${ret}" ]; then<br />
scrub_if_not_scrub_in_progress "${pool}"<br />
else<br />
cat > /dev/stderr <<EOF<br />
$0: [WARNING] illegal value "${ret}" for property "${PROPERTY_NAME}" of ZFS dataset "${pool}".<br />
$0: Acceptable choices for this property are: auto, enable, disable. The default is auto.<br />
EOF<br />
fi<br />
done<br />
</nowiki><br />
}}<br />
<br />
Then make the script executable<br />
{{cmd|# chmod +x /usr/libexec/zfs/scrub}}<br />
<br />
== Launching the scrub script with cron ==<br />
<br />
It is recommended to launch a scrub regularly to assure your pool(s) and datas are in good shape.<br><br />
Here, the scrub will be launched once a month, on the 2nd sunday of the month.<br />
<br />
In root, edit your crontabs<br />
{{cmd|# crontab -e}}<br />
<br />
and add these 2 lines<br />
<pre><br />
# zfs scrub the second sunday of every month<br />
24 0 8-14 * * if [ $(date +\%w) -eq 0 ] && [ -x /usr/libexec/zfs/scrub ]; then /usr/libexec/zfs/scrub; fi<br />
</pre><br />
<br />
Finally, make sure cron is launched:<br />
{{cmd|# rc-update}}<br />
<br />
There should be a line saying<br />
<pre>crond | default</pre><br />
<br />
If not, add it to the boot sequence<br />
{{cmd|# rc-update add crond}}<br />
<br />
then start the crond daemon<br />
{{cmd|# rc-service crond start}}<br />
<br />
= Trim =<br />
<br />
== Definition ==<br />
<br />
Initiates an immediate on-demand TRIM operation for all of the free space in a pool. This operation informs the underlying storage devices of all blocks in the pool which are no longer allocated and allows thinly provisioned devices to reclaim the space.<br><br />
A manual on-demand TRIM operation can be initiated irrespective of the autotrim pool property setting.<br />
See the [https://openzfs.github.io/openzfs-docs/man/v2.2/7/zpoolprops.7.html#autotrim documentation for the autotrim property] for the types of vdev devices which can be trimmed.<br />
<br />
== Creating the script ==<br />
<br />
This script is used to list the pools, make sure they are online, build only with NVME ssd drive(s) and no trim is being done at the time.<br><br />
We will write it in {{path|/usr/libexec/zfs/trim}}<br><br />
It's taken from debian zfs scripts<br />
<br />
{{cat|/usr/libexec/zfs/trim|<nowiki>#!/bin/sh -eu<br />
<br />
# directly exit successfully when zfs module is not loaded<br />
if ! [ -d /sys/module/zfs ]; then<br />
exit 0<br />
fi<br />
<br />
# [auto] / enable / disable<br />
PROPERTY_NAME="org.alpine:periodic-trim"<br />
<br />
get_property () {<br />
# Detect the ${PROPERTY_NAME} property on a given pool.<br />
# We are abusing user-defined properties on the root dataset,<br />
# since they're not available on pools https://github.com/openzfs/zfs/pull/11680<br />
# TODO: use zpool user-defined property when such feature is available.<br />
pool="$1"<br />
zfs get -H -o value "${PROPERTY_NAME}" "${pool}" 2>/dev/null || return 1<br />
}<br />
<br />
trim_if_not_already_trimming () {<br />
pool="$1"<br />
if ! zpool status "${pool}" | grep -q "trimming"; then<br />
# Ignore errors (i.e. HDD pools),<br />
# and continue with trimming other pools.<br />
zpool trim "${pool}" || true<br />
fi<br />
}<br />
<br />
zpool_is_nvme_only () {<br />
zpool=$1<br />
# get a list of devices attached to the specified zpool<br />
zpool list -vHPL "${zpool}" |<br />
awk -F'\t' '$2 ~ /^\/dev\// {<br />
if($2 !~ /^\/dev\/nvme/)<br />
exit 1<br />
}'<br />
}<br />
<br />
# TRIM all healthy pools that are not already trimming as per their configs.<br />
zpool list -H -o health,name 2>&1 | \<br />
awk -F'\t' '$1 == "ONLINE" {print $2}' | \<br />
while read pool<br />
do<br />
# read user-defined config<br />
ret=$(get_property "${pool}")<br />
if [ $? -ne 0 ] || [ "disable" = "${ret}" ]; then<br />
:<br />
elif [ "enable" = "${ret}" ]; then<br />
trim_if_not_already_trimming "${pool}"<br />
elif [ "-" = "${ret}" ] || [ "auto" = "${ret}" ]; then<br />
if zpool_is_nvme_only "${pool}"; then<br />
trim_if_not_already_trimming "${pool}"<br />
fi<br />
else<br />
cat > /dev/stderr <<EOF<br />
$0: [WARNING] illegal value "${ret}" for property "${PROPERTY_NAME}" of ZFS dataset "${pool}".<br />
$0: Acceptable choices for this property are: auto, enable, disable. The default is auto.<br />
EOF<br />
fi<br />
done<br />
</nowiki><br />
}}<br />
<br />
Then make the script executable<br />
{{cmd|# chmod +x /usr/libexec/zfs/trim}}<br />
<br />
== Launching the trim script with cron ==<br />
<br />
Here, the trim will be launched once a month, on the 1st sunday of the month.<br />
<br />
In root, edit your crontabs<br />
{{cmd|# crontab -e}}<br />
<br />
and add these 2 lines<br />
<pre><br />
# zfs trim the first sunday of every month<br />
24 0 1-7 * * if [ $(date +\%w) -eq 0 ] && [ -x /usr/libexec/zfs/trim ]; then /usr/libexec/zfs/trim; fi<br />
</pre><br />
<br />
Finally, make sure cron is launched:<br />
{{cmd|# rc-update}}<br />
<br />
There should be a line saying<br />
<pre>crond | default</pre><br />
<br />
If not, add it to the boot sequence<br />
{{cmd|# rc-update add crond}}<br />
<br />
then start the crond daemon<br />
{{cmd|# rc-service crond start}}<br />
<br />
[[Category:File systems]]</div>Dju92https://wiki.alpinelinux.org/w/index.php?title=ZFS&diff=26701ZFS2024-05-10T20:25:05Z<p>Dju92: typos</p>
<hr />
<div>= Introduction =<br />
<br />
On alpine Linux, there in no cron/script provided to scrub (and eventually trim) your pool(s) on a regular basis, like in other Linux distributions.<br><br />
Setting it up is easy and can be done in a few minutes.<br />
<br />
= Scrub =<br />
<br />
== Definition ==<br />
<br />
The scrub examines all data in the specified pools to verify that it checksums correctly. For replicated (mirror, raidz, or draid) devices, ZFS automatically repairs any damage discovered during the scrub<br><br />
When scrubbing a pool with encrypted filesystems the keys do not need to be loaded. However, if the keys are not loaded and an unrepairable checksum error is detected the file name cannot be included in the zpool status -v verbose error report.<br><br />
A scrub is split into two parts: metadata scanning and block scrubbing. The metadata scanning sorts blocks into large sequential ranges which can then be read much more efficiently from disk when issuing the scrub I/O.<br />
<br />
Also see [https://blogs.oracle.com/oracle-systems/post/disk-scrub-why-and-when Oracle - Disk Scrub - Why and When?]<br />
<br />
== Creating the script ==<br />
<br />
This script is used to list the pools, make sure they are online, and no scrub is being done at the time.<br><br />
We will write it in {{path|/usr/libexec/zfs/scrub}}<br><br />
It's taken from debian zfs scripts<br />
<br />
{{cat|/usr/libexec/zfs/scrub|<nowiki>#!/bin/sh -eu<br />
<br />
# directly exit successfully when zfs module is not loaded<br />
if ! [ -d /sys/module/zfs ]; then<br />
exit 0<br />
fi<br />
<br />
# [auto] / enable / disable<br />
PROPERTY_NAME="org.alpine:periodic-scrub"<br />
<br />
get_property () {<br />
# Detect the ${PROPERTY_NAME} property on a given pool.<br />
# We are abusing user-defined properties on the root dataset,<br />
# since they're not available on pools https://github.com/openzfs/zfs/pull/11680<br />
# TODO: use zpool user-defined property when such feature is available.<br />
pool="$1"<br />
zfs get -H -o value "${PROPERTY_NAME}" "${pool}" 2>/dev/null || return 1<br />
}<br />
<br />
scrub_if_not_scrub_in_progress () {<br />
pool="$1"<br />
if ! zpool status "${pool}" | grep -q "scrub in progress"; then<br />
# Ignore errors and continue with scrubbing other pools.<br />
zpool scrub "${pool}" || true<br />
fi<br />
}<br />
<br />
# Scrub all healthy pools that are not already scrubbing as per their configs.<br />
zpool list -H -o health,name 2>&1 | \<br />
awk -F'\t' '$1 == "ONLINE" {print $2}' | \<br />
while read pool<br />
do<br />
# read user-defined config<br />
ret=$(get_property "${pool}")<br />
if [ $? -ne 0 ] || [ "disable" = "${ret}" ]; then<br />
:<br />
elif [ "-" = "${ret}" ] || [ "auto" = "${ret}" ] || [ "enable" = "${ret}" ]; then<br />
scrub_if_not_scrub_in_progress "${pool}"<br />
else<br />
cat > /dev/stderr <<EOF<br />
$0: [WARNING] illegal value "${ret}" for property "${PROPERTY_NAME}" of ZFS dataset "${pool}".<br />
$0: Acceptable choices for this property are: auto, enable, disable. The default is auto.<br />
EOF<br />
fi<br />
done<br />
</nowiki><br />
}}<br />
<br />
Then make the script executable<br />
{{cmd|# chmod +x /usr/libexec/zfs/scrub}}<br />
<br />
== Launching the scrub script with cron ==<br />
<br />
It is recommended to launch a scrub regularly to assure your pool(s) and datas are in good shape.<br><br />
Here, the scrub will be launched once a month, on the 2nd sunday of the month.<br />
<br />
In root, edit your crontabs<br />
{{cmd|# crontab -e}}<br />
<br />
and add these 2 lines<br />
<pre><br />
# zfs scrub the second sunday of every month<br />
24 0 8-14 * * if [ $(date +\%w) -eq 0 ] && [ -x /usr/libexec/zfs/scrub ]; then /usr/libexec/zfs/scrub; fi<br />
</pre><br />
<br />
Finally, make sure cron is launched:<br />
{{cmd|# rc-update}}<br />
<br />
There should be a line saying<br />
<pre>crond | default</pre><br />
<br />
If not, add it to the boot sequence<br />
{{cmd|# rc-update add crond}}<br />
<br />
then start the crond daemon<br />
{{cmd|# rc-service crond start}}<br />
<br />
= Trim =<br />
<br />
== Definition ==<br />
<br />
Initiates an immediate on-demand TRIM operation for all of the free space in a pool. This operation informs the underlying storage devices of all blocks in the pool which are no longer allocated and allows thinly provisioned devices to reclaim the space.<br><br />
A manual on-demand TRIM operation can be initiated irrespective of the autotrim pool property setting. See the documentation for the autotrim property above for the types of vdev devices which can be trimmed.<br />
<br />
== Creating the script ==<br />
<br />
This script is used to list the pools, make sure they are online, build only with NVME ssd drive(s) and no trim is being done at the time.<br><br />
We will write it in {{path|/usr/libexec/zfs/trim}}<br><br />
It's taken from debian zfs scripts<br />
<br />
{{cat|/usr/libexec/zfs/trim|<nowiki>#!/bin/sh -eu<br />
<br />
# directly exit successfully when zfs module is not loaded<br />
if ! [ -d /sys/module/zfs ]; then<br />
exit 0<br />
fi<br />
<br />
# [auto] / enable / disable<br />
PROPERTY_NAME="org.alpine:periodic-trim"<br />
<br />
get_property () {<br />
# Detect the ${PROPERTY_NAME} property on a given pool.<br />
# We are abusing user-defined properties on the root dataset,<br />
# since they're not available on pools https://github.com/openzfs/zfs/pull/11680<br />
# TODO: use zpool user-defined property when such feature is available.<br />
pool="$1"<br />
zfs get -H -o value "${PROPERTY_NAME}" "${pool}" 2>/dev/null || return 1<br />
}<br />
<br />
trim_if_not_already_trimming () {<br />
pool="$1"<br />
if ! zpool status "${pool}" | grep -q "trimming"; then<br />
# Ignore errors (i.e. HDD pools),<br />
# and continue with trimming other pools.<br />
zpool trim "${pool}" || true<br />
fi<br />
}<br />
<br />
zpool_is_nvme_only () {<br />
zpool=$1<br />
# get a list of devices attached to the specified zpool<br />
zpool list -vHPL "${zpool}" |<br />
awk -F'\t' '$2 ~ /^\/dev\// {<br />
if($2 !~ /^\/dev\/nvme/)<br />
exit 1<br />
}'<br />
}<br />
<br />
# TRIM all healthy pools that are not already trimming as per their configs.<br />
zpool list -H -o health,name 2>&1 | \<br />
awk -F'\t' '$1 == "ONLINE" {print $2}' | \<br />
while read pool<br />
do<br />
# read user-defined config<br />
ret=$(get_property "${pool}")<br />
if [ $? -ne 0 ] || [ "disable" = "${ret}" ]; then<br />
:<br />
elif [ "enable" = "${ret}" ]; then<br />
trim_if_not_already_trimming "${pool}"<br />
elif [ "-" = "${ret}" ] || [ "auto" = "${ret}" ]; then<br />
if zpool_is_nvme_only "${pool}"; then<br />
trim_if_not_already_trimming "${pool}"<br />
fi<br />
else<br />
cat > /dev/stderr <<EOF<br />
$0: [WARNING] illegal value "${ret}" for property "${PROPERTY_NAME}" of ZFS dataset "${pool}".<br />
$0: Acceptable choices for this property are: auto, enable, disable. The default is auto.<br />
EOF<br />
fi<br />
done<br />
</nowiki><br />
}}<br />
<br />
Then make the script executable<br />
{{cmd|# chmod +x /usr/libexec/zfs/trim}}<br />
<br />
== Launching the trim script with cron ==<br />
<br />
Here, the trim will be launched once a month, on the 1st sunday of the month.<br />
<br />
In root, edit your crontabs<br />
{{cmd|# crontab -e}}<br />
<br />
and add these 2 lines<br />
<pre><br />
# zfs trim the first sunday of every month<br />
24 0 1-7 * * if [ $(date +\%w) -eq 0 ] && [ -x /usr/libexec/zfs/trim ]; then /usr/libexec/zfs/trim; fi<br />
</pre><br />
<br />
Finally, make sure cron is launched:<br />
{{cmd|# rc-update}}<br />
<br />
There should be a line saying<br />
<pre>crond | default</pre><br />
<br />
If not, add it to the boot sequence<br />
{{cmd|# rc-update add crond}}<br />
<br />
then start the crond daemon<br />
{{cmd|# rc-service crond start}}<br />
<br />
[[Category:File systems]]</div>Dju92https://wiki.alpinelinux.org/w/index.php?title=ZFS&diff=24445ZFS2023-08-25T01:34:54Z<p>Dju92: small typo</p>
<hr />
<div>= Introduction =<br />
<br />
On alpine Linux, there in no cron/script provided to scrub (and eventually trim) your pool(s) on a regular basis, like in other Linux distributions.<br><br />
Setting it up is easy and can be done in a few minutes.<br />
<br />
= Scrub =<br />
<br />
== Definition ==<br />
<br />
The scrub examines all data in the specified pools to verify that it checksums correctly. For replicated (mirror, raidz, or draid) devices, ZFS automatically repairs any damage discovered during the scrub<br><br />
When scrubbing a pool with encrypted filesystems the keys do not need to be loaded. However, if the keys are not loaded and an unrepairable checksum error is detected the file name cannot be included in the zpool status -v verbose error report.<br><br />
A scrub is split into two parts: metadata scanning and block scrubbing. The metadata scanning sorts blocks into large sequential ranges which can then be read much more efficiently from disk when issuing the scrub I/O.<br />
<br />
Also see [https://blogs.oracle.com/oracle-systems/post/disk-scrub-why-and-when Oracle - Disk Scrub - Why and When?]<br />
<br />
== Creating the script ==<br />
<br />
This script is used to list the pools, make sure they are online, and no scrub is being done at the time.<br><br />
We will write it in '''/usr/libexec/zfs/scrub'''<br><br />
It's taken from debian zfs scripts<br />
<br />
<pre><br />
#!/bin/sh -eu<br />
<br />
# directly exit successfully when zfs module is not loaded<br />
if ! [ -d /sys/module/zfs ]; then<br />
exit 0<br />
fi<br />
<br />
# [auto] / enable / disable<br />
PROPERTY_NAME="org.alpine:periodic-scrub"<br />
<br />
get_property () {<br />
# Detect the ${PROPERTY_NAME} property on a given pool.<br />
# We are abusing user-defined properties on the root dataset,<br />
# since they're not available on pools https://github.com/openzfs/zfs/pull/11680<br />
# TODO: use zpool user-defined property when such feature is available.<br />
pool="$1"<br />
zfs get -H -o value "${PROPERTY_NAME}" "${pool}" 2>/dev/null || return 1<br />
}<br />
<br />
scrub_if_not_scrub_in_progress () {<br />
pool="$1"<br />
if ! zpool status "${pool}" | grep -q "scrub in progress"; then<br />
# Ignore errors and continue with scrubbing other pools.<br />
zpool scrub "${pool}" || true<br />
fi<br />
}<br />
<br />
# Scrub all healthy pools that are not already scrubbing as per their configs.<br />
zpool list -H -o health,name 2>&1 | \<br />
awk -F'\t' '$1 == "ONLINE" {print $2}' | \<br />
while read pool<br />
do<br />
# read user-defined config<br />
ret=$(get_property "${pool}")<br />
if [ $? -ne 0 ] || [ "disable" = "${ret}" ]; then<br />
:<br />
elif [ "-" = "${ret}" ] || [ "auto" = "${ret}" ] || [ "enable" = "${ret}" ]; then<br />
scrub_if_not_scrub_in_progress "${pool}"<br />
else<br />
cat > /dev/stderr <<EOF<br />
$0: [WARNING] illegal value "${ret}" for property "${PROPERTY_NAME}" of ZFS dataset "${pool}".<br />
$0: Acceptable choices for this property are: auto, enable, disable. The default is auto.<br />
EOF<br />
fi<br />
done<br />
</pre><br />
<br />
Then make the script executable<br />
# chmod +x /usr/libexec/zfs/scrub<br />
<br />
== Launching the scrub script with cron ==<br />
<br />
It is recommended to launch a scrub regularly to assure your pool(s) and datas are in good shape.<br><br />
Here, the scrub will be launched once a month, on the 2nd sunday of the month.<br />
<br />
In root, edit your crontabs<br />
# crontab -e<br />
<br />
and add these 2 lines<br />
<pre><br />
# zfs scrub the second sunday of every month<br />
24 0 8-14 * * if [ $(date +\%w) -eq 0 ] && [ -x /usr/libexec/zfs/scrub ]; then /usr/libexec/zfs/scrub; fi<br />
</pre><br />
<br />
Finally, make sure cron is launched:<br />
# rc-update<br />
<br />
There should be a line saying<br />
<pre>crond | default</pre><br />
<br />
If not, add it to the boot sequence<br />
# rc-update add crond<br />
<br />
then start the crond daemon<br />
# rc-service crond start<br />
<br />
= Trim =<br />
<br />
== Definition ==<br />
<br />
Initiates an immediate on-demand TRIM operation for all of the free space in a pool. This operation informs the underlying storage devices of all blocks in the pool which are no longer allocated and allows thinly provisioned devices to reclaim the space.<br><br />
A manual on-demand TRIM operation can be initiated irrespective of the autotrim pool property setting. See the documentation for the autotrim property above for the types of vdev devices which can be trimmed.<br />
<br />
== Creating the script ==<br />
<br />
This script is used to list the pools, make sure they are online, build only with NVME ssd drive(s) and no trim is being done at the time.<br><br />
We will write it in '''/usr/libexec/zfs/trim'''<br><br />
It's taken from debian zfs scripts<br />
<br />
<pre><br />
!/bin/sh -eu<br />
<br />
# directly exit successfully when zfs module is not loaded<br />
if ! [ -d /sys/module/zfs ]; then<br />
exit 0<br />
fi<br />
<br />
# [auto] / enable / disable<br />
PROPERTY_NAME="org.alpine:periodic-trim"<br />
<br />
get_property () {<br />
# Detect the ${PROPERTY_NAME} property on a given pool.<br />
# We are abusing user-defined properties on the root dataset,<br />
# since they're not available on pools https://github.com/openzfs/zfs/pull/11680<br />
# TODO: use zpool user-defined property when such feature is available.<br />
pool="$1"<br />
zfs get -H -o value "${PROPERTY_NAME}" "${pool}" 2>/dev/null || return 1<br />
}<br />
<br />
trim_if_not_already_trimming () {<br />
pool="$1"<br />
if ! zpool status "${pool}" | grep -q "trimming"; then<br />
# Ignore errors (i.e. HDD pools),<br />
# and continue with trimming other pools.<br />
zpool trim "${pool}" || true<br />
fi<br />
}<br />
<br />
zpool_is_nvme_only () {<br />
zpool=$1<br />
# get a list of devices attached to the specified zpool<br />
zpool list -vHPL "${zpool}" |<br />
awk -F'\t' '$2 ~ /^\/dev\// {<br />
if($2 !~ /^\/dev\/nvme/)<br />
exit 1<br />
}'<br />
}<br />
<br />
# TRIM all healthy pools that are not already trimming as per their configs.<br />
zpool list -H -o health,name 2>&1 | \<br />
awk -F'\t' '$1 == "ONLINE" {print $2}' | \<br />
while read pool<br />
do<br />
# read user-defined config<br />
ret=$(get_property "${pool}")<br />
if [ $? -ne 0 ] || [ "disable" = "${ret}" ]; then<br />
:<br />
elif [ "enable" = "${ret}" ]; then<br />
trim_if_not_already_trimming "${pool}"<br />
elif [ "-" = "${ret}" ] || [ "auto" = "${ret}" ]; then<br />
if zpool_is_nvme_only "${pool}"; then<br />
trim_if_not_already_trimming "${pool}"<br />
fi<br />
else<br />
cat > /dev/stderr <<EOF<br />
$0: [WARNING] illegal value "${ret}" for property "${PROPERTY_NAME}" of ZFS dataset "${pool}".<br />
$0: Acceptable choices for this property are: auto, enable, disable. The default is auto.<br />
EOF<br />
fi<br />
done<br />
</pre><br />
<br />
Then make the script executable<br />
# chmod +x /usr/libexec/zfs/trim<br />
<br />
== Launching the scrub script with cron ==<br />
<br />
Here, the scrub will be launched once a month, on the 1st sunday of the month.<br />
<br />
In root, edit your crontabs<br />
# crontab -e<br />
<br />
and add these 2 lines<br />
<pre><br />
# zfs trim the first sunday of every month<br />
24 0 1-7 * * if [ $(date +\%w) -eq 0 ] && [ -x /usr/libexec/zfs/trim ]; then /usr/libexec/zfs/trim; fi<br />
</pre><br />
<br />
Finally, make sure cron is launched:<br />
# rc-update<br />
<br />
There should be a line saying<br />
<pre>crond | default</pre><br />
<br />
If not, add it to the boot sequence<br />
# rc-update add crond<br />
<br />
then start the crond daemon<br />
# rc-service crond start</div>Dju92https://wiki.alpinelinux.org/w/index.php?title=ZFS&diff=24419ZFS2023-08-24T22:25:09Z<p>Dju92: /* Definition */ added oracle explanation on scrub</p>
<hr />
<div>= Introduction =<br />
<br />
On alpine Linux, there in no cron/script provided to scrub (and eventually trim) your pool(s) on a regular basis, like in other Linux distributions.<br><br />
Setting it up is easy and can be done in a few minutes.<br />
<br />
= Scrub =<br />
<br />
== Definition ==<br />
<br />
The scrub examines all data in the specified pools to verify that it checksums correctly. For replicated (mirror, raidz, or draid) devices, ZFS automatically repairs any damage discovered during the scrub<br><br />
When scrubbing a pool with encrypted filesystems the keys do not need to be loaded. However, if the keys are not loaded and an unrepairable checksum error is detected the file name cannot be included in the zpool status -v verbose error report.<br><br />
A scrub is split into two parts: metadata scanning and block scrubbing. The metadata scanning sorts blocks into large sequential ranges which can then be read much more efficiently from disk when issuing the scrub I/O.<br />
<br />
Alo see [https://blogs.oracle.com/oracle-systems/post/disk-scrub-why-and-when Oracle - Disk Scrub - Why and When?]<br />
<br />
== Creating the script ==<br />
<br />
This script is used to list the pools, make sure they are online, and no scrub is being done at the time.<br><br />
We will write it in '''/usr/libexec/zfs/scrub'''<br><br />
It's taken from debian zfs scripts<br />
<br />
<pre><br />
#!/bin/sh -eu<br />
<br />
# directly exit successfully when zfs module is not loaded<br />
if ! [ -d /sys/module/zfs ]; then<br />
exit 0<br />
fi<br />
<br />
# [auto] / enable / disable<br />
PROPERTY_NAME="org.alpine:periodic-scrub"<br />
<br />
get_property () {<br />
# Detect the ${PROPERTY_NAME} property on a given pool.<br />
# We are abusing user-defined properties on the root dataset,<br />
# since they're not available on pools https://github.com/openzfs/zfs/pull/11680<br />
# TODO: use zpool user-defined property when such feature is available.<br />
pool="$1"<br />
zfs get -H -o value "${PROPERTY_NAME}" "${pool}" 2>/dev/null || return 1<br />
}<br />
<br />
scrub_if_not_scrub_in_progress () {<br />
pool="$1"<br />
if ! zpool status "${pool}" | grep -q "scrub in progress"; then<br />
# Ignore errors and continue with scrubbing other pools.<br />
zpool scrub "${pool}" || true<br />
fi<br />
}<br />
<br />
# Scrub all healthy pools that are not already scrubbing as per their configs.<br />
zpool list -H -o health,name 2>&1 | \<br />
awk -F'\t' '$1 == "ONLINE" {print $2}' | \<br />
while read pool<br />
do<br />
# read user-defined config<br />
ret=$(get_property "${pool}")<br />
if [ $? -ne 0 ] || [ "disable" = "${ret}" ]; then<br />
:<br />
elif [ "-" = "${ret}" ] || [ "auto" = "${ret}" ] || [ "enable" = "${ret}" ]; then<br />
scrub_if_not_scrub_in_progress "${pool}"<br />
else<br />
cat > /dev/stderr <<EOF<br />
$0: [WARNING] illegal value "${ret}" for property "${PROPERTY_NAME}" of ZFS dataset "${pool}".<br />
$0: Acceptable choices for this property are: auto, enable, disable. The default is auto.<br />
EOF<br />
fi<br />
done<br />
</pre><br />
<br />
Then make the script executable<br />
# chmod +x /usr/libexec/zfs/script<br />
<br />
== Launching the scrub script with cron ==<br />
<br />
It is recommended to launch a scrub regularly to assure your pool(s) and datas are in good shape.<br><br />
Here, the scrub will be launched once a month, on the 2nd sunday of the month.<br />
<br />
In root, edit your crontabs<br />
# crontab -e<br />
<br />
and add these 2 lines<br />
<pre><br />
# zfs scrub the second sunday of every month<br />
24 0 8-14 * * if [ $(date +\%w) -eq 0 ] && [ -x /usr/libexec/zfs/scrub ]; then /usr/libexec/zfs/scrub; fi<br />
</pre><br />
<br />
Finally, make sure cron is launched:<br />
# rc-update<br />
<br />
There should be a line saying<br />
<pre>crond | default</pre><br />
<br />
If not, add it to the boot sequence<br />
# rc-update add crond<br />
<br />
then start the crond daemon<br />
# rc-service crond start<br />
<br />
= Trim =<br />
<br />
== Definition ==<br />
<br />
Initiates an immediate on-demand TRIM operation for all of the free space in a pool. This operation informs the underlying storage devices of all blocks in the pool which are no longer allocated and allows thinly provisioned devices to reclaim the space.<br><br />
A manual on-demand TRIM operation can be initiated irrespective of the autotrim pool property setting. See the documentation for the autotrim property above for the types of vdev devices which can be trimmed.<br />
<br />
== Creating the script ==<br />
<br />
This script is used to list the pools, make sure they are online, build only with NVME ssd drive(s) and no trim is being done at the time.<br><br />
We will write it in '''/usr/libexec/zfs/trim'''<br><br />
It's taken from debian zfs scripts<br />
<br />
<pre><br />
!/bin/sh -eu<br />
<br />
# directly exit successfully when zfs module is not loaded<br />
if ! [ -d /sys/module/zfs ]; then<br />
exit 0<br />
fi<br />
<br />
# [auto] / enable / disable<br />
PROPERTY_NAME="org.alpine:periodic-trim"<br />
<br />
get_property () {<br />
# Detect the ${PROPERTY_NAME} property on a given pool.<br />
# We are abusing user-defined properties on the root dataset,<br />
# since they're not available on pools https://github.com/openzfs/zfs/pull/11680<br />
# TODO: use zpool user-defined property when such feature is available.<br />
pool="$1"<br />
zfs get -H -o value "${PROPERTY_NAME}" "${pool}" 2>/dev/null || return 1<br />
}<br />
<br />
trim_if_not_already_trimming () {<br />
pool="$1"<br />
if ! zpool status "${pool}" | grep -q "trimming"; then<br />
# Ignore errors (i.e. HDD pools),<br />
# and continue with trimming other pools.<br />
zpool trim "${pool}" || true<br />
fi<br />
}<br />
<br />
zpool_is_nvme_only () {<br />
zpool=$1<br />
# get a list of devices attached to the specified zpool<br />
zpool list -vHPL "${zpool}" |<br />
awk -F'\t' '$2 ~ /^\/dev\// {<br />
if($2 !~ /^\/dev\/nvme/)<br />
exit 1<br />
}'<br />
}<br />
<br />
# TRIM all healthy pools that are not already trimming as per their configs.<br />
zpool list -H -o health,name 2>&1 | \<br />
awk -F'\t' '$1 == "ONLINE" {print $2}' | \<br />
while read pool<br />
do<br />
# read user-defined config<br />
ret=$(get_property "${pool}")<br />
if [ $? -ne 0 ] || [ "disable" = "${ret}" ]; then<br />
:<br />
elif [ "enable" = "${ret}" ]; then<br />
trim_if_not_already_trimming "${pool}"<br />
elif [ "-" = "${ret}" ] || [ "auto" = "${ret}" ]; then<br />
if zpool_is_nvme_only "${pool}"; then<br />
trim_if_not_already_trimming "${pool}"<br />
fi<br />
else<br />
cat > /dev/stderr <<EOF<br />
$0: [WARNING] illegal value "${ret}" for property "${PROPERTY_NAME}" of ZFS dataset "${pool}".<br />
$0: Acceptable choices for this property are: auto, enable, disable. The default is auto.<br />
EOF<br />
fi<br />
done<br />
</pre><br />
<br />
Then make the script executable<br />
# chmod +x /usr/libexec/zfs/trim<br />
<br />
== Launching the scrub script with cron ==<br />
<br />
Here, the scrub will be launched once a month, on the 1st sunday of the month.<br />
<br />
In root, edit your crontabs<br />
# crontab -e<br />
<br />
and add these 2 lines<br />
<pre><br />
# zfs trim the first sunday of every month<br />
24 0 1-7 * * if [ $(date +\%w) -eq 0 ] && [ -x /usr/libexec/zfs/trim ]; then /usr/libexec/zfs/trim; fi<br />
</pre><br />
<br />
Finally, make sure cron is launched:<br />
# rc-update<br />
<br />
There should be a line saying<br />
<pre>crond | default</pre><br />
<br />
If not, add it to the boot sequence<br />
# rc-update add crond<br />
<br />
then start the crond daemon<br />
# rc-service crond start</div>Dju92https://wiki.alpinelinux.org/w/index.php?title=ZFS&diff=24418ZFS2023-08-24T22:17:19Z<p>Dju92: added the trim part, corrected a few typos</p>
<hr />
<div>= Introduction =<br />
<br />
On alpine Linux, there in no cron/script provided to scrub (and eventually trim) your pool(s) on a regular basis, like in other Linux distributions.<br><br />
Setting it up is easy and can be done in a few minutes.<br />
<br />
= Scrub =<br />
<br />
== Definition ==<br />
<br />
The scrub examines all data in the specified pools to verify that it checksums correctly. For replicated (mirror, raidz, or draid) devices, ZFS automatically repairs any damage discovered during the scrub<br><br />
When scrubbing a pool with encrypted filesystems the keys do not need to be loaded. However, if the keys are not loaded and an unrepairable checksum error is detected the file name cannot be included in the zpool status -v verbose error report.<br><br />
A scrub is split into two parts: metadata scanning and block scrubbing. The metadata scanning sorts blocks into large sequential ranges which can then be read much more efficiently from disk when issuing the scrub I/O.<br />
<br />
== Creating the script ==<br />
<br />
This script is used to list the pools, make sure they are online, and no scrub is being done at the time.<br><br />
We will write it in '''/usr/libexec/zfs/scrub'''<br><br />
It's taken from debian zfs scripts<br />
<br />
<pre><br />
#!/bin/sh -eu<br />
<br />
# directly exit successfully when zfs module is not loaded<br />
if ! [ -d /sys/module/zfs ]; then<br />
exit 0<br />
fi<br />
<br />
# [auto] / enable / disable<br />
PROPERTY_NAME="org.alpine:periodic-scrub"<br />
<br />
get_property () {<br />
# Detect the ${PROPERTY_NAME} property on a given pool.<br />
# We are abusing user-defined properties on the root dataset,<br />
# since they're not available on pools https://github.com/openzfs/zfs/pull/11680<br />
# TODO: use zpool user-defined property when such feature is available.<br />
pool="$1"<br />
zfs get -H -o value "${PROPERTY_NAME}" "${pool}" 2>/dev/null || return 1<br />
}<br />
<br />
scrub_if_not_scrub_in_progress () {<br />
pool="$1"<br />
if ! zpool status "${pool}" | grep -q "scrub in progress"; then<br />
# Ignore errors and continue with scrubbing other pools.<br />
zpool scrub "${pool}" || true<br />
fi<br />
}<br />
<br />
# Scrub all healthy pools that are not already scrubbing as per their configs.<br />
zpool list -H -o health,name 2>&1 | \<br />
awk -F'\t' '$1 == "ONLINE" {print $2}' | \<br />
while read pool<br />
do<br />
# read user-defined config<br />
ret=$(get_property "${pool}")<br />
if [ $? -ne 0 ] || [ "disable" = "${ret}" ]; then<br />
:<br />
elif [ "-" = "${ret}" ] || [ "auto" = "${ret}" ] || [ "enable" = "${ret}" ]; then<br />
scrub_if_not_scrub_in_progress "${pool}"<br />
else<br />
cat > /dev/stderr <<EOF<br />
$0: [WARNING] illegal value "${ret}" for property "${PROPERTY_NAME}" of ZFS dataset "${pool}".<br />
$0: Acceptable choices for this property are: auto, enable, disable. The default is auto.<br />
EOF<br />
fi<br />
done<br />
</pre><br />
<br />
Then make the script executable<br />
# chmod +x /usr/libexec/zfs/script<br />
<br />
== Launching the scrub script with cron ==<br />
<br />
It is recommended to launch a scrub regularly to assure your pool(s) and datas are in good shape.<br><br />
Here, the scrub will be launched once a month, on the 2nd sunday of the month.<br />
<br />
In root, edit your crontabs<br />
# crontab -e<br />
<br />
and add these 2 lines<br />
<pre><br />
# zfs scrub the second sunday of every month<br />
24 0 8-14 * * if [ $(date +\%w) -eq 0 ] && [ -x /usr/libexec/zfs/scrub ]; then /usr/libexec/zfs/scrub; fi<br />
</pre><br />
<br />
Finally, make sure cron is launched:<br />
# rc-update<br />
<br />
There should be a line saying<br />
<pre>crond | default</pre><br />
<br />
If not, add it to the boot sequence<br />
# rc-update add crond<br />
<br />
then start the crond daemon<br />
# rc-service crond start<br />
<br />
= Trim =<br />
<br />
== Definition ==<br />
<br />
Initiates an immediate on-demand TRIM operation for all of the free space in a pool. This operation informs the underlying storage devices of all blocks in the pool which are no longer allocated and allows thinly provisioned devices to reclaim the space.<br><br />
A manual on-demand TRIM operation can be initiated irrespective of the autotrim pool property setting. See the documentation for the autotrim property above for the types of vdev devices which can be trimmed.<br />
<br />
== Creating the script ==<br />
<br />
This script is used to list the pools, make sure they are online, build only with NVME ssd drive(s) and no trim is being done at the time.<br><br />
We will write it in '''/usr/libexec/zfs/trim'''<br><br />
It's taken from debian zfs scripts<br />
<br />
<pre><br />
!/bin/sh -eu<br />
<br />
# directly exit successfully when zfs module is not loaded<br />
if ! [ -d /sys/module/zfs ]; then<br />
exit 0<br />
fi<br />
<br />
# [auto] / enable / disable<br />
PROPERTY_NAME="org.alpine:periodic-trim"<br />
<br />
get_property () {<br />
# Detect the ${PROPERTY_NAME} property on a given pool.<br />
# We are abusing user-defined properties on the root dataset,<br />
# since they're not available on pools https://github.com/openzfs/zfs/pull/11680<br />
# TODO: use zpool user-defined property when such feature is available.<br />
pool="$1"<br />
zfs get -H -o value "${PROPERTY_NAME}" "${pool}" 2>/dev/null || return 1<br />
}<br />
<br />
trim_if_not_already_trimming () {<br />
pool="$1"<br />
if ! zpool status "${pool}" | grep -q "trimming"; then<br />
# Ignore errors (i.e. HDD pools),<br />
# and continue with trimming other pools.<br />
zpool trim "${pool}" || true<br />
fi<br />
}<br />
<br />
zpool_is_nvme_only () {<br />
zpool=$1<br />
# get a list of devices attached to the specified zpool<br />
zpool list -vHPL "${zpool}" |<br />
awk -F'\t' '$2 ~ /^\/dev\// {<br />
if($2 !~ /^\/dev\/nvme/)<br />
exit 1<br />
}'<br />
}<br />
<br />
# TRIM all healthy pools that are not already trimming as per their configs.<br />
zpool list -H -o health,name 2>&1 | \<br />
awk -F'\t' '$1 == "ONLINE" {print $2}' | \<br />
while read pool<br />
do<br />
# read user-defined config<br />
ret=$(get_property "${pool}")<br />
if [ $? -ne 0 ] || [ "disable" = "${ret}" ]; then<br />
:<br />
elif [ "enable" = "${ret}" ]; then<br />
trim_if_not_already_trimming "${pool}"<br />
elif [ "-" = "${ret}" ] || [ "auto" = "${ret}" ]; then<br />
if zpool_is_nvme_only "${pool}"; then<br />
trim_if_not_already_trimming "${pool}"<br />
fi<br />
else<br />
cat > /dev/stderr <<EOF<br />
$0: [WARNING] illegal value "${ret}" for property "${PROPERTY_NAME}" of ZFS dataset "${pool}".<br />
$0: Acceptable choices for this property are: auto, enable, disable. The default is auto.<br />
EOF<br />
fi<br />
done<br />
</pre><br />
<br />
Then make the script executable<br />
# chmod +x /usr/libexec/zfs/trim<br />
<br />
== Launching the scrub script with cron ==<br />
<br />
Here, the scrub will be launched once a month, on the 1st sunday of the month.<br />
<br />
In root, edit your crontabs<br />
# crontab -e<br />
<br />
and add these 2 lines<br />
<pre><br />
# zfs trim the first sunday of every month<br />
24 0 1-7 * * if [ $(date +\%w) -eq 0 ] && [ -x /usr/libexec/zfs/trim ]; then /usr/libexec/zfs/trim; fi<br />
</pre><br />
<br />
Finally, make sure cron is launched:<br />
# rc-update<br />
<br />
There should be a line saying<br />
<pre>crond | default</pre><br />
<br />
If not, add it to the boot sequence<br />
# rc-update add crond<br />
<br />
then start the crond daemon<br />
# rc-service crond start</div>Dju92https://wiki.alpinelinux.org/w/index.php?title=Tutorials_and_Howtos&diff=24417Tutorials and Howtos2023-08-24T21:58:11Z<p>Dju92: /* Storage */ added zfs scrub/trim</p>
<hr />
<div>{{Todo|This material has been re-organized..., but grouping should be checked: '''Howtos are smaller articles''' and '''tutorials are more detailed document'''}}<br />
<br />
[[Image:package_edutainment.svg|right|link=]]<br />
{{TOC left}}<br />
'''Welcome to Tutorials and Howtos, a place of basic and advanced configuration tasks for your Alpine Linux.'''<br />
<br />
'''The tutorials are hands-on''' and the reader is expected to try and achieve the goals described in each step, possibly with the help of a good example. The output in one step is the starting point for the following step.<br />
<br />
'''Howtos are smaller articles''' explaining how to perform a particular task with Alpine Linux, that expects a minimal knowledge from reader to perform actions.<br />
<br />
'''IMPORTANT:''' contributions on those pages must be complete articles as well as requesting topics to be covered, don't override already made contributions. If you want to request a topic, please add your request in this page's [[Talk:Tutorials_and_Howtos|Discussion]].<br />
<br />
<br />
{{Clear}}<br />
<br />
= Howtos =<br />
<br />
== Applications ==<br />
<br />
=== Miscellaneous ===<br />
<br />
* [[Ansible]] ''(Configuration management)''<br />
<br />
=== Monitoring ===<br />
<br />
* [[Awstats]] ''(Free log file analyzer)''<br />
* [[Cacti: traffic analysis and monitoring network]] ''(Front-end for rrdtool networking monitor)''<br />
* [[Cvechecker]] ''(Compare installed packages for Common Vulnerabilities Exposure)'' <!-- Monitoring and Security --><br />
* [[Dglog]] ''(Log analyzer for the web content filter DansGuardian)''<br />
* [[Linfo]]<br />
* [[Obtaining user information via SNMP]] ''(Using squark-auth-snmp as a Squid authentication helper)'' <!-- Networking and Server, <== Using squark-auth-snmp --><br />
* [[PhpSysInfo]] ''(A simple application that displays information about the host it's running on)''<br />
* [[Piwik]] ''(A real time web analytics software program)''<br />
* [[Setting up A Network Monitoring and Inventory System]] ''(Nagios + OpenAudit and related components)'' <!-- draft, solution, Networking and Monitoring and Server --><br />
** [[Setting up NRPE daemon]] ''(Performs remote Nagios checks)'' <!-- Networking and Monitoring --><br />
* [[Setting Up Fprobe And Ntop|Ntop]] ''(NetFlow collection and analysis using a remote fprobe instance)'' <!-- Networking and Monitoring --><br />
* [[Setting up lm_sensors]]<br />
* [[SqStat]] ''(Script to look at active squid users connections)''<br />
* [[Traffic monitoring]] <!-- Networking and Monitoring --><br />
** [[Setting up monitoring using rrdtool (and rrdcollect)]]<br />
** [[Setting up traffic monitoring using rrdtool (and snmp)]] <!-- Monitoring --><br />
* [[Zabbix|Zabbix - the professional complete manager]] ''(Monitor and track the status of network services and hardware)''<br />
* [[ZoneMinder video camera security and surveillance]]<br />
<br />
=== Networking ===<br />
<br />
* Alpine Wall ''(a new firewall management framework)''<br />
** [[Alpine Wall]]<br />
** [[Alpine Wall User's Guide]] <br />
** [[How-To Alpine Wall]]<br />
* [[Freeradius Active Directory Integration]]<br />
* [[GNUnet]]<br />
* [[Setting up a OpenVPN server|OpenVPN server]] ''(Allowing single users or devices to remotely connect to your network)''<br />
* [[OpenVSwitch]]<br />
* [[Using Alpine on Windows domain with IPSEC isolation]]<br />
* [[Configure a Wireguard interface (wg)|Wireguard]]<br />
<br />
=== Telephony ===<br />
<br />
* [[Freepbx on Alpine Linux]]<br />
* [[FreePBX V3]] ''(FreeSWITCH, Asterisk GUI web acces tool)''<br />
* [[Setting up Zaptel/Asterisk on Alpine]]<br />
* [[Kamailio]] ''(SIP Server, formerly OpenSER)''<br />
<br />
== Backup and data migration ==<br />
<br />
* [[Alpine local backup|Alpine local backup (lbu)]] ''(Permanently store your modifications in case your box needs reboot)''<br />
** [[Back Up a Flash Memory Installation]]<br />
** [[Manually editing a existing apkovl]]<br />
* [[Migrating data]]<br />
* [[Rsnapshot]] - setting up periodic backups<br />
<br />
== Desktop ==<br />
<br />
* [[Alpine and UEFI]]<br />
* [[Default applications]]<br />
* Desktop cloud<br />
** [[Nextcloud]] ''(Self hostable cloud suite - Dropbox Alternative)''<br />
** [[OwnCloud]] ''(Installing OwnCloud)''<br />
** [[Seafile: setting up your own private cloud]]<br />
* [[Desktop environments and Window managers]] (overall information only)<br />
* [[Printer Setup]]<br />
* [[Remote Desktop Server]]<br />
* [[Sound Setup]]<br />
** [[PipeWire]]<br />
* [[Suspend on LID close]]<br />
* [[Alpine setup scripts#setup-xorg-base|Xorg Setup]]<br />
<br />
== Networking ==<br />
<br />
* [[Bluetooth]] - Instructions for installing and configuring Bluetooth<br />
* [[Bonding]] - Bond (or aggregate) multiple ethernet interfaces<br />
* [[Bridge]] - Configuring a network bridge<br />
** [[Bridge wlan0 to eth0]]<br />
* [[Configure Networking]]<br />
* [[How to configure static routes]]<br />
* Modem<br />
** [[Using HSDPA modem]]<br />
** [[Using serial modem]]<br />
* [[Multi ISP]] ''(Dual-ISP setup with load-balancing and automatic failover)''<br />
* [[PXE boot]]<br />
* [[Setting up Satellite Internet Connection|Satellite Internet Connection setup]]<br />
* Wi-Fi<br />
** [[Wi-Fi|Connecting to a wireless access point]]<br />
** [[How to setup a wireless access point]] ''(Setting up Secure Wireless AP w/ WPA encryption with bridge to wired network)''<br />
* [[Vlan]]<br />
<br />
== Other Architectures ==<br />
<br />
=== ARM ===<br />
<br />
* [[Alpine on ARM]]<br />
<br />
==== Raspberry Pi ====<br />
<br />
* [[Raspberry Pi Bluetooth Speaker|Raspberry Pi - Bluetooth Speaker]]<br />
* [[Raspberry Pi|Raspberry Pi - Installation]]<br />
* [[Linux Router with VPN on a Raspberry Pi|Raspberry Pi - Router with VPN]]<br />
* [[Linux Router with VPN on a Raspberry Pi (IPv6)|Raspberry Pi - Router with VPN (IPv6)]]<br />
* [[Classic install or sys mode on Raspberry Pi|Raspberry Pi - Sys mode install]]<br />
* [[RPI Video Receiver|Raspberry Pi - Video Receiver]] ''(network video decoder using Rasperry Pi and omxplayer)''<br />
* [[Raspberry Pi 3 - Browser Client]] - kiosk or digital sign<br />
* [[Raspberry Pi 3 - Configuring it as wireless access point -AP Mode]]<br />
* [[Raspberry Pi 3 - Setting Up Bluetooth]]<br />
* [[Raspberry Pi 4 - Persistent system acting as a NAS and Time Machine]]<br />
* [[How to set up Alpine as a wireless router|Raspberry Pi Zero W - Wireless router]] ''(Setting up a firewalled, Wireless AP with wired network on a Pi Zero W)''<br />
<br />
=== IBM Z (IBM z Systems) ===<br />
<br />
* [[s390x|s390x - Installation]]<br />
<br />
=== PowerPC ===<br />
<br />
* [[Ppc64le|Powerpc64le - Installation]]<br />
<br />
== Post-Install ==<br />
<br />
* [[CPU frequency scaling]]<br />
* [[Repositories#Enabling_the_community_repository|Enable Community repository]] ''(Providing additional packages)''<br />
* [[Enable Serial Console on Boot]]<br />
* [[Alpine Linux Init System|Init System (OpenRC)]] ''(Configure a service to automatically boot at next reboot)''<br />
** [[Multiple Instances of Services|Init System - Multiple Instances of Services]]<br />
** [[Writing Init Scripts|Init System - Writing Init Scripts]]<br />
* [[Installing Oracle Java|Oracle Java (installation)]]<br />
* [[IGMPproxy]]<br />
* [[Alpine Linux package management|Package Management (apk)]] ''(How to add/remove packages on your Alpine)''<br />
** [[Comparison with other distros|Package Management - Comparison with other distros]]<br />
* [[Running glibc programs]]<br />
* [[Setting up a new user]]<br />
* [[Upgrading Alpine]]<br />
<br />
== Remote Administration ==<br />
<br />
* ACF<br />
** [[Changing passwords for ACF|ACF - changing passwords]]<br />
** [[Generating SSL certs with ACF]] <!-- Generating SSL certs with ACF 1.9 --><br />
** [[setup-acf| ACF - setup]] ''(Configures ACF (webconfiguration/webmin) so you can manage your box through https)''<br />
* [[Setting up a SSH server]] ''(Using ssh is a good way to administer your box remotely)''<br />
** [[HOWTO OpenSSH 2FA with password and Google Authenticator |OpenSSH 2FA]] ''(A simple two factor setup for OpenSSH)''<br />
* [[OpenVCP]] ''(VServer Control Panel)''<br />
* [[PhpMyAdmin]] ''(Web-based administration tool for MYSQL)''<br />
* [[PhpPgAdmin]] ''(Web-based administration tool for PostgreSQL)''<br />
* [[Webmin]] ''(A web-based interface for Linux system)''<br />
<br />
== Server ==<br />
<br />
* [[Hosting services on Alpine]] ''(Hosting mail, webservices and other services)''<br />
* [[Hosting Web/Email services on Alpine]]<br />
<br />
=== DNS ===<br />
<br />
* [[DNSCrypt-Proxy]] ''Encrypt and authenticate DNS calls from your system''<br />
* [[Setting up nsd DNS server]]<br />
* [[Setting up unbound DNS server]]<br />
* [[TinyDNS Format]]<br />
<br />
=== HTTP ===<br />
<br />
* [[Apache]]<br />
** [[Apache with php-fpm]]<br />
** [[Setting Up Apache with PHP]]<br />
** [[Apache authentication: NTLM Single Signon]]<br />
* [[Darkhttpd]]<br />
* [[Lighttpd]]<br />
** [[Lighttpd Advanced security]]<br />
** [[Setting Up Lighttpd With FastCGI]]<br />
* [[Nginx]]<br />
** [[Nginx as reverse proxy with acme (letsencrypt)]]<br />
** [[Nginx with PHP]]<br />
* Squid Proxy<br />
** [[Obtaining user information via SNMP]] ''(Using squark-auth-snmp as a Squid authentication helper)'' <!-- Networking and Server, <== Using squark-auth-snmp --><br />
** [[Setting up Explicit Squid Proxy]]<br />
** [[Setting up Transparent Squid Proxy]] ''(Covers Squid proxy and URL Filtering system)''<br />
** [[SqStat]] ''(Script to look at active squid users connections)''<br />
* [[Tomcat]]<br />
<br />
==== Hostable Content ====<br />
<br />
* [[DokuWiki]]<br />
* [[Drupal]] ''(Content Management System (CMS) written in PHP)''<br />
* [[Kopano]] ''(Microsoft Outlook compatible Groupware)''<br />
* [[Mahara]] ''(E-portfolio and social networking system)''<br />
* [[MediaWiki]] ''(Free web-based wiki software application)''<br />
* [[Pastebin]] ''(Pastebin software application)''<br />
* [[Phpizabi]] ''(Social Networking Platform)''<br />
* [[Statusnet]] ''(Microblogging Platform)''<br />
* [[WordPress]] ''(Web software to create website or blog)''<br />
<br />
=== IRC ===<br />
<br />
* [[How To Setup Your Own IRC Network]] ''(Using {{Pkg|charybdis}} and {{Pkg|atheme-iris}})''<br />
* [[NgIRCd]] ''(Server for Internet Relay Chat/IRC)''<br />
<br />
=== Mail ===<br />
<br />
* Exim/Dovecot<br />
** [[Small-Time Email with Exim and Dovecot]] ''(A simple configuration for your home network.)<br />
** [[Setting up dovecot with imap and ssl]]<br />
* [[relay email to gmail (msmtp, mailx, sendmail]]<br />
* [[Roundcube]] ''(Webmail system)''<br />
* [[Setting up postfix with virtual domains]]<br />
* Server protection<br />
** [[Protecting your email server with Alpine]]<br />
** [[Setting up clamsmtp]]<br />
<br />
=== Other Servers ===<br />
<br />
* [[Chrony and GPSD | Chrony, gpsd, and a garmin LVC 18 as a Stratum 1 NTP source ]]<br />
* [[Glpi]] ''(Manage inventory of technical resources)''<br />
* [[How to setup a Alpine Linux mirror]]<br />
* [[Setting up a nfs-server|nfs-server]]<br />
* [[Odoo]]<br />
* [[Configure OpenLDAP | OpenLDAP]] ''(Installing and configuring the Alpine package for OpenLDAP)''<br />
* [[Setting up a samba-ad-dc|samba-ad-dc]] ''(Active Directory compatible domain controller)''<br />
* [[Setting up a samba-server|samba-server]] ''(standard file sharing)''<br />
* [[Setting up Transmission (bittorrent) with Clutch WebUI]]<br />
* [[UniFi Controller]]<br />
<br />
=== Software development ===<br />
<br />
* [[Cgit]]<br />
* [[OsTicket]] ''(Ticket system)''<br />
* [[Patchwork]] ''(Patch review management system)''<br />
* [[Redmine]] ''(Project management system)''<br />
* [[Request Tracker]] ''(Ticket system)''<br />
* [[Setting up trac wiki|Trac]] ''(Enhanced wiki and issue tracking system for software development projects)''<br />
<br />
== Storage ==<br />
<br />
* [[Setting up disks manually|Disk setup (manual)]]<br />
* [[Disk Replication with DRBD|DRBD: Disk Replication]]<br />
* [[Filesystems]]<br />
** [[Burning ISOs]]<br />
* [[Setting up iSCSI|iSCSI Setup]]<br />
** [[iSCSI Raid and Clustered File Systems]]<br />
** [[Linux iSCSI Target (TCM)|iSCSI Target (TCM)/LinuxIO (LIO)]]<br />
** [[Linux iSCSI Target (tgt)|User space iSCSI Target (tgt)]]<br />
* [[Setting up Logical Volumes with LVM|LVM Setup]]<br />
** [[Setting up LVM on GPT-labeled disks|LVM on GPT-labeled disks]]<br />
** [[Installing on GPT LVM|LVM on GPT-labeled disks (updated)]]<br />
** [[LVM on LUKS]]<br />
* RAID<br />
** [[Raid Administration]]<br />
** [[Setting up a software RAID array]]<br />
* ZFS<br />
** [[Root on ZFS with native encryption]]<br />
** [[Setting up ZFS on LUKS]]<br />
** [[Setting up ZFS with native encryption]]<br />
** [[ZFS scrub and trim]]<br />
<br />
== Virtualization ==<br />
<br />
* [[Docker]]<br />
* [[Installing Alpine in a virtual machine]]<br />
** [[Install Alpine on VMware ESXi]]<br />
* [[KVM]] ''(Setting up Alpine as a KVM hypervisor)''<br />
* [[LXC]] ''(Setting up a Linux container in Alpine Linux)''<br />
* [[QEMU]]<br />
* Xen<br />
** [[Xen Dom0]] ''(Setting up Alpine as a dom0 for Xen hypervisor)''<br />
** [[Xen Dom0 on USB or SD]]<br />
** [[Create Alpine Linux PV DomU|Xen DomU (paravirtualized)]]<br />
** [[Xen LiveCD]]<br />
** [[Xen PCI Passthrough]]<br />
<br />
= Tutorials =<br />
<br />
== Miscellaneous ==<br />
<br />
* [[Dynamic Multipoint VPN (DMVPN)]] combined with [[Small Office Services]]<br />
* [[DIY Fully working Alpine Linux for Allwinner and Other ARM SOCs]]<br />
* [[Experiences with OpenVPN-client on ALIX.2D3]]<br />
* [[Fault Tolerant Routing with Alpine Linux]]<br />
* [[High Availability High Performance Web Cache]] ''(uCarp + HAProxy for High Availability Services such as Squid web proxy)''<br />
* [[High performance SCST iSCSI Target on Linux software Raid]]<br />
* [[ISP Mail Server HowTo]] ''(Postfix+PostfixAdmin+DoveCot+Roundcube+ClamAV+Spamd - A full-serivce ISP mail server)''<br />
** [[ISP Mail Server Upgrade 2.x]]<br />
** [[ISP Mail Server 2.x HowTo]] ''(Beta, please test)''<br />
** [[ISP Mail Server 3.x HowTo]]<br />
* [[Replacing non-Alpine Linux with Alpine remotely]]<br />
* [[Setting up A Network Monitoring and Inventory System]] ''(Nagios + OpenAudit and related components)'' <!-- draft --><br />
* [[Streaming Security Camera Video with VLC]]<br />
<br />
== Newbie corner ==<br />
<br />
* [[How to get regular stuff working]] ''some notes on need-to-know topics''<br />
<br />
== Servers ==<br />
<br />
* [[Alpine production deploy]]<br />
** [[Production Web server: Lighttpd|Production web server: Lighttpd‎‎]]<br />
** [[Production DataBases : mysql|Production database: MySql]]<br />
** [[Production LAMP system: Lighttpd + PHP + MySQL‎‎]]<br />
* Alpine production monitoring<br />
** [[Cacti: traffic analysis and monitoring network]]<br />
** [[Zabbix|Zabbix - the professional complete manager]]<br />
* Kubernetes<br />
** [[K8s]] Building a K8s Cluster on Alpine Linux</div>Dju92https://wiki.alpinelinux.org/w/index.php?title=ZFS&diff=24416ZFS2023-08-24T21:39:24Z<p>Dju92: Created page with "= Introduction = On alpine linux, there in no cron/script provided to scrub (and eventually trim) your pool(s) on a regular basis, like in other linux distributions.<br> Setting it up is easy and can be done in a few minutes. = Scrub = == Definition == {{Note|The scrub examines all data in the specified pools to verify that it checksums correctly. For replicated (mirror, raidz, or draid) devices, ZFS automatically repairs any damage discovered during the scrub<br> Wh..."</p>
<hr />
<div>= Introduction =<br />
<br />
On alpine linux, there in no cron/script provided to scrub (and eventually trim) your pool(s) on a regular basis, like in other linux distributions.<br><br />
Setting it up is easy and can be done in a few minutes.<br />
<br />
= Scrub =<br />
<br />
== Definition ==<br />
<br />
{{Note|The scrub examines all data in the specified pools to verify that it checksums correctly. For replicated (mirror, raidz, or draid) devices, ZFS automatically repairs any damage discovered during the scrub<br><br />
When scrubbing a pool with encrypted filesystems the keys do not need to be loaded. However, if the keys are not loaded and an unrepairable checksum error is detected the file name cannot be included in the zpool status -v verbose error report.<br><br />
A scrub is split into two parts: metadata scanning and block scrubbing. The metadata scanning sorts blocks into large sequential ranges which can then be read much more efficiently from disk when issuing the scrub I/O.}}<br />
<br />
== Creating the script ==<br />
<br />
This script is used to list the pools, make sure they are online, and no scrub is being done at the time.<br><br />
We will write it in '''/usr/libexec/zfs/scrub'''<br><br />
It's taken from debian zfs scripts<br />
<br />
<pre><br />
#!/bin/sh -eu<br />
<br />
# directly exit successfully when zfs module is not loaded<br />
if ! [ -d /sys/module/zfs ]; then<br />
exit 0<br />
fi<br />
<br />
# [auto] / enable / disable<br />
PROPERTY_NAME="org.alpine:periodic-scrub"<br />
<br />
get_property () {<br />
# Detect the ${PROPERTY_NAME} property on a given pool.<br />
# We are abusing user-defined properties on the root dataset,<br />
# since they're not available on pools https://github.com/openzfs/zfs/pull/11680<br />
# TODO: use zpool user-defined property when such feature is available.<br />
pool="$1"<br />
zfs get -H -o value "${PROPERTY_NAME}" "${pool}" 2>/dev/null || return 1<br />
}<br />
<br />
scrub_if_not_scrub_in_progress () {<br />
pool="$1"<br />
if ! zpool status "${pool}" | grep -q "scrub in progress"; then<br />
# Ignore errors and continue with scrubbing other pools.<br />
zpool scrub "${pool}" || true<br />
fi<br />
}<br />
<br />
# Scrub all healthy pools that are not already scrubbing as per their configs.<br />
zpool list -H -o health,name 2>&1 | \<br />
awk -F'\t' '$1 == "ONLINE" {print $2}' | \<br />
while read pool<br />
do<br />
# read user-defined config<br />
ret=$(get_property "${pool}")<br />
if [ $? -ne 0 ] || [ "disable" = "${ret}" ]; then<br />
:<br />
elif [ "-" = "${ret}" ] || [ "auto" = "${ret}" ] || [ "enable" = "${ret}" ]; then<br />
scrub_if_not_scrub_in_progress "${pool}"<br />
else<br />
cat > /dev/stderr <<EOF<br />
$0: [WARNING] illegal value "${ret}" for property "${PROPERTY_NAME}" of ZFS dataset "${pool}".<br />
$0: Acceptable choices for this property are: auto, enable, disable. The default is auto.<br />
EOF<br />
fi<br />
done<br />
</pre><br />
<br />
Then make the script executable<br />
# chmod +x /usr/libexec/zfs/script<br />
<br />
== Launching the scrub script with cron ==<br />
<br />
It is recommanded to launch a scrub regularly to assure your pool(s) and datas are in good shape.<br><br />
Here, the scrub will be launched once a month, on the 2nd sunday of the month.<br />
<br />
In root, edit your crontabs<br />
# crontab -e<br />
<br />
and add these 2 lines<br />
<pre><br />
# zfs scrub the second sunday of every month<br />
24 0 8-14 * * if [ $(date +\%w) -eq 0 ] && [ -x /usr/libexec/zfs/scrub ]; then /usr/libexec/zfs/scrub; fi<br />
</pre><br />
<br />
Finally, make sure cron is launched:<br />
# rc-update<br />
<br />
There should be a ligne saying<br />
<pre>crond | default</pre><br />
<br />
If not, add it to the boot sequence<br />
# rc-update add crond<br />
<br />
then start the crond daemon<br />
# rc-service crond start<br />
<br />
= Trim =</div>Dju92https://wiki.alpinelinux.org/w/index.php?title=Bootloaders&diff=24188Bootloaders2023-08-09T13:15:20Z<p>Dju92: added details for grub</p>
<hr />
<div><br />
This page shows the basic steps you need to perform, if you for any reason want to switch bootloaders or apply some manual configuration.<br />
<br />
<br />
<code>rEFInd</code> is an easy to use EFI boot menu that allows booting different operating systems.<br><br />
<code>Syslinux</code> is the default light-weight bootloader used in Alpine.<br><br />
<code>Grub</code> is a standard linux boot loader.<br><br />
<code>EFI Boot Stub</code> allows booting linux directly from a motherboard supporting UEFI or another bootloader.<br><br />
<br />
<br />
<br />
= rEFIind =<br />
<br />
For (U)EFI systems, the <code>refind</code> package can provide a graphical EFI boot menu that allows to boot operating systems that are found on the available partitions.<br />
<br />
If <code>refind</code> is not yet available in the used alpine release, it may be installed in another dual/multi-booted linux distribution.<br />
<br />
For example, with a Debian based distribution, it can be installed to the EFI partition like this:<br />
<br />
apt install refind # installs the debian package<br />
refind-install --alldrivers # installs refind to the EFI partition<br />
<br />
(The --alldrivers option includes all filesystem drivers instead of only the one needed to load the currently running kernel, to allow finding and booting operating systems from more partitions.)<br />
<br />
And a first (default) boot menu line needs to be configured with Alpine's default boot parameters. Assuming the bootable partition is mounted at <code>/media/sdXY</code> it can be done like this (at time of writing):<br />
echo '"Alpine" "modules=loop,squashfs,sd-mod,usb-storage quiet initrd=\boot\intel-ucode.img initrd=\boot\amd-ucode.img initrd=\boot\initramfs-lts"' > /media/sdXY/boot/refind_linux.conf<br />
<br />
{{Note|<br />
<br />
# At the time of writing, it was still needed to use backslashes in the .conf file. <br />
# The path in the config file needs to be relative to the partition that the kernel resides on. If <code>/boot</code> resides on its own separate partition, then <code>\boot</code> needs to be removed from the paths. }}<br />
<br />
= Installing Syslinux =<br />
<br />
If you want to switch from another bootloader back to Syslinux, or if you for some reason want to install Syslinux manually, the following steps are required.<br />
<br />
Install the <code>syslinux</code> package:<br />
<br />
<pre>apk add syslinux</pre><br />
<br />
If you're using GPT partitions, install the GPT MBR onto the drive you want to install the bootloader on (in this case <code>/dev/sda</code>):<br />
<br />
<pre>dd bs=440 count=1 conv=notrunc if=/usr/share/syslinux/gptmbr.bin of=/dev/sda</pre><br />
<br />
Or if you're using DOS partitions, install the DOS MBR instead:<br />
<br />
<pre>dd bs=440 count=1 conv=notrunc if=/usr/share/syslinux/mbr.bin of=/dev/sda</pre><br />
<br />
<!-- See also: http://www.syslinux.org/wiki/index.php?title=Mbr --><br />
<br />
Next install the required Syslinux binaries. Despite being called <code>extlinux</code>, Syslinux supports booting from FAT12/16/32, NTFS, ext2/3/4, [[Btrfs|btrfs]], XFS, and UFS/FFS filesystems.<br />
<br />
<pre>extlinux --install /boot</pre><br />
<br />
The configuration file is located in <code>/boot/extlinux.conf</code>.<br />
Alpine ships with a script called <code>update-extlinux</code> which automatically (re)generates this file, for example on updates to Syslinux.<br />
The settings for this script can be found in <code>/etc/update-extlinux.conf</code>, including the option to disable automatic overwriting of <code>/boot/extlinux.conf</code>.<br />
You can also place additional menu entries in the <code>/etc/update-extlinux.d/</code> directory, e.g. for dual booting.<br />
<br />
<br />
=== EFI ===<br />
<br />
{{Todo|Work in progress. This should at least get you started.}}<br />
<br />
Assuming <code>/mnt</code> is a FAT32 partition of type EF00 and <code>/boot</code> belongs to the rootfs created after running <code>setup-disk</code>:<br />
<br />
<pre><br />
mkdir -p /mnt/EFI/syslinux<br />
cp /usr/share/syslinux/efi64/* /mnt/EFI/syslinux/<br />
cp /boot/extlinux.conf /mnt/EFI/syslinux/syslinux.cfg<br />
cp /boot/vmlinuz* /mnt/EFI/syslinux/<br />
cp /boot/initramfs* /mnt/EFI/syslinux/<br />
</pre><br />
<br />
You may need to modify <code>/mnt/EFI/syslinux/syslinux.cfg</code> to change the paths to absolute paths (just add a / in front of the vmlinuz/initramfs entries),<br />
or copy the files to <code>/mnt/EFI/syslinux</code> instead (XXX: untested).<br />
<br />
At the end, the file /mnt/EFI/syslinux/syslinux.cfg should look like this:<br />
<pre><br />
DEFAULT menu.c32<br />
PROMPT 0<br />
MENU TITLE Alpine/Linux Boot Menu<br />
MENU HIDDEN<br />
MENU AUTOBOOT Alpine will be booted automatically in # seconds<br />
TIMEOUT 10<br />
LABEL lts<br />
MENU DEFAULT<br />
MENU LABEL Linux lts<br />
LINUX /vmlinuz-lts<br />
INITRD /initrd-lts<br />
APPEND root=/dev/sda3 modules=sd-load,usb-storage,ext4 quiet<br />
</pre><br />
<br />
And finally, add syslinux to EFI boot menu (assuming /dev/sda is your hard drive)<br />
'''<pre><br />
apk add efibootmgr<br />
efibootmgr -c -d /dev/sda -p 1 -l \\EFI\\syslinux\\syslinux.efi -L "ALPINE-SYSLINUX"<br />
</pre>'''<br />
<br />
You can now verify that the boot entry has been added<br />
<br />
'''efibootmgr'''<br />
<pre><br />
BootCurrent: 0001<br />
Timeout: 0 seconds<br />
BootOrder: 0001,0000,0002,...<br />
Boot001* ALPINE-SYSLINUX HD(1,GPT,xxxxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx)/FILE(\EFI\syslinux\syslinux.efi)<br />
</pre><br />
<br />
= GRUB =<br />
<br />
To install GRUB in BIOS mode, (optionally) remove the Syslinux package and install the required GRUB packages:<br />
<br />
<pre>apk del syslinux<br />
apk add grub grub-bios</pre><br />
<br />
For EFI, install Grub's EFI package instead. Note that <code>/boot</code> has to be an EFI compatible filesystem like FAT32.<br />
<br />
<pre>apk add grub-efi efibootmgr</pre><br />
<br />
Next install the MBR and GRUB binaries to disk for BIOS mode:<br />
<br />
<pre>grub-install /dev/vda</pre><br />
<br />
For EFI mode:<br />
<br />
<pre>grub-install --target=x86_64-efi --efi-directory=/boot</pre><br />
<br />
then add this line to /etc/default/grub:<br />
<pre>GRUB_CMDLINE_LINUX_DEFAULT="quiet rootfstype=ext4 modules=sd-mod,usb-storage,ext4"</pre><br />
<br />
GRUB ships with an automatic config generator, including some automatic detection of other operating systems installed on the device:<br />
<br />
<pre>grub-mkconfig -o /boot/grub/grub.cfg</pre><br />
<br />
This script can be configured via the <code>/etc/default/grub</code> file.<br />
See [https://www.gnu.org/software/grub/manual/html_node/Simple-configuration.html] for a list of available options.<br />
<br />
= EFI Boot Stub =<br />
<br />
To boot directly from your motherboard's UEFI boot menu, a boot entry needs<br />
to be created with either a UEFI shell or ''efibootmgr''.<br />
<br />
== efibootmgr ==<br />
<br />
Install efibootmgr:<br />
<pre>apk add efibootmgr</pre><br />
<br />
Create a boot entry. It's recommended to do this in a script, as efibootmgr<br />
does not allow editing entries.<br />
<br />
<pre>#!/bin/sh<br />
<br />
params="root=/dev/sdXZ rootfstype=ext4 rw \<br />
initrd=\intel-ucode.img \<br />
initrd=\initramfs-lts"<br />
<br />
efibootmgr --create --label "Alpine Linux" \<br />
--disk /dev/sdX --part Y \<br />
--loader /vmlinuz-lts \<br />
--unicode "${params}" \<br />
--verbose<br />
</pre><br />
<br />
Where <code>/dev/sdXY</code> contains the EFI partition and <code>/dev/sdXZ</code> contains the root partition. If you are using {{Pkg|linux-edge}}, replace <code>lts</code> with <code>edge</code> in the script<br />
<br />
{{Note|<br />
The kernel contains the [https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/tree/init/do_mounts.c#n254 exhaustive list] of ways to specify the block device. For a more robust boot entry, it is recommended to use a persistent name such as the PARTUUID.<br />
}}<br />
<br />
Optionally, set the newly created entry as the default:<br />
<br />
<pre>efibootmgr -n XXXX</pre><br />
<br />
Where <code>XXXX</code> is the boot number of the new entry.<br />
<br />
{{Note|<br />
The loader and initrd file arguments are relative to the EFI partition. In a default installation, alpine places these files in <code>/boot/</code>, while EFI is mounted to <code>/boot/efi/</code>. You can either update fstab to mount EFI at <code>/boot/</code>, or manually copy them to <code>/boot/efi/</code>. }}<br />
<br />
= Using a UKI (UEFI only) =<br />
<br />
It is possible to boot directly into a '''Unified Kernel Image''' (UKI). A UKI is a single file which contains the initfs, kernel and cmdline. While this is typically done in order to enable [https://en.wikipedia.org/wiki/UEFI SecureBoot], it is perfectly feasible to skip enrolling the custom keys and leave SecureBoot off.<br />
<br />
The page [[UEFI Secure Boot]] contains the instructions for setting an a UKI. Additionally, it is possible to install the UKI in the default fallback path used by most UEFI implementations. By installing the UKI into this path, the system will automatically boot into it if no other entries are defined. This can be automated as part of the kernel hook by adding the following to <code>/etc/kernel-hooks.d/secureboot.conf</code><br />
<br />
<pre><br />
# For the edge kernel, install the UKI into the default UEFI path.<br />
if [ "$1" == "edge" ]; then<br />
output_dir="/efi/EFI/Boot/"<br />
output_name="bootx64.efi"<br />
fi<br />
</pre><br />
<br />
<code>bootx64.efi</code> is only correct for <code>x86_64</code> systems. For other architectures the exact name will vary.<br />
<br />
= External Links =<br />
* [https://www.denx.de/wiki/U-Boot/ReleaseCycle U-Boot Release Cycle]<br />
<br />
[[Category:Installation]]<br />
[[Category:Booting]]</div>Dju92https://wiki.alpinelinux.org/w/index.php?title=Bootloaders&diff=24187Bootloaders2023-08-08T23:58:47Z<p>Dju92: efibootmgr needed by grub-efi</p>
<hr />
<div><br />
This page shows the basic steps you need to perform, if you for any reason want to switch bootloaders or apply some manual configuration.<br />
<br />
<br />
<code>rEFInd</code> is an easy to use EFI boot menu that allows booting different operating systems.<br><br />
<code>Syslinux</code> is the default light-weight bootloader used in Alpine.<br><br />
<code>Grub</code> is a standard linux boot loader.<br><br />
<code>EFI Boot Stub</code> allows booting linux directly from a motherboard supporting UEFI or another bootloader.<br><br />
<br />
<br />
<br />
= rEFIind =<br />
<br />
For (U)EFI systems, the <code>refind</code> package can provide a graphical EFI boot menu that allows to boot operating systems that are found on the available partitions.<br />
<br />
If <code>refind</code> is not yet available in the used alpine release, it may be installed in another dual/multi-booted linux distribution.<br />
<br />
For example, with a Debian based distribution, it can be installed to the EFI partition like this:<br />
<br />
apt install refind # installs the debian package<br />
refind-install --alldrivers # installs refind to the EFI partition<br />
<br />
(The --alldrivers option includes all filesystem drivers instead of only the one needed to load the currently running kernel, to allow finding and booting operating systems from more partitions.)<br />
<br />
And a first (default) boot menu line needs to be configured with Alpine's default boot parameters. Assuming the bootable partition is mounted at <code>/media/sdXY</code> it can be done like this (at time of writing):<br />
echo '"Alpine" "modules=loop,squashfs,sd-mod,usb-storage quiet initrd=\boot\intel-ucode.img initrd=\boot\amd-ucode.img initrd=\boot\initramfs-lts"' > /media/sdXY/boot/refind_linux.conf<br />
<br />
{{Note|<br />
<br />
# At the time of writing, it was still needed to use backslashes in the .conf file. <br />
# The path in the config file needs to be relative to the partition that the kernel resides on. If <code>/boot</code> resides on its own separate partition, then <code>\boot</code> needs to be removed from the paths. }}<br />
<br />
= Installing Syslinux =<br />
<br />
If you want to switch from another bootloader back to Syslinux, or if you for some reason want to install Syslinux manually, the following steps are required.<br />
<br />
Install the <code>syslinux</code> package:<br />
<br />
<pre>apk add syslinux</pre><br />
<br />
If you're using GPT partitions, install the GPT MBR onto the drive you want to install the bootloader on (in this case <code>/dev/sda</code>):<br />
<br />
<pre>dd bs=440 count=1 conv=notrunc if=/usr/share/syslinux/gptmbr.bin of=/dev/sda</pre><br />
<br />
Or if you're using DOS partitions, install the DOS MBR instead:<br />
<br />
<pre>dd bs=440 count=1 conv=notrunc if=/usr/share/syslinux/mbr.bin of=/dev/sda</pre><br />
<br />
<!-- See also: http://www.syslinux.org/wiki/index.php?title=Mbr --><br />
<br />
Next install the required Syslinux binaries. Despite being called <code>extlinux</code>, Syslinux supports booting from FAT12/16/32, NTFS, ext2/3/4, [[Btrfs|btrfs]], XFS, and UFS/FFS filesystems.<br />
<br />
<pre>extlinux --install /boot</pre><br />
<br />
The configuration file is located in <code>/boot/extlinux.conf</code>.<br />
Alpine ships with a script called <code>update-extlinux</code> which automatically (re)generates this file, for example on updates to Syslinux.<br />
The settings for this script can be found in <code>/etc/update-extlinux.conf</code>, including the option to disable automatic overwriting of <code>/boot/extlinux.conf</code>.<br />
You can also place additional menu entries in the <code>/etc/update-extlinux.d/</code> directory, e.g. for dual booting.<br />
<br />
<br />
=== EFI ===<br />
<br />
{{Todo|Work in progress. This should at least get you started.}}<br />
<br />
Assuming <code>/mnt</code> is a FAT32 partition of type EF00 and <code>/boot</code> belongs to the rootfs created after running <code>setup-disk</code>:<br />
<br />
<pre><br />
mkdir -p /mnt/EFI/syslinux<br />
cp /usr/share/syslinux/efi64/* /mnt/EFI/syslinux/<br />
cp /boot/extlinux.conf /mnt/EFI/syslinux/syslinux.cfg<br />
cp /boot/vmlinuz* /mnt/EFI/syslinux/<br />
cp /boot/initramfs* /mnt/EFI/syslinux/<br />
</pre><br />
<br />
You may need to modify <code>/mnt/EFI/syslinux/syslinux.cfg</code> to change the paths to absolute paths (just add a / in front of the vmlinuz/initramfs entries),<br />
or copy the files to <code>/mnt/EFI/syslinux</code> instead (XXX: untested).<br />
<br />
At the end, the file /mnt/EFI/syslinux/syslinux.cfg should look like this:<br />
<pre><br />
DEFAULT menu.c32<br />
PROMPT 0<br />
MENU TITLE Alpine/Linux Boot Menu<br />
MENU HIDDEN<br />
MENU AUTOBOOT Alpine will be booted automatically in # seconds<br />
TIMEOUT 10<br />
LABEL lts<br />
MENU DEFAULT<br />
MENU LABEL Linux lts<br />
LINUX /vmlinuz-lts<br />
INITRD /initrd-lts<br />
APPEND root=/dev/sda3 modules=sd-load,usb-storage,ext4 quiet<br />
</pre><br />
<br />
And finally, add syslinux to EFI boot menu (assuming /dev/sda is your hard drive)<br />
'''<pre><br />
apk add efibootmgr<br />
efibootmgr -c -d /dev/sda -p 1 -l \\EFI\\syslinux\\syslinux.efi -L "ALPINE-SYSLINUX"<br />
</pre>'''<br />
<br />
You can now verify that the boot entry has been added<br />
<br />
'''efibootmgr'''<br />
<pre><br />
BootCurrent: 0001<br />
Timeout: 0 seconds<br />
BootOrder: 0001,0000,0002,...<br />
Boot001* ALPINE-SYSLINUX HD(1,GPT,xxxxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx)/FILE(\EFI\syslinux\syslinux.efi)<br />
</pre><br />
<br />
= GRUB =<br />
<br />
To install GRUB in BIOS mode, (optionally) remove the Syslinux package and install the required GRUB packages:<br />
<br />
<pre>apk del syslinux<br />
apk add grub grub-bios</pre><br />
<br />
For EFI, install Grub's EFI package instead. Note that <code>/boot</code> has to be an EFI compatible filesystem like FAT32.<br />
<br />
<pre>apk add grub-efi efibootmgr</pre><br />
<br />
Next install the MBR and GRUB binaries to disk for BIOS mode:<br />
<br />
<pre>grub-install /dev/vda</pre><br />
<br />
For EFI mode:<br />
<br />
<pre>grub-install --target=x86_64-efi --efi-directory=/boot</pre><br />
<br />
GRUB ships with an automatic config generator, including some automatic detection of other operating systems installed on the device:<br />
<br />
<pre>grub-mkconfig -o /boot/grub/grub.cfg</pre><br />
<br />
This script can be configured via the <code>/etc/default/grub</code> file.<br />
See [https://www.gnu.org/software/grub/manual/html_node/Simple-configuration.html] for a list of available options.<br />
<br />
= EFI Boot Stub =<br />
<br />
To boot directly from your motherboard's UEFI boot menu, a boot entry needs<br />
to be created with either a UEFI shell or ''efibootmgr''.<br />
<br />
== efibootmgr ==<br />
<br />
Install efibootmgr:<br />
<pre>apk add efibootmgr</pre><br />
<br />
Create a boot entry. It's recommended to do this in a script, as efibootmgr<br />
does not allow editing entries.<br />
<br />
<pre>#!/bin/sh<br />
<br />
params="root=/dev/sdXZ rootfstype=ext4 rw \<br />
initrd=\intel-ucode.img \<br />
initrd=\initramfs-lts"<br />
<br />
efibootmgr --create --label "Alpine Linux" \<br />
--disk /dev/sdX --part Y \<br />
--loader /vmlinuz-lts \<br />
--unicode "${params}" \<br />
--verbose<br />
</pre><br />
<br />
Where <code>/dev/sdXY</code> contains the EFI partition and <code>/dev/sdXZ</code> contains the root partition. If you are using {{Pkg|linux-edge}}, replace <code>lts</code> with <code>edge</code> in the script<br />
<br />
{{Note|<br />
The kernel contains the [https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/tree/init/do_mounts.c#n254 exhaustive list] of ways to specify the block device. For a more robust boot entry, it is recommended to use a persistent name such as the PARTUUID.<br />
}}<br />
<br />
Optionally, set the newly created entry as the default:<br />
<br />
<pre>efibootmgr -n XXXX</pre><br />
<br />
Where <code>XXXX</code> is the boot number of the new entry.<br />
<br />
{{Note|<br />
The loader and initrd file arguments are relative to the EFI partition. In a default installation, alpine places these files in <code>/boot/</code>, while EFI is mounted to <code>/boot/efi/</code>. You can either update fstab to mount EFI at <code>/boot/</code>, or manually copy them to <code>/boot/efi/</code>. }}<br />
<br />
= Using a UKI (UEFI only) =<br />
<br />
It is possible to boot directly into a '''Unified Kernel Image''' (UKI). A UKI is a single file which contains the initfs, kernel and cmdline. While this is typically done in order to enable [https://en.wikipedia.org/wiki/UEFI SecureBoot], it is perfectly feasible to skip enrolling the custom keys and leave SecureBoot off.<br />
<br />
The page [[UEFI Secure Boot]] contains the instructions for setting an a UKI. Additionally, it is possible to install the UKI in the default fallback path used by most UEFI implementations. By installing the UKI into this path, the system will automatically boot into it if no other entries are defined. This can be automated as part of the kernel hook by adding the following to <code>/etc/kernel-hooks.d/secureboot.conf</code><br />
<br />
<pre><br />
# For the edge kernel, install the UKI into the default UEFI path.<br />
if [ "$1" == "edge" ]; then<br />
output_dir="/efi/EFI/Boot/"<br />
output_name="bootx64.efi"<br />
fi<br />
</pre><br />
<br />
<code>bootx64.efi</code> is only correct for <code>x86_64</code> systems. For other architectures the exact name will vary.<br />
<br />
= External Links =<br />
* [https://www.denx.de/wiki/U-Boot/ReleaseCycle U-Boot Release Cycle]<br />
<br />
[[Category:Installation]]<br />
[[Category:Booting]]</div>Dju92https://wiki.alpinelinux.org/w/index.php?title=Bootstrapping_Alpine_Linux&diff=24186Bootstrapping Alpine Linux2023-08-08T11:31:18Z<p>Dju92: setup network before setting up repos</p>
<hr />
<div><br />
<br />
= VPS =<br />
This section is to provide a means to bootstrap Alpine Linux on any VPS.<br />
<br />
== Process ==<br />
<br />
=== Prepare ===<br />
<ol><br />
<li>Download apk-tools-static for your architecture.</li><br />
<pre>wget https://gitlab.alpinelinux.org/api/v4/projects/5/packages/generic/v2.14.0/x86_64/apk.static</pre><br />
<br />
<li>Unpack .apk</li><br />
<pre>tar zxf apk-tools-static-*.apk</pre><br />
<br />
</ol><br />
<br />
=== Install ===<br />
<br />
Assuming your alpine rootfs is mounted in '''/tmp/target'''<br />
<br />
<code>sudo ./sbin/apk.static --arch $(arch) -X http://dl-cdn.alpinelinux.org/alpine/latest-stable/main/ -U --allow-untrusted --root /tmp/target --initdb add alpine-base</code><br />
<br />
* edit /tmp/target/etc/fstab<br />
* edit /tmp/target/etc/inittab<br />
* edit /tmp/target/etc/resolv.conf<br />
* mount proc/sys/dev<br />
<pre>for a in proc sys dev; do mount -o bind /$a /tmp/target/$a; done</pre><br />
* chroot into your new installation<br />
<pre>chroot /tmp/target /bin/sh</pre><br />
* setup hostname<br />
<pre>setup-hostname</pre><br />
* setup network<br />
<pre>setup-interfaces</pre><br />
* setup repos<br />
<pre>setup-apkrepos -f</pre><br />
* add a few base packages<br />
<pre>apk update<br />
apk add linux-lts linux-firmware-none acpi mkinitfs</pre><br />
* add services to boot<br />
<pre><br />
rc-update add acpid default<br />
rc-update add bootmisc boot<br />
rc-update add crond default<br />
rc-update add devfs sysinit<br />
rc-update add dmesg sysinit<br />
rc-update add hostname boot<br />
rc-update add hwclock boot<br />
rc-update add hwdrivers sysinit<br />
rc-update add killprocs shutdown<br />
rc-update add mdev sysinit<br />
rc-update add modules boot<br />
rc-update add mount-ro shutdown<br />
rc-update add networking boot<br />
rc-update add savecache shutdown<br />
rc-update add seedrng boot<br />
rc-update add swap boot<br />
</pre><br />
<br />
=== Bootloader ===<br />
<br />
<br />
== References ==<br />
* [https://www.linode.com/docs/tools-reference/custom-kernels-distros/running-a-custom-linux-distro-on-a-linode-vps Running a Custom Linux Distribution on a Linode]<br />
* [https://www.linode.com/docs/tools-reference/custom-kernels-distros/run-a-custom-compiled-kernel-with-pvgrub Run a Custom Compiled Kernel with PV-GRUB]<br />
* [[Replacing non-Alpine Linux with Alpine remotely]]<br />
* [[Install Alpine on Amazon EC2]]<br />
* [[Install Alpine on coLinux]]<br />
* [[Install Alpine on Rackspace]]<br />
* [[Alpine setup scripts]]<br />
* [https://serverfault.com/questions/98950/how-do-i-chain-boot-from-grub-to-syslinux How do I chain boot from grub to syslinux?]<br />
* [https://web.archive.org/web/20151008232205/http://uggedal.com/journal/alpine-linux-on-linode/ Alpine Linux on Linode]<br />
* [[Installing Alpine Linux in a chroot]]<br />
<br />
[[Category:Installation]]<br />
[[Category:Virtualization]]</div>Dju92https://wiki.alpinelinux.org/w/index.php?title=Bootstrapping_Alpine_Linux&diff=24185Bootstrapping Alpine Linux2023-08-08T11:22:52Z<p>Dju92: better formatting</p>
<hr />
<div><br />
<br />
= VPS =<br />
This section is to provide a means to bootstrap Alpine Linux on any VPS.<br />
<br />
== Process ==<br />
<br />
=== Prepare ===<br />
<ol><br />
<li>Download apk-tools-static for your architecture.</li><br />
<pre>wget https://gitlab.alpinelinux.org/api/v4/projects/5/packages/generic/v2.14.0/x86_64/apk.static</pre><br />
<br />
<li>Unpack .apk</li><br />
<pre>tar zxf apk-tools-static-*.apk</pre><br />
<br />
</ol><br />
<br />
=== Install ===<br />
<br />
Assuming your alpine rootfs is mounted in '''/tmp/target'''<br />
<br />
<code>sudo ./sbin/apk.static --arch $(arch) -X http://dl-cdn.alpinelinux.org/alpine/latest-stable/main/ -U --allow-untrusted --root /tmp/target --initdb add alpine-base</code><br />
<br />
* edit /tmp/target/etc/fstab<br />
* edit /tmp/target/etc/inittab<br />
* edit /tmp/target/etc/resolv.conf<br />
* mount proc/sys/dev<br />
<pre>for a in proc sys dev; do mount -o bind /$a /tmp/target/$a; done</pre><br />
* chroot into your new installation<br />
<pre>chroot /tmp/target /bin/sh</pre><br />
<br />
* setup repos<br />
<pre>setup-apkrepos -f</pre><br />
* add a few base packages<br />
<pre>apk update<br />
apk add linux-lts linux-firmware-none acpi mkinitfs</pre><br />
* setup hostname<br />
<pre>setup-hostname</pre><br />
* setup network<br />
<pre>setup-interfaces</pre><br />
* add services to boot<br />
<pre><br />
rc-update add acpid default<br />
rc-update add bootmisc boot<br />
rc-update add crond default<br />
rc-update add devfs sysinit<br />
rc-update add dmesg sysinit<br />
rc-update add hostname boot<br />
rc-update add hwclock boot<br />
rc-update add hwdrivers sysinit<br />
rc-update add killprocs shutdown<br />
rc-update add mdev sysinit<br />
rc-update add modules boot<br />
rc-update add mount-ro shutdown<br />
rc-update add networking boot<br />
rc-update add savecache shutdown<br />
rc-update add seedrng boot<br />
rc-update add swap boot<br />
</pre><br />
<br />
=== Bootloader ===<br />
<br />
<br />
== References ==<br />
* [https://www.linode.com/docs/tools-reference/custom-kernels-distros/running-a-custom-linux-distro-on-a-linode-vps Running a Custom Linux Distribution on a Linode]<br />
* [https://www.linode.com/docs/tools-reference/custom-kernels-distros/run-a-custom-compiled-kernel-with-pvgrub Run a Custom Compiled Kernel with PV-GRUB]<br />
* [[Replacing non-Alpine Linux with Alpine remotely]]<br />
* [[Install Alpine on Amazon EC2]]<br />
* [[Install Alpine on coLinux]]<br />
* [[Install Alpine on Rackspace]]<br />
* [[Alpine setup scripts]]<br />
* [https://serverfault.com/questions/98950/how-do-i-chain-boot-from-grub-to-syslinux How do I chain boot from grub to syslinux?]<br />
* [https://web.archive.org/web/20151008232205/http://uggedal.com/journal/alpine-linux-on-linode/ Alpine Linux on Linode]<br />
* [[Installing Alpine Linux in a chroot]]<br />
<br />
[[Category:Installation]]<br />
[[Category:Virtualization]]</div>Dju92https://wiki.alpinelinux.org/w/index.php?title=Bootstrapping_Alpine_Linux&diff=24184Bootstrapping Alpine Linux2023-08-08T11:19:53Z<p>Dju92: added linux-firmware-none to not install ~1G of useless firmwares on a vm/vps</p>
<hr />
<div><br />
<br />
= VPS =<br />
This section is to provide a means to bootstrap Alpine Linux on any VPS.<br />
<br />
== Process ==<br />
<br />
=== Prepare ===<br />
<ol><br />
<li>Download apk-tools-static for your architecture.</li><br />
<pre>wget https://gitlab.alpinelinux.org/api/v4/projects/5/packages/generic/v2.14.0/x86_64/apk.static</pre><br />
<br />
<li>Unpack .apk</li><br />
<pre>tar zxf apk-tools-static-*.apk</pre><br />
<br />
</ol><br />
<br />
=== Install ===<br />
<br />
Assuming your alpine rootfs is mounted in '''/tmp/target'''<br />
<br />
<code>sudo ./sbin/apk.static --arch $(arch) -X http://dl-cdn.alpinelinux.org/alpine/latest-stable/main/ -U --allow-untrusted --root /tmp/target --initdb add alpine-base</code><br />
<br />
* edit /tmp/target/etc/fstab<br />
* edit /tmp/target/etc/inittab<br />
* edit /tmp/target/etc/resolv.conf<br />
* mount proc/sys/dev<br />
<pre>for a in proc sys dev; do mount -o bind /$a /tmp/target/$a; done</pre><br />
* chroot into your new installation<br />
<pre>chroot /tmp/target /bin/sh</pre><br />
<br />
* setup repos (setup-apkrepos -f)<br />
* add a few base packages (apk update && apk add linux-lts linux-firmware-none acpi mkinitfs)<br />
* setup hostname (setup-hostname)<br />
* setup network (setup-interfaces)<br />
* add services<br />
<pre><br />
rc-update add acpid default<br />
rc-update add bootmisc boot<br />
rc-update add crond default<br />
rc-update add devfs sysinit<br />
rc-update add dmesg sysinit<br />
rc-update add hostname boot<br />
rc-update add hwclock boot<br />
rc-update add hwdrivers sysinit<br />
rc-update add killprocs shutdown<br />
rc-update add mdev sysinit<br />
rc-update add modules boot<br />
rc-update add mount-ro shutdown<br />
rc-update add networking boot<br />
rc-update add savecache shutdown<br />
rc-update add seedrng boot<br />
rc-update add swap boot<br />
</pre><br />
<br />
=== Bootloader ===<br />
<br />
<br />
== References ==<br />
* [https://www.linode.com/docs/tools-reference/custom-kernels-distros/running-a-custom-linux-distro-on-a-linode-vps Running a Custom Linux Distribution on a Linode]<br />
* [https://www.linode.com/docs/tools-reference/custom-kernels-distros/run-a-custom-compiled-kernel-with-pvgrub Run a Custom Compiled Kernel with PV-GRUB]<br />
* [[Replacing non-Alpine Linux with Alpine remotely]]<br />
* [[Install Alpine on Amazon EC2]]<br />
* [[Install Alpine on coLinux]]<br />
* [[Install Alpine on Rackspace]]<br />
* [[Alpine setup scripts]]<br />
* [https://serverfault.com/questions/98950/how-do-i-chain-boot-from-grub-to-syslinux How do I chain boot from grub to syslinux?]<br />
* [https://web.archive.org/web/20151008232205/http://uggedal.com/journal/alpine-linux-on-linode/ Alpine Linux on Linode]<br />
* [[Installing Alpine Linux in a chroot]]<br />
<br />
[[Category:Installation]]<br />
[[Category:Virtualization]]</div>Dju92https://wiki.alpinelinux.org/w/index.php?title=Bootstrapping_Alpine_Linux&diff=24183Bootstrapping Alpine Linux2023-08-08T11:15:55Z<p>Dju92: edit for mkinitfs</p>
<hr />
<div><br />
<br />
= VPS =<br />
This section is to provide a means to bootstrap Alpine Linux on any VPS.<br />
<br />
== Process ==<br />
<br />
=== Prepare ===<br />
<ol><br />
<li>Download apk-tools-static for your architecture.</li><br />
<pre>wget https://gitlab.alpinelinux.org/api/v4/projects/5/packages/generic/v2.14.0/x86_64/apk.static</pre><br />
<br />
<li>Unpack .apk</li><br />
<pre>tar zxf apk-tools-static-*.apk</pre><br />
<br />
</ol><br />
<br />
=== Install ===<br />
<br />
Assuming your alpine rootfs is mounted in '''/tmp/target'''<br />
<br />
<code>sudo ./sbin/apk.static --arch $(arch) -X http://dl-cdn.alpinelinux.org/alpine/latest-stable/main/ -U --allow-untrusted --root /tmp/target --initdb add alpine-base</code><br />
<br />
* edit /tmp/target/etc/fstab<br />
* edit /tmp/target/etc/inittab<br />
* edit /tmp/target/etc/resolv.conf<br />
* mount proc/sys/dev<br />
<pre>for a in proc sys dev; do mount -o bind /$a /tmp/target/$a; done</pre><br />
* chroot into your new installation<br />
<pre>chroot /tmp/target /bin/sh</pre><br />
<br />
* setup repos (setup-apkrepos -f)<br />
* add a few base packages (apk update && apk add linux-lts acpi mkinitfs)<br />
* setup hostname (setup-hostname)<br />
* setup network (setup-interfaces)<br />
* add services<br />
<pre><br />
rc-update add acpid default<br />
rc-update add bootmisc boot<br />
rc-update add crond default<br />
rc-update add devfs sysinit<br />
rc-update add dmesg sysinit<br />
rc-update add hostname boot<br />
rc-update add hwclock boot<br />
rc-update add hwdrivers sysinit<br />
rc-update add killprocs shutdown<br />
rc-update add mdev sysinit<br />
rc-update add modules boot<br />
rc-update add mount-ro shutdown<br />
rc-update add networking boot<br />
rc-update add savecache shutdown<br />
rc-update add seedrng boot<br />
rc-update add swap boot<br />
</pre><br />
<br />
=== Bootloader ===<br />
<br />
<br />
== References ==<br />
* [https://www.linode.com/docs/tools-reference/custom-kernels-distros/running-a-custom-linux-distro-on-a-linode-vps Running a Custom Linux Distribution on a Linode]<br />
* [https://www.linode.com/docs/tools-reference/custom-kernels-distros/run-a-custom-compiled-kernel-with-pvgrub Run a Custom Compiled Kernel with PV-GRUB]<br />
* [[Replacing non-Alpine Linux with Alpine remotely]]<br />
* [[Install Alpine on Amazon EC2]]<br />
* [[Install Alpine on coLinux]]<br />
* [[Install Alpine on Rackspace]]<br />
* [[Alpine setup scripts]]<br />
* [https://serverfault.com/questions/98950/how-do-i-chain-boot-from-grub-to-syslinux How do I chain boot from grub to syslinux?]<br />
* [https://web.archive.org/web/20151008232205/http://uggedal.com/journal/alpine-linux-on-linode/ Alpine Linux on Linode]<br />
* [[Installing Alpine Linux in a chroot]]<br />
<br />
[[Category:Installation]]<br />
[[Category:Virtualization]]</div>Dju92https://wiki.alpinelinux.org/w/index.php?title=Bootstrapping_Alpine_Linux&diff=24171Bootstrapping Alpine Linux2023-08-07T14:29:10Z<p>Dju92: added main guideline</p>
<hr />
<div><br />
<br />
= VPS =<br />
This section is to provide a means to bootstrap Alpine Linux on any VPS.<br />
<br />
== Process ==<br />
<br />
=== Prepare ===<br />
<ol><br />
<li>Download apk-tools-static for your architecture.</li><br />
<pre>wget https://gitlab.alpinelinux.org/api/v4/projects/5/packages/generic/v2.14.0/x86_64/apk.static</pre><br />
<br />
<li>Unpack .apk</li><br />
<pre>tar zxf apk-tools-static-*.apk</pre><br />
<br />
</ol><br />
<br />
=== Install ===<br />
<br />
Assuming your alpine rootfs is mounted in '''/tmp/target'''<br />
<br />
<code>sudo ./sbin/apk.static --arch $(arch) -X http://dl-cdn.alpinelinux.org/alpine/latest-stable/main/ -U --allow-untrusted --root /tmp/target --initdb add alpine-base</code><br />
<br />
* edit /tmp/target/etc/fstab<br />
* edit /tmp/target/etc/inittab<br />
* edit /tmp/target/etc/mkinitfs/mkinitfs.conf<br />
* edit /tmp/target/etc/resolv.conf<br />
* mount proc/sys/dev<br />
<pre>for a in proc sys dev; do mount -o bind /$a /tmp/target/$a; done</pre><br />
* chroot into your new installation<br />
<pre>chroot /tmp/target /bin/sh</pre><br />
<br />
* setup repos (setup-apkrepos -f)<br />
* add a few base packages (apk update && apk add linux-lts acpi)<br />
* setup hostname (setup-hostname)<br />
* setup network (setup-interfaces)<br />
* add services<br />
<pre><br />
rc-update add acpid default<br />
rc-update add bootmisc boot<br />
rc-update add crond default<br />
rc-update add devfs sysinit<br />
rc-update add dmesg sysinit<br />
rc-update add hostname boot<br />
rc-update add hwclock boot<br />
rc-update add hwdrivers sysinit<br />
rc-update add killprocs shutdown<br />
rc-update add mdev sysinit<br />
rc-update add modules boot<br />
rc-update add mount-ro shutdown<br />
rc-update add networking boot<br />
rc-update add savecache shutdown<br />
rc-update add seedrng boot<br />
rc-update add swap boot<br />
</pre><br />
<br />
=== Bootloader ===<br />
<br />
<br />
== References ==<br />
* [https://www.linode.com/docs/tools-reference/custom-kernels-distros/running-a-custom-linux-distro-on-a-linode-vps Running a Custom Linux Distribution on a Linode]<br />
* [https://www.linode.com/docs/tools-reference/custom-kernels-distros/run-a-custom-compiled-kernel-with-pvgrub Run a Custom Compiled Kernel with PV-GRUB]<br />
* [[Replacing non-Alpine Linux with Alpine remotely]]<br />
* [[Install Alpine on Amazon EC2]]<br />
* [[Install Alpine on coLinux]]<br />
* [[Install Alpine on Rackspace]]<br />
* [[Alpine setup scripts]]<br />
* [https://serverfault.com/questions/98950/how-do-i-chain-boot-from-grub-to-syslinux How do I chain boot from grub to syslinux?]<br />
* [https://web.archive.org/web/20151008232205/http://uggedal.com/journal/alpine-linux-on-linode/ Alpine Linux on Linode]<br />
* [[Installing Alpine Linux in a chroot]]<br />
<br />
[[Category:Installation]]<br />
[[Category:Virtualization]]</div>Dju92https://wiki.alpinelinux.org/w/index.php?title=Bootloaders&diff=24112Bootloaders2023-08-07T09:21:49Z<p>Dju92: /* EFI */</p>
<hr />
<div><br />
This page shows the basic steps you need to perform, if you for any reason want to switch bootloaders or apply some manual configuration.<br />
<br />
<br />
<code>rEFInd</code> is an easy to use EFI boot menu that allows booting different operating systems.<br><br />
<code>Syslinux</code> is the default light-weight bootloader used in Alpine.<br><br />
<code>Grub</code> is a standard linux boot loader.<br><br />
<code>EFI Boot Stub</code> allows booting linux directly from a motherboard supporting UEFI or another bootloader.<br><br />
<br />
<br />
<br />
= rEFIind =<br />
<br />
For (U)EFI systems, the <code>refind</code> package can provide a graphical EFI boot menu that allows to boot operating systems that are found on the available partitions.<br />
<br />
If <code>refind</code> is not yet available in the used alpine release, it may be installed in another dual/multi-booted linux distribution.<br />
<br />
For example, with a Debian based distribution, it can be installed to the EFI partition like this:<br />
<br />
apt install refind # installs the debian package<br />
refind-install --alldrivers # installs refind to the EFI partition<br />
<br />
(The --alldrivers option includes all filesystem drivers instead of only the one needed to load the currently running kernel, to allow finding and booting operating systems from more partitions.)<br />
<br />
And a first (default) boot menu line needs to be configured with Alpine's default boot parameters. Assuming the bootable partition is mounted at <code>/media/sdXY</code> it can be done like this (at time of writing):<br />
echo '"Alpine" "modules=loop,squashfs,sd-mod,usb-storage quiet initrd=\boot\intel-ucode.img initrd=\boot\amd-ucode.img initrd=\boot\initramfs-lts"' > /media/sdXY/boot/refind_linux.conf<br />
<br />
{{Note|<br />
<br />
# At the time of writing, it was still needed to use backslashes in the .conf file. <br />
# The path in the config file needs to be relative to the partition that the kernel resides on. If <code>/boot</code> resides on its own separate partition, then <code>\boot</code> needs to be removed from the paths. }}<br />
<br />
= Installing Syslinux =<br />
<br />
If you want to switch from another bootloader back to Syslinux, or if you for some reason want to install Syslinux manually, the following steps are required.<br />
<br />
Install the <code>syslinux</code> package:<br />
<br />
<pre>apk add syslinux</pre><br />
<br />
If you're using GPT partitions, install the GPT MBR onto the drive you want to install the bootloader on (in this case <code>/dev/sda</code>):<br />
<br />
<pre>dd bs=440 count=1 conv=notrunc if=/usr/share/syslinux/gptmbr.bin of=/dev/sda</pre><br />
<br />
Or if you're using DOS partitions, install the DOS MBR instead:<br />
<br />
<pre>dd bs=440 count=1 conv=notrunc if=/usr/share/syslinux/mbr.bin of=/dev/sda</pre><br />
<br />
<!-- See also: http://www.syslinux.org/wiki/index.php?title=Mbr --><br />
<br />
Next install the required Syslinux binaries. Despite being called <code>extlinux</code>, Syslinux supports booting from FAT12/16/32, NTFS, ext2/3/4, [[Btrfs|btrfs]], XFS, and UFS/FFS filesystems.<br />
<br />
<pre>extlinux --install /boot</pre><br />
<br />
The configuration file is located in <code>/boot/extlinux.conf</code>.<br />
Alpine ships with a script called <code>update-extlinux</code> which automatically (re)generates this file, for example on updates to Syslinux.<br />
The settings for this script can be found in <code>/etc/update-extlinux.conf</code>, including the option to disable automatic overwriting of <code>/boot/extlinux.conf</code>.<br />
You can also place additional menu entries in the <code>/etc/update-extlinux.d/</code> directory, e.g. for dual booting.<br />
<br />
<br />
=== EFI ===<br />
<br />
{{Todo|Work in progress. This should at least get you started.}}<br />
<br />
Assuming <code>/mnt</code> is a FAT32 partition of type EF00 and <code>/boot</code> belongs to the rootfs created after running <code>setup-disk</code>:<br />
<br />
<pre><br />
mkdir -p /mnt/EFI/syslinux<br />
cp /usr/share/syslinux/efi64/* /mnt/EFI/syslinux/<br />
cp /boot/extlinux.conf /mnt/EFI/syslinux/syslinux.cfg<br />
cp /boot/vmlinuz* /mnt/EFI/syslinux/<br />
cp /boot/initramfs* /mnt/EFI/syslinux/<br />
</pre><br />
<br />
You may need to modify <code>/mnt/EFI/syslinux/syslinux.cfg</code> to change the paths to absolute paths (just add a / in front of the vmlinuz/initramfs entries),<br />
or copy the files to <code>/mnt/EFI/syslinux</code> instead (XXX: untested).<br />
<br />
At the end, the file /mnt/EFI/syslinux/syslinux.cfg should look like this:<br />
<pre><br />
DEFAULT menu.c32<br />
PROMPT 0<br />
MENU TITLE Alpine/Linux Boot Menu<br />
MENU HIDDEN<br />
MENU AUTOBOOT Alpine will be booted automatically in # seconds<br />
TIMEOUT 10<br />
LABEL lts<br />
MENU DEFAULT<br />
MENU LABEL Linux lts<br />
LINUX /vmlinuz-lts<br />
INITRD /initrd-lts<br />
APPEND root=/dev/sda3 modules=sd-load,usb-storage,ext4 quiet<br />
</pre><br />
<br />
And finally, add syslinux to EFI boot menu (assuming /dev/sda is your hard drive)<br />
'''<pre><br />
apk add efibootmgr<br />
efibootmgr -c -d /dev/sda -p 1 -l \\EFI\\syslinux\\syslinux.efi -L "ALPINE-SYSLINUX"<br />
</pre>'''<br />
<br />
You can now verify that the boot entry has been added<br />
<br />
'''efibootmgr'''<br />
<pre><br />
BootCurrent: 0001<br />
Timeout: 0 seconds<br />
BootOrder: 0001,0000,0002,...<br />
Boot001* ALPINE-SYSLINUX HD(1,GPT,xxxxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx)/FILE(\EFI\syslinux\syslinux.efi)<br />
</pre><br />
<br />
= GRUB =<br />
<br />
To install GRUB in BIOS mode, (optionally) remove the Syslinux package and install the required GRUB packages:<br />
<br />
<pre>apk del syslinux<br />
apk add grub grub-bios</pre><br />
<br />
For EFI, install Grub's EFI package instead. Note that <code>/boot</code> has to be an EFI compatible filesystem like FAT32.<br />
<br />
<pre>apk add grub-efi</pre><br />
<br />
Next install the MBR and GRUB binaries to disk for BIOS mode:<br />
<br />
<pre>grub-install /dev/vda</pre><br />
<br />
For EFI mode:<br />
<br />
<pre>grub-install --target=x86_64-efi --efi-directory=/boot</pre><br />
<br />
GRUB ships with an automatic config generator, including some automatic detection of other operating systems installed on the device:<br />
<br />
<pre>grub-mkconfig -o /boot/grub/grub.cfg</pre><br />
<br />
This script can be configured via the <code>/etc/default/grub</code> file.<br />
See [https://www.gnu.org/software/grub/manual/html_node/Simple-configuration.html] for a list of available options.<br />
<br />
<br />
= EFI Boot Stub =<br />
<br />
To boot directly from your motherboard's UEFI boot menu, a boot entry needs<br />
to be created with either a UEFI shell or ''efibootmgr''.<br />
<br />
== efibootmgr ==<br />
<br />
Install efibootmgr:<br />
<pre>apk add efibootmgr</pre><br />
<br />
Create a boot entry. It's recommended to do this in a script, as efibootmgr<br />
does not allow editing entries.<br />
<br />
<pre>#!/bin/sh<br />
<br />
params="root=/dev/sdXZ rootfstype=ext4 rw \<br />
initrd=\intel-ucode.img \<br />
initrd=\initramfs-lts"<br />
<br />
efibootmgr --create --label "Alpine Linux" \<br />
--disk /dev/sdX --part Y \<br />
--loader /vmlinuz-lts \<br />
--unicode "${params}" \<br />
--verbose<br />
</pre><br />
<br />
Where <code>/dev/sdXY</code> contains the EFI partition and <code>/dev/sdXZ</code> contains the root partition. If you are using {{Pkg|linux-edge}}, replace <code>lts</code> with <code>edge</code> in the script<br />
<br />
{{Note|<br />
The kernel contains the [https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/tree/init/do_mounts.c#n254 exhaustive list] of ways to specify the block device. For a more robust boot entry, it is recommended to use a persistent name such as the PARTUUID.<br />
}}<br />
<br />
Optionally, set the newly created entry as the default:<br />
<br />
<pre>efibootmgr -n XXXX</pre><br />
<br />
Where <code>XXXX</code> is the boot number of the new entry.<br />
<br />
{{Note|<br />
The loader and initrd file arguments are relative to the EFI partition. In a default installation, alpine places these files in <code>/boot/</code>, while EFI is mounted to <code>/boot/efi/</code>. You can either update fstab to mount EFI at <code>/boot/</code>, or manually copy them to <code>/boot/efi/</code>. }}<br />
<br />
= Using a UKI (UEFI only) =<br />
<br />
It is possible to boot directly into a '''Unified Kernel Image''' (UKI). A UKI is a single file which contains the initfs, kernel and cmdline. While this is typically done in order to enable [https://en.wikipedia.org/wiki/UEFI SecureBoot], it is perfectly feasible to skip enrolling the custom keys and leave SecureBoot off.<br />
<br />
The page [[UEFI Secure Boot]] contains the instructions for setting an a UKI. Additionally, it is possible to install the UKI in the default fallback path used by most UEFI implementations. By installing the UKI into this path, the system will automatically boot into it if no other entries are defined. This can be automated as part of the kernel hook by adding the following to <code>/etc/kernel-hooks.d/secureboot.conf</code><br />
<br />
<pre><br />
# For the edge kernel, install the UKI into the default UEFI path.<br />
if [ "$1" == "edge" ]; then<br />
output_dir="/efi/EFI/Boot/"<br />
output_name="bootx64.efi"<br />
fi<br />
</pre><br />
<br />
<code>bootx64.efi</code> is only correct for <code>x86_64</code> systems. For other architectures the exact name will vary.<br />
<br />
= External Links =<br />
* [https://www.denx.de/wiki/U-Boot/ReleaseCycle U-Boot Release Cycle]<br />
<br />
[[Category:Installation]]<br />
[[Category:Booting]]</div>Dju92