Alpine Linux - User contributions [en]

Creating patches

2018-10-28T16:43:28Z

Brebs: Note that email functionality needs more than just the git package installed

Patches should be created with git and submitted to [mailto:alpine-aports@lists.alpinelinux.org alpine-aports] mailing list with ''git send-email'' (which needs the ''git-email'' Alpine package).

== Only the last commit with 'git send-email' ==

To submit the last commit as a patch to [mailto:alpine-aports@lists.alpinelinux.org alpine-aports] mailing list:

{{Cmd|git send-email --to alpine-aports@lists.alpinelinux.org -1}}

{{Tip|You save the To-address (does not require '--to alpine-aports@lists.alpinelinux.org') in the git config with: {{Cmd|git config sendemail.to alpine-aports@lists.alpinelinux.org}}}}

The first line in commit message will be ''subject'' and the long description (separated with empty line) will be the body in the email. The example below shows

<pre>
testing/packagename: new aport <- header

https://example.com/packagename <- body
wonderful package
</pre>

{{Note|The git send-email command is provided by the '''git-email''' package ('''git-perl''' in v2.7 and older). }}

See [[Development using git#Email_configuration]] on how configure SMTP Auth.

== Multiple commits with 'git send-email' ==

If you have many commits you can create a directory with patches and send them with <tt>git send-email</tt>.

{{Cmd|<nowiki>rm -Rf patches
mkdir patches
git format-patch -o patches origin
git send-email patches --compose --no-chain-reply-to --to alpine-aports@lists.alpinelinux.org</nowiki>}}

You can also format patches for the last x number of commits with:
{{Cmd|<nowiki>git format-patch -x -o patches</nowiki>}}

This will produce the patches for each local commit in the directory "patches" and send them.
Use '''--no-chain-reply-to''' to avoid that each patch is sent as a ''reply'' to the previous patch.

Eg.
* [PATCH 0/m]
** [PATCH 1/m]
*** [PATCH 2/m]
**** ...

With the option '''--no-chain-reply-to''' the patches will be sent as a reply to the first email, the ''cover letter'' (the [PATCH 0/m]) and will make the email thread nicer.
Like this:
* [PATCH 0/m]
** [PATCH 1/m]
** [PATCH 2/m]
** ..

== Resend an updated patch ==
Sometimes patches are rejected due to minor issues in the patch. Do not send an incremental patch on top of your initial, bad, patch. Instead, recreate the patch and send a new, fixed version of your patch. (use ''git commit --amend'' to edit a local commit).

When you sending a second version of the patch use '''--subject-prefix "PATCH v2"''' to indicate that this is a new version of a previously sent patch. You may also use '''--in-reply-to <message-id>''' where <message-id> the the id of email requesting the resend.

You should also write a note on the what was changed. Use '''--annotate''' for this and write the comment under the three dashes "---" so the note is not included in the commit message. For example:
<pre>
...
Subject: [PATCH v2] testing/mypackage: new aport

https://example.com
Example package
---
Changes v1 -> v2:
- removed depends
- added zlib-dev to makedepends

testing/mypackage/APKBUILD | 41 +++++++++++++++++++++++++++++++++++++++++
1 file changed, 41 insertions(+)
create mode 100644 testing/mypackage/APKBUILD
...
</pre>

Note that the notes that are below the "---" will not be included in the commit message.
[[Category:Development]]
[[Category:Git]]

== See also ==
* [[Patch Workflow]]

Udhcpc

2018-10-28T14:27:26Z

Brebs: Note that the hook scripts must be marked as executable

You may want to customize the behavior of the default DHCP client (udhcpc from busybox), which is called by /sbin/ifup by having "dhcp" in /etc/network/interfaces.

The default behavior is driven by the script /usr/share/udhcpc/default.script

Its default configuration may be overwritten by /etc/udhcpc/udhcpc.conf

Authorized key:value pairs are:

{| cellpadding="15" border="1" class="wikitable"
|-
! key
| default value
| possible values
|-
| NO_GATEWAY
| -
| <list of iface names>
|-
| IF_METRIC
| -
| <metric value>
|-
| IF_PEER_DNS
| yes
| <anything but yes>
|-
| RESOLV_CONF
| /etc/resolv.conf
| no ; NO ; -
|-
| NO_DNS
| -
| <list of iface names>
|}

Example /etc/udhcpc/udhcpc.conf:

RESOLV_CONF="no" # Prevents overwriting of /etc/resolv.conf

Custom scripts can be added as /etc/udhcpc/pre-* and /etc/udhcpc/post-* to be run before/after deconfig/renew/bound DHCP events - they must be marked as '''executable''' by root, e.g. chmod 744

As an example, /etc/udhcpc/post-bound/mtu could contain, to change the interface MTU from the default (1500) to 1492, which is useful if [https://en.wikipedia.org/wiki/Maximum_transmission_unit on ADSL] (which uses 8 bytes):

r=$(/sbin/ip route | grep ^default | head -n 1)
# Needs iproute2 package, rather than busybox's "ip", to change mtu
/sbin/ip route replace $r mtu 1492

[[Category:Networking]]
[[Category:Embedded Systems]]

Udhcpc

2018-10-28T14:12:11Z

Brebs: Add example MTU hook

You may want to customize the behavior of the default DHCP client (udhcpc from busybox), which is called by /sbin/ifup by having "dhcp" in /etc/network/interfaces.

The default behavior is driven by the script /usr/share/udhcpc/default.script

Its default configuration may be overwritten by /etc/udhcpc/udhcpc.conf

Authorized key:value pairs are:

{| cellpadding="15" border="1" class="wikitable"
|-
! key
| default value
| possible values
|-
| NO_GATEWAY
| -
| <list of iface names>
|-
| IF_METRIC
| -
| <metric value>
|-
| IF_PEER_DNS
| yes
| <anything but yes>
|-
| RESOLV_CONF
| /etc/resolv.conf
| no ; NO ; -
|-
| NO_DNS
| -
| <list of iface names>
|}

Example /etc/udhcpc/udhcpc.conf:

RESOLV_CONF="no" # Prevents overwriting of /etc/resolv.conf

Custom scripts can be added as /etc/udhcpc/pre-* and /etc/udhcpc/post-* to be run before/after deconfig/renew/bound DHCP events.

As an example, /etc/udhcpc/post-bound/mtu could contain, to change the interface MTU from the default (1500) to 1492, which is useful if [https://en.wikipedia.org/wiki/Maximum_transmission_unit on ADSL] (which uses 8 bytes):

r=$(/sbin/ip route | grep ^default | head -n 1)
# Needs iproute2 package, rather than busybox's "ip", to change mtu
/sbin/ip route replace $r mtu 1492

[[Category:Networking]]
[[Category:Embedded Systems]]

Firefox

2018-10-18T12:44:51Z

Brebs: Page creation

Firefox is a popular [https://en.wikipedia.org/wiki/Web_browser web browser].

== Stability ==

If [https://support.mozilla.org/en-US/questions/1175046 tabs crash], then try disabling hardware acceleration, in the Preferences - Performance menu.

Desktops

2018-10-04T14:18:29Z

Brebs: Capitalize the A in PulseAudio

== MATE Desktop ==

apk add mate-desktop-environment

== Desktop Features ==

=== Audio ===

[[PulseAudio]] is a frequent requirement, for e.g. some Steam games, and Docker images.

PulseAudio

2018-10-04T14:17:44Z

Brebs: Page creation

== Installation ==

apk add pulseaudio

== Process Priority ==

Pulseaudio should run with an elevated priority, because e.g. crackling or delayed audio is more annoying than a low framerate in games.

Installing the shadow package (which is compiled against linux-pam) is an easy way for the non-root user to be granted the ability to change niceness, and pulseaudio is recommended to be run as the user, rather than as root. E.g. in /etc/security/limits.d/audio.conf (and putting the user in the "audio" group):

@audio - nice -11

Desktops

2018-10-04T12:30:18Z

Brebs: Page creation

== MATE Desktop ==

apk add mate-desktop-environment

== Desktop Features ==

=== Audio ===

[[Pulseaudio]] is a frequent requirement, for e.g. some Steam games, and Docker images.

Installation

2018-10-04T12:01:25Z

Brebs: Add link to Desktops page

The following information will assist you with the installation of [http://alpinelinux.org/about Alpine Linux].
[[Image:hdd_mount.png|left|link=]]
<br />

== Installation Quick-Start in 3 Easy Steps ==
<div style="float:left; font-size:30px; font-weight:bold;">
1st
</div>
<div style="margin-left:65px; background-color:#EDF2F2; border-style:solid; border-color:#6F7C91; border-width:0px; border-left-width:5px; min-height:55px; padding:5px;">
[http://alpinelinux.org/downloads Download] one of the latest stable-release ISOs. Then compare the image's checksum to the one in the corresponding checksum file (<code>*.sha256</code>) and verify its GPG signature.
</div>

<div style="float:left; font-size:30px; font-weight:bold;">
2nd
</div>
<div style="margin-left:65px; background-color:#E0E9E9; border-style:solid; border-color:#606A82; border-width:0px; border-left-width:5px; min-height:55px; padding:5px;">
If you have a CD drive from which you can boot, then [[Burning ISOs|burn the ISO onto a blank CD]] using your favorite CD burning software. Else [[Create a Bootable USB|create a bootable USB drive]].
</div>

<div style="float:left; font-size:30px; font-weight:bold;">
3rd
</div>
<div style="margin-left:65px; background-color:#9faecc; border-style:solid; border-color:#324065; border-width:0px; border-left-width:5px; min-height:55px; padding:5px;">
Boot from the CD or USB drive, login as root with no password, and voilà! Enjoy Alpine Linux!
</div>

{{Clear}}
One of the [[Installation#Post-Install|first commands you might want to use]] is <code>[[setup-alpine]]</code>.

== Installation Handbook ==
=== Basics ===
Alpine can be used in any of three modes:
<dl>
<dt>diskless mode
<dd>You'll boot from read-only medium such as the installation CD, a [[Create a Bootable USB|USB drive]], or a [[Create a Bootable Compact Flash|Compact Flash card]]. {{Tip| To prepare either a USB or Compact Flash card, you can use the <code>[[setup-bootable]]</code> script; see the pages linked above for details.}} When you use Alpine in this mode, you need to use [[Alpine local backup|Alpine Local Backup (lbu)]] to save your modifications between reboots. That requires some writable medium, usually removable. (If your boot medium is, for example, a USB drive, you can save modifications there; you don't need a separate partition or drive.) See also [[Local APK cache]].
{{Note| When the <code>[[setup-alpine]]</code> script asks for a disk, say "none". It will then prompt whether you'd like to preserve modifications on any writable medium.}}
<dt>data mode
<dd>As in diskless mode, your OS is run from a read-only medium. However, here a writable partition (usually on a hard disk) is used to store the data in {{Path|/var}}. That partition is accessed directly, rather than copied into a tmpfs; so this is better-suited to uses where large amounts of data need to be preserved between reboots. {{Note| The <code>[[setup-alpine]]</code> script handles installing Alpine in this mode, too, when you supply a writable partition instead of "none", and request mode "data".}} This mode may be used for mailspools, database and log servers, and so on.
<dt>sys mode
<dd>This is a [[Install to disk|traditional hard-disk install]] (see link for details).  Both the boot system and your modifications are written to the hard disk, in a standard Linux hierarchy. {{Note| The <code>[[setup-alpine]]</code> script handles installing Alpine in this mode, too, when you supply a writable partition instead of "none", and request mode "sys". By default, it will create three partions on your disk, for {{Path|/boot}}, {{Path|/}}, and {{Path|swap}}; however you can also [[Setting up disks manually|partition your disk manually]].
}} This mode may be used for [[Desktops|desktops]], development boxes, and virtual servers.

</dl>

=== Advanced ===
* [[Create UEFI boot USB]]
* [[Tutorials_and_Howtos#Storage|Setting up storage with RAID, LVM, LUKS encryption, iSCSI, or suchlike]]
* [[Setting up disks manually]]
* [[Partitioning and Bootmanagers]]
* [[Migrating data]]
* Details about [[Alpine setup scripts]]

* [[Installing Alpine on HDD dualbooting|Install to HDD with dual-boot]]
* [[Create A VirtualBox Guest with Grub and XFS]]
* [[Replacing non-Alpine Linux with Alpine remotely]]



* [[Bootstrapping Alpine Linux]]


* [[Installing Alpine Linux in a chroot]]
* [[Install Alpine on LXC]]
* [[Install Alpine on LXD|Install Alpine on Ubuntu with LXD]]
* Install Alpine on [[Install Alpine on VirtualBox|VirtualBox]], [[Install Alpine on VMware|VMware]], [[Install Alpine on coLinux|coLinux]], [[Qemu]],  [[Install Alpine on Amazon EC2|Amazon EC2]], or [[Install Alpine on Rackspace|RackSpace]]

* [[Xen Dom0]] ''(Setting up Alpine as a dom0 for Xen hypervisor)''
* [[Xen Dom0 on USB or SD]]
* [[Create Alpine Linux PV DomU]]
* [[Xen LiveCD]]

* [[Setting up a basic vserver]]
* [[Setting up the build environment on HDD]]
* [[Setting up a compile vserver]] for official or for [[Setting up a compile vserver for third party packages|third party]] packages


=== Post-Install ===



* [[Tutorials_and_Howtos#Networking|Setting up Networking]]
* [[Alpine Linux package management|Package Management (apk)]] ''(How to add/remove packages on your Alpine)''

* [[Alpine local backup|Alpine local backup (lbu)]] ''(Permanently store your modifications in case your box needs reboot)''
** [[Back Up a Flash Memory Installation|Back Up a Flash Memory ("diskless mode") Installation]]
** [[Manually editing a existing apkovl]]
* [[Alpine Linux Init System|Init System (OpenRC)]] ''(Configure a service to automatically boot at next reboot)''
** [[Multiple Instances of Services]]

* [[Alpine setup scripts#setup-xorg-base|Setting up Xorg]]

* [[Upgrading Alpine]]


* [[Setting up a ssh-server]] ''(Using ssh is a good way to administer your box remotely)''
* [[setup-acf]] ''(Configures ACF (webconfiguration) so you can manage your box through https)''
* [[Hosting services on Alpine]]''(Links to several mail/web/ssh server setup pages)''
* [[Changing passwords for ACF|Changing passwords]]


* [[Setting the timezone]] ''(Not needed for the default musl- or uClibc-based installs)''

=== Further Help and Information ===
* [[FAQ|FAQs]]
* [[Tutorials and Howtos]]
* [[Contribute|How to Contribute]]
* [[Developer Documentation]]

[[Category:Installation]]