Alpine Linux - User contributions [en]

Sway

2021-03-28T17:32:10Z

Leo: /* Installation */

[http://swaywm.org Sway] is a tiling Wayland compositor. It's a drop-in replacement for the i3 window manager.

== Prerequisites ==

First, install & configure eudev:

<pre>
# apk add eudev
# setup-udev
</pre>

Then install graphics drivers appropriate to your system:

<pre>
# apk search mesa-dri
# apk add mesa-dri-intel # example
</pre>

The following contains guides per-graphics for setting the video stack up.

* [https://wiki.alpinelinux.org/wiki/Intel_Video Intel Video]
* [https://wiki.alpinelinux.org/wiki/Radeon_Video Radeon Video]

Add yourself to the input and video groups:

<pre>
# adduser $USER input
# adduser $USER video
</pre>

You have to log out and back in for this to take effect.

== Installation ==

We can now install sway:

<pre>
# apk add sway sway-doc
# apk add \ # Install optional dependencies:
xwayland \ # strongly reccommended for compatibility reasons
alacritty \ # default terminal emulator
dmenu \ # default application launcher
swaylock \ # lockscreen tool
swayidle # idle management (DPMS) daemon
</pre>

== Running Sway ==

To run sway, first set XDG_RUNTIME_DIR to a suitable location (e.g. /tmp). Install & configure elogind to skip this step. Then run sway from the Linux console:

<pre>
$ XDG_RUNTIME_DIR=/tmp sway
</pre>

Add this to a script if it becomes tedious.

== Configuration and Usage ==

An example config is provided at <code>/etc/sway/config</code>. Copy it to <code>~/.config/sway/config</code> and read through it to learn the default keybindings.

For additional information, start at <code>man 5 sway</code> and read the [https://github.com/swaywm/sway/wiki upstream FAQ].

[[Category:Desktop]]

Include:Setup your system and account for building packages

2021-01-22T10:38:11Z

Leo:

The {{Pkg|alpine-sdk}} is a metapackage that pulls in the most essential packages used to build new packages. Install those packages now:

{{Cmd|apk add alpine-sdk sudo}}

This would be a good time to create a normal user account for you to work in. (You weren't going to develop as root now, were you!) To create the user:

{{Cmd|adduser <yourusername>}}

To make life easier later, it's a good idea to add this user to {{Path|/etc/sudoers}}. Append the line

<yourusername> ALL=(ALL) ALL

using the command:

{{Cmd|visudo}}

Now logout of the root account, and login as <yourusername>. From here on everything can be done in a normal user account, and operations that require superuser privileges can be done with sudo.

The [[Aports_tree|aports tree]] is in git so before we clone the it, let's configure git.

{{Cmd|git config --global user.name "Your Full Name"
git config --global user.email "your@email.address"}}

Read carefully [[Development using git]] to grasp basic Git operations and how to configure for sending email patches.

Now we can clone the [[Aports_tree|aports tree]].

{{Cmd|git clone https://gitlab.alpinelinux.org/alpine/aports}}

Before we start creating or modifying [[APKBUILD_Reference|APKBUILD]] files, we need to setup abuild for our system and user. Edit the file {{Path|abuild.conf}} to your requirements:

{{Cmd|sudo $EDITOR /etc/abuild.conf}}

Most of the defaults can be left alone, unless you are developing for a custom platform, in which case the comments in the file should guide you. The one field to edit is PACKAGER, so that you can get credit (or blame) for packages you create.

To use 'abuild -r' command to install dependency packages automatically.
{{Cmd|sudo addgroup <yourusername> abuild}}

We also need to prepare the location where the build process caches files when they are downloaded. By default this is {{Path|/var/cache/distfiles/}}. To create this directory and ensure that it is writeable, enter the following commands:

{{Cmd|sudo mkdir -p /var/cache/distfiles
sudo chmod a+w /var/cache/distfiles}}

As an alternative to the second command, you can add yourself to the abuild group:

{{Cmd|sudo chgrp abuild /var/cache/distfiles
sudo chmod g+w /var/cache/distfiles}}

{{Note|Remember to logout and login again for the group change to have effect.}}

The last step is to configure the security keys with the [[Abuild-keygen|abuild-keygen]] script for [[Abuild|abuild]] with the command:

{{Cmd|abuild-keygen -a -i}}

[[Category:Development]]

Creating an Alpine package

2021-01-22T10:36:20Z

Leo:

{{TOC right}}

== Requirements ==

To build a package for Alpine Linux you need an Alpine Linux installation. Check the [[Installation]] page to see all available installation options.

== Setup your system and account ==
{{:Include:Setup_your_system_and_account_for_building_packages}}

== Getting some help ==

It might be wise to start by checking what the [[Abuild|abuild]] program can/cannot do.

{{Cmd|abuild -h}}

For real help, you can also go on Freenode's #alpine-devel on IRC.

A reference for APKBUILD files is available as a man page in the 'abuild-doc' package:

{{Cmd|man APKBUILD}}

== Creating an APKBUILD file ==

=== Use a template APKBUILD ===

To create the actual APKBUILD file {{Pkg|newapkbuild}} can serve you a template to start with. It will create a directory with the given package name, place an example/template APKBUILD file to the given directory, and fill some variables if those are provided. Please check the [[Package_policies| package policies]] page about naming details.

If you doubt to which repository your package belongs to you can safely use '''testing'''. Building package in your aports/testing directory is not mandatory but this way the package is already at the right place.

{{:Include:Newapkbuild}}

{{Note|On older Alpine systems, abuild -c -n ''packagename'' was the way to create APKBUILD files. The 'packagename' was a parameter to the -n option so order of -c and -n matters. }}

[[Abuild_and_Helpers#apkbuild-cpan|apkbuild-cpan]] simplifies the creation of perl packages from CPAN and [[Abuild_and_Helpers#apkbuild-pypi|apkbuild-pypi]] ease the generation of APKBUILD files for python packages from PyPi.

If you are creating a daemon package which needs initd scripts you can add the -c making it:

{{Cmd|newapkbuild -c ''packagename''}}

This will copy the sample initd and confd files to the build directory. 
A third file sample.install file will be copied as well (we will discuss this later on).

=== Modify your APKBUILD ===
Edit APKBUILD and fill in the needed info (especially pkgname, pkgver, pkgdesc, url, license, depends and source).

If you are going to use any of the variables for directories like $pkgdir, always make sure they are double quoted like:

"$pkgdir"/somedir

This will prevent issues with spaces/special characters in the future.

{{Note|If you like syntax highlighting we suggest you to install vim. We have setup vim to recognize the APKBUILD file as a bash scripts so its easier to read them.}}

=== APKBUILD variables/functions ===

==== source ====

The source variable is not only used to list the remote source files to fetch, it is also used to list the local files that abuild will need in order to build the apk. Examples of such local files include: init.d files, conf.d files, install files (see [[Creating an Alpine package#install|install variable]]), patches, and all other necessary files.

Here are few things to note:

* When you are finished adding local and/or remote files to ''source'', you can execute the following command to add their checksums to the APKBUILD file:
: {{cmd|abuild checksum}}
: {{Note|When later updating the content of ''source'', or updating a file that is listed in ''source'', you must also update their checksums again with the same command.}}

* When the remote file is hosted at SourceForge, it's best to specify the special mirrors link used by SourceForge:
: <pre>http://downloads.sourceforge.net/$pkgname/$pkgname-$pkgver.tar.gz</pre>
: (or similar depending on the package).

* When the remote filename is not specified in the URI (ie, does not end in '/software-1.0.tar.gz'), such as:
: <pre>http://oss.example.org/?get=software&ver=1.0</pre>
: You must prepend '${pkgname}-${pkgver}.tar.gz::' to the protocol, like so:
: <pre>source="${pkgname}-${pkgver}.tar.gz::http://oss.example.org/?get=software&ver=1.0"</pre>
: This causes the file to be saved as ''software-1.0.tar.gz'' where abuild can use it, instead of ''?get=software&ver=1.0'', where abuild cannot use it.

* Some projects didn't provide a release tarball. Beware that some git services (gitweg, cgit, …?) doesn’t provide ''stable'' tarballs, so when you point source to an tarball like <tt>http://repo.or.cz/w/gitstats.git/snapshot/ad7efbb9399e60cee6cb217c6b47e604174a8093.tar.gz</tt>, then you will run into issues because the checksum changes when downloading on the build system. This is not a problem on GitHub, GitLab and other decent services provides, they provide ''stable'' tarballs.

* abuild currently supports the following protocols for remote file retrieval:
** http
** https
** ftp



* abuild currently supports the following archive types/archive file extensions:
** .tar
** .tar.gz / .tgz
** .tar.bz2
** .tar.lz (only in Alpine >=3.7)
** .tar.lzma
** .tar.xz
** .zip

==== depends & makedepends ====

Depends are the actual running dependencies that a package would need when it is running. Makedepends are only needed when you are building a package. If you set a package in depends, you do not need to add it to makedepends as well. The best way to find out what the depends and makedepends of a package are is to [http://en.wikipedia.org/wiki/Rtfm RTFM].

No kidding, lots of important information can be found in the package INSTALL and README files (or the likes). Another good way is the run <code>./configure --help</code> from the source directory to see which options are needed for configure to finish without errors. If you do not yet have a source directory you can create one with the command:

{{Cmd|abuild unpack}}

Running <code>configure</code> will also show you how you can disable a specific option for this package. For instance, a good example is "--disable-nls" which will disable native language support and thus does not depend on gettext (libiconv, glib, ...).

Alpine likes to keep things small, so we try to disable as much as possible without losing too many features. The exact disable/enable options are decided by the package builder but please try to follow Alpine's design concept as much as possible.

An easy way of quickly finding out the build info for a package is to check Arch Linux (Alpine package management and build scripts are similar) or Gentoo Linux ebuilds (previous versions of Alpine were based on Gentoo).

* [https://gitweb.gentoo.org/repo/gentoo.git/tree/ Gentoo Ebuilds]
* [http://www.archlinux.org/packages/search/ Arch Linux packages] [https://aur.archlinux.org/ Arch Linux User Repository]

After the package is successfully compiled and created we should make sure it didn't link to any package that is not present in the <code>$depends</code> variable. We do this by using <code>scanelf</code>. If scanelf is not yet installed on your system you can do that by installing {{Pkg|pax-utils}}.

{{Cmd|scanelf -nR pkg}}

An example output of {{Pkg|libcurl}} would be:

ET_DYN libssl.so.0.9.8,libcrypto.so.0.9.8,libz.so.1,libc.so.0,ld-uClibc.so.0 pkg/usr/lib/libcurl.so.4.1.1

You can see the needed files and should be able to find out which file belongs to which package.

==== license ====

The '''license''' tag must reflect the license of the source code. Please check the source tarball for COPYING, LICENSE, or other files with names that indicates that it contains licensing information. Beside the license file most developer include headers in the source code files with licensing details.

If the license is on the [https://spdx.org/licenses/ SPDX License List] or [https://spdx.org/licenses/exceptions-index.html SPDX License Exceptions], use the identifier specified by SPDX.

If a package has a special/custom license or is not listed as [https://opensource.org/licenses/alphabetical OSI approved] we need to provide it with the release. Because we want to save space and don't like to have licenses all over our system we have decided to include the license in the doc subpackage. Please follow the following guidelines to add a proper license. Locate the license file inside the source package. Add the doc subpackage to the $subpackages variable as follows:

subpackages="$pkgname-doc"

Add a similar line to the following to your package() function, depending on the license description file:

install -Dm644 COPYING "$pkgdir"/usr/share/licenses/$pkgname/COPYING

If you follow these steps then abuild will automatically add the license to the package-doc apk for you.

{{Warning|It is not acceptable to package software with "unknown" license! If you can't find the license of the source code, please contact the author and ask them to specify the license. }}

==== arch ====

The package architecture(s) to build for. This can be one of: ''x86, x86_64, all,'' or ''noarch'', where ''all'' means all architectures, and ''noarch'' means it's architecture-independent (ie, a pure-python package).
{{Tip|To determine if your APKBUILD can use ''noarch'', build the package for your architecture and then run "scanelf -R pkg" from the directory that the APKBUILD resides in, in order to scan for ELF files in the ''./pkg'' directory. If you do NOT get output from this, then ''noarch'' can be used.}}

==== url ====

Website address for the program. This is useful later on when either finding documentation or other information about the package.

==== pkgdesc ====

A brief, one line, description of what the package does. Useful for the package management system. It should start with a capital letter and does '''not''' end with a period.

Here is an example from apk_info for the OpenSSH client package:

pkgdesc="Port of OpenBSD's free SSH release - client"

==== pkgver ====

Provide the release number of the package you are building.

==== pkgrel ====

The $pkgrel versioning is made so that if you change something in your APKBUILD file without changing the actual $pkgver, you can increment pkgrel so apk tools will detect it as an update. For instance, if you forget to add a dependency, you can add it afterward and you can +1 pkgver so apk finds this update and adds the missing dependency. When there's an upstream version change, we reset the pkgrel to 0.

==== pkgname ====

The base name of the package you are creating. For Freeswitch 1.0.6, you would use "freeswitch"

==== install ====

There are 6 different kinds of install scripts. Each script is called with the $pkgname.''<action>'' where ''<action>'' is one of the following:

<dl>
<dt>$pkgname.pre-install
<dd>This script is executed before package is installed. Typical use is when package needs a group and a user to be created. For example:
<pre>
#!/bin/sh

addgroup -S clamav 2>/dev/null
adduser -S -D -H -s /bin/false -G clamav -g clamav clamav 2>/dev/null

exit 0
</pre>
Note the ''exit 0'' at the end. If the script exits with failure (if the user already exist), the package will not be installed and <code>apk add</code> will exit with failure.

<dt>$pkgname.post-install
<dd>This script is executed after the package is installed. Can be used to generate font cache and similar.

<dt>$pkgname.pre-upgrade
<dd>Same as pre-install but is executed before upgrading/downgrading/reinstalling an already installed package. Note that exiting with failure will not cause apk to exit with failure, but will mark the package as broken.

<dt>$pkgname.post-upgrade
<dd>Same as post-install but is executed after upgrading/downgrading/reinstalling an already installed package.

<dt>$pkgname.pre-deinstall
<dd>This script is executed before uninstalling a package. If script exits with failure apk will not uninstall the package.

<dt>$pkgname.post-deinstall
<dd>This script is executed after a package have been uninstalled. Can be used to update font caches and restore busybox links. For example:
<pre>
#!/bin/sh
busybox --install -s
</pre>

</dl>

If the package has a pre-install and post-install script the APKBUILD should have the ''install'' variable defined:
<pre>
...
install="$pkgname.pre-install $pkgname.post-install"

...
</pre>

==== subpackages ====

$subpackages are made to split up the normal "make install" into separate packages. The most common subpackages we use are doc and dev. Because we like to keep our target system small we move documentation and development files (only needed when building packages) into separate packages. To use the specific program a user only need to install the base apk without package-doc or package-dev, but if he wants to read the manual he will need to install package-doc.

The easiest way to find out if you need to use -dev and -doc is to first build the package without these options set and wait until the build finishes. When its finished you should have a pkg directory which is the fake root directory. Inside this directory you will see the structure as how it would be installed in / on the target system.

To see if you need the -dev package you can run the following cmd:

{{Cmd|find pkg/usr/ -name '*.[acho]' -o -name '*.la'}}

If this returns any files you need to include the -dev package.

 To see if you need the -doc package you can run the following cmd:

{{Cmd|find pkg/usr/share -name doc -o -name man -o -name info -o -name html -o -name sgml -o -name licenses}}

If this returns any directories you need to include the -doc package.

===== Custom subpackages =====

Some software additionally has non-essential files that do not qualify as either documentation or development content. These files should be placed in their own, specialized subpackage(s). Some packages include large test suites which are only needed in specific circumstances or binaries which have depends which we prefer not to install. To handle those we create our own package/function. In the APKBUILD below the build() function we create another function:

test() {
mkdir -p "$subpkgdir"/usr
mv "$pkgdir"/usr/package-test "$subpkgdir"/usr/
}

We also need to add the package info to $subpackages variable:

subpackages="$pkgname-doc $pkgname-dev $pkgname-test"

After we finish building the package you should see another apk called packagename-test.apk which includes the files which we moved to the $subpkgdir dir.

The above mentioned variables can also be used in our custom function. If we want for instance to build the test() function with perl support we would add:

depends="perl"
makedepends="perl-dev"

If we would install the base package it would not install perl, but if we install the package-test package it would.

==== Patches ====

Please make sure you always submit human readable patches. Ways to create them are:

directory compare:

{{Cmd|diff -Nurp original_directory new_directory > filename.patch}}

file compare:

{{Cmd|diff -up original.file new.file > filename.patch}}

If a patch contains a completely new file but not *.rej or *.orig file, you need to add -N option to diff, but you may need to add exclusions with <code>--exclude PATTERN</code> so that you do not inadvertently add files. You may need to manually delete unwanted files inside the patch file.

Because multiple patches can patch the same file, they can change the offsets required by subsequent patches. To make sure we always patch in a specific way, we should number the patches as follows:

10-patch1.patch 20-patch2.patch 30-patch3.patch

This way we are always sure that patch 1 is applied first, and if we want to add additional patches between them we can use appropriate indexes (e.g. 11, 12, 21, 22).

Add the names of the patch files to the ''source'' variable. If you haven't declared a custom ''prepare'' function, no further action is necessary. Otherwise, be sure to call ''default_prepare'' in your ''prepare'' function. For example:

prepare() {
default_prepare

# do your stuff
}

Note: Some older packages contain a ''for'' loop in the ''prepare'' function to apply patches. This is not needed anymore, as patches are handled by ''default_prepare''.

In Alpine >=3.4 you can define patch_args to supply the patch level. This only works if all the patches have the same patch level. If there are a lot of patches from different sources, there is a good chance that you may need to edit them, as discussed below.

To automatically patch the package (available only in Alpine >=3.4) if it uses a patch level (-pX) other than the default (-p1), you need to carefully modify the patch. First, you'll need a text editor that does not automatically convert between Windows and Unix new lines (or, disable this feature) so that it preserves the old code. The next thing you'll need to do is modify the paths on "+++" and "---" lines in the .patch file. You can begin the path with a/ and b/ like shown below. Next, you need to adjust the paths so that the relative base path is from inside $builddir. Anything to the left of $builddir, including $builddir itself, needs to be removed from the path. So, if $builddir is /home/USER/aports/community/chromium/src/chromium-65, you need to erase it on the "+++" and "---" lines. Inside the chromium-65 folder you can see a src folder that has 3rdparty as a descendant. If a patch originally has a deeper patch level, you may need to fill in the missing portion of the path. For example, use the <code>find . -name "Assertions.cpp"</code> command to find the full path to the file relative to the base.

{{Cat|example.patch|<nowiki>
Author: John Doe <johndoe@mail.com>
URL: http://.....
Summary: Fixes musl compatibility
----
--- a/src/3rdparty/chromium/third_party/WebKit/Source/wtf/Assertions.cpp.orig
+++ b/src/3rdparty/chromium/third_party/WebKit/Source/wtf/Assertions.cpp
@@ -142,7 +142,7 @@
};

FrameToNameScope::FrameToNameScope(void* addr) : m_name(0), m_cxaDemangled(0) {
-#if OS(MACOSX) || (OS(LINUX) && !defined(__UCLIBC__))
+#if OS(MACOSX) || (OS(LINUX) && defined(__GLIBC__))
Dl_info info;
if (!dladdr(addr, &info) || !info.dli_sname)
return;
</nowiki>}}

Portions of the patch may be outdated, removed completely as in the source code file completely removed, or moved or renamed files. You need to delete that section of the patch or find where that section of code changed and re-diff it.

It is good etiquette to give credit at the top and the location of where you originally found them with notes.

Excluding patches with global variable resembling patch_opts is not available on Alpine. To exclude patches you need to create your own custom prepare().

If you have a monolithic patch where there are a bunch of patches in one big patch, you could use filterdiff which is available in the patchutils package.

Just do something like:

<pre>
makedepends="patchutils"

prepare() {
...
cd "$builddir"
filterdiff -x '*drivers/video/logo*' "$srcdir"/original.patch > "$builddir"/modified.patch
patch -p1 -i "$builddir"/modified.patch
}
</pre>

You need to put the wildcard pattern in single quotes for it to work.

==== Configure options ====

Alpine has some default configure options we set by default. We use /usr for prefix to make sure everything is installed with /usr in front of it. If you notice that anything is installed in the wrong directory please run {{Cmd|./configure --help}} and see if you can set the correct location.

We are not covering the depend switches here we have discussed this already in the depend section.

==== Make options ====

If you notice weird problems when compiling or installing the package with make/make install you could try to disable [http://www.gnu.org/software/make/manual/make.html#Parallel parallel] building/installing. A normal make line would be:

make

To disable parallel we use:

make -j1

We can use the same for make install.

Because we do not want to install the package in our build environment but we want to install it in a fake root directory we need to tell 'make install' to use another destination directory instead of '/'. We do this by setting a variable when we execute make install as followed:

make DESTDIR="$pkgdir" install

Please note that some Makefiles do not support this variable and will always install software in '/'. To make sure you do not mess up your build system NEVER run your build system as root but always use a custom user and sudo when needed. If by accident the Makefile does not support DESTDIR variable it will fail to install in our build system system directories.

==== builddir ====
If you used <tt>newapkbuild</tt> to create your APKBUILD file, you must specify the path to your unpacked sources. Inside the sections during the prepare/build/install process ''builddir'' is used. Most of the time a combination of ''$srcdir'' and ''$pkgname-$pkgver'' will work. When not, check the /src directory or the source tarball for the right string. Especially when you are working with automatically generated tarballs (like from github and gitorious), this needs to be adjusted.

builddir="$srcdir"/$pkgname-$pkgver

==== Additional files ====

If you want/need to install additional files not mentioned above you can use the following cmd (this is an example of a conf file):

install -Dm644 doc/$pkgname.conf "$pkgdir"/etc/$pkgname.conf

== Build the package ==

If you did not already create the checksums as mentioned above you can do so now:

{{Cmd|cd $pkgname
abuild checksum}}

It's about time we build our package. Because a build system should never have all the package installed to prevent linking to packages we don't want it to link we use a abuild recursively with the '''-r''' switch. It will install all dependencies from your repository and builds it, afterwards it will uninstall all those depending packages again. You could also use the '''-R''' switch which would build your package including the dependency packages.

{{Cmd|abuild -r}}

== Testing the package locally ==

When it completes, your package will be found in a subfolder of <code>~/packages</code>. You may want to test it on your machine but only if the package is not a critical system package like musl or apk-tools package. To avoid borking your system (as in making it impossible to use <code>apk add</code> or to restore back the system and the compiler toolchain) for a critical system package, you should test on a chroot first before using it live.

The best way to test a package locally is to modify your <code>/etc/apk/repositories</code> so that it includes the indexes to your locally built packages - the directories that contain <code>ARCH/APKINDEX.tar.gz</code>. For example the <code>/etc/apk/repositories</code> below includes locally built packages in testing, community and main. To use this example change <code>USER</code> to your login name.

{{Cat|/etc/apk/repositories|/home/USER/packages/testing/
/home/USER/packages/community/
/home/USER/packages/main/
/media/sdc/apks
#http://dl-2.alpinelinux.org/alpine/v3.7/main
#http://dl-2.alpinelinux.org/alpine/v3.7/community
http://dl-2.alpinelinux.org/alpine/edge/main
http://dl-2.alpinelinux.org/alpine/edge/community
http://dl-2.alpinelinux.org/alpine/edge/testing
}}

If you prefer to test a package without changing any other configuration you can use the <code>-X, --repository</code> option to <code>apk</code>:

{{Cmd|sudo apk add --repository /home/USER/packages/testing $pkgname}}

== Code review ==

To successfully have your package pass through code reviewers (as of Feb 18, 2018 are nmeum and jirutka on GitHub) and possible increased acceptance, the following conventions need to be followed:

# Custom global variables should be prefixed with underscore (_).
# Compact code as in merged commands, removed unused variables, removal of functions that do the same thing that are automatically handled by abuild.
# Versioning is done properly. For details see [[APKBUILD_Reference#pkgver]].
# Licensing is done properly. Remove unnecessary copying of licensing that is already OSI approved.
# Naming conventions rules for unofficial variables as in _gitrev is preferred over commit.
# Indent with tabs not spaces.
# Removal of explicit return 1. (They are still found the old APKBUILD files if you are learning but are now strongly discouraged.)
# Disabling check() requires either (1) a comment (#) stating next to options="!check" that there is no test suite/unit tests or (2) functioning working check() function.
# Explicit call to subpackages="$pkgname-doc" must be used instead of explicit gzip man page compression.
# Ideally, lines should be no more than 80 columns wide

Additionally, make sure to run the linter on your package:
{{Cmd|sudo apk add atools
apkbuild-lint APKBUILD}}

For more information see [[Development using git:Quality assurance]] and [[Package_policies]].

== Commit your work ==

After you successfully build your package and properly followed the conventions and requirements in the code review section, you can submit your APKBUILD to Alpine's git repository.

Update your git repo, before adding new files:

{{Cmd|cd $aportsdir
git pull}}

This should pull all the changes made by others into your local git repo.

When you think you are ready you can add your files to git:

NOTE: when using our Gitlab instance, you can create MR's for each package. Please squash all commits related to the same package into a single one per MR.

{{Cmd|cd $aportsdir
git add testing/$pkgdir (include any other files needed for the build; $pkgname.install...)
git commit}}

Use the following commit message template for new aports (without the comments):

{{Cat|template|testing/$pkgname: new aport # this will be the subject line
# a blank line
$url # project homepage
$pkgdesc # one line description}}

Or you could add the following and <code>chmod +x ports/.git/hooks/prepare-commit-msg</code> to automatically generate commit message which the default aports/.githooks/ does not:

{{Cat|aports/.git/hooks/prepare-commit-msg|<nowiki>#!/bin/sh
case "$2,$3" in
,|template,)
if git diff-index --diff-filter=A --name-only --cached HEAD \
| grep -q '/APKBUILD$'; then
meta() { git diff --staged | grep "^+$1" | sed 's/.*="\?//;s/"$//';}
printf 'testing/%s: new aport\n\n%s\n%s\n' "$(meta pkgname)" \
"$(meta url)" "$(meta pkgdesc)" "$(cat $1)" > "$1"
else
printf '%s\n\n%s' `git diff-index --name-only --cached HEAD \
| sed -n 's/\/APKBUILD$//p;q'` "$(cat $1)" > "$1"
fi;;
esac</nowiki>}}

Now your changes are only available locally in your repository.

Because you do not have push rights to the Alpine aports repository you need to create a merge request to [https://gitlab.alpipnelinux.org/alpine/aports Alpine's GitLab instance].

Alternatively you can also create a diff (patch) of the changes you made and send this patch to the
[https://lists.alpinelinux.org/~alpine/aports alpine-aports mailinglist].

To create a diff patch:

{{Cmd|git format-patch HEAD^}}

or if you have sprunge, you can create a link to your patch for convenience

{{Cmd|git format-patch HEAD^ --stdout <nowiki>|</nowiki> sprunge}}

== Travis CI and automated testing ==

Travis CI, as in continuous integration automated testing, isn't always required, but 99% of the time it is strongly encouraged to pass with a green checkmark. Passing Travis CI ensures that your package works on another machine and builds the image starting from nothing. One reason why your package fails to build on the remote server is that you may inadvertently add a package dependency as in creating multiple packages at the same time or forgot to remove a dependency and forgot to mark it as a makedepends.

When you submit your APKBUILD as a pull request, the Travis CI server will construct the build environment from [https://github.com/alpinelinux/aports/blob/master/.travis/install-alpine#L28 main] [https://github.com/alpinelinux/aports/blob/master/.travis/common.sh#L5 Edge] apks.

The environment is just like a boot into command line so it is minimal. Don't assume that you boot into X.

The server/configuration cannot do testing/check() testing on hardware accelerated OpenGL apps.

== Send a patch ==

[[Creating_patches#Only_the_last_commit_with_.27git_send-email.27|git send-email]] will do that for you.

== GitHub Tagging ==

If you see your pull requested labeled on GitHub this is what they mean:

*A-add - The pull requester wanted to add this brand new package.
*A-upgrade - The pull requester wanted to update the package.
*A-improve - The pull requester wanted to improve an existing package.
*A-fix - The pull requester wanted to fix a bug with the existing package.
*S-changes-requested - An admin wants you to add or remove a subpackage or fix something as in messy code.
*S-needs-review - An admin needs someone to do a code review on your package.
*S-broken - The package fails to build locally on the code reviewer machine.
*ci-malfunction - Travis CI doesn't work with this package as in exceeded time.

== See Also ==
* [[APKBUILD Reference]]
* [[APKBUILD examples]]
* [[Development using git]]
* [[Development using git:Quality assurance]]

[[category: Package Manager]]

Release Notes for Alpine 3.13.0

2021-01-06T10:40:17Z

Leo: /* Deprecation of berkeley db */

== aports ==

=== musl upgraded to 1.2 ===

musl has been upgraded to 1.2. This release changes the definition of <code>time_t</code> on 32-bit systems. See the [https://musl.libc.org/time64.html musl time64 release notes] for more details. All x86, armv7 and armhf packages have been rebuilt for this change. For users of these architectures, all self-compiled packages must be manually rebuilt after upgrading.

=== Deprecation of BerkeleyDB ===

Oracle has changed the license of its BerkeleyDB to AGPL-3.0, making it unsuitable to link it to packages with GPL-incompatible licenses. Since the old version is no longer maintained, the <code>db</code> has been declared deprecated, packages are being transitioned out of using it or out of the distribution entirely, developer tooling for doing QA in APKBUILDs has been adjusted to warn when <code>db</code> is present.

For postfix, this means using lmdb and dropping support for <code>hash</code> and <code>btree</code> databases. Before upgrading, update all references of these types in <code>/etc/postfix/main.cf</code> to <code>lmdb</code>.

=== Switching from busybox ifupdown to ifupdown-ng ===

Alpine Linux has switched the default ifupdown implementation from busybox to [https://github.com/ifupdown-ng/ifupdown-ng/ ifupdown-ng]. This version is compatible with debian ifupdown and busybox ifupdown, but please read the [https://github.com/ifupdown-ng/ifupdown-ng/blob/master/README.md readme] and the [https://github.com/ifupdown-ng/ifupdown-ng/blob/master/doc/ADMIN-GUIDE.md admin guide].

ifupdown-ng has native vlan support, so the <code>vlan</code> package is no longer required and can be uninstalled. The <code>bridge</code> and <code>bond</code> packages are still required.

=== GCC 10 ===

GCC has been updated to version 10. GCC 10 sets the <code>-fno-common</code> option by default. All Alpine Linux packages have been fixed, but users compiling other packages on Alpine may need to fix their code. For more information, see the [https://gcc.gnu.org/gcc-10/porting_to.html GCC 10 porting guide].

=== PHP 8.0 ===

PHP 8.0 with a common set of extensions is now available as <code>php8</code>. PHP 7.4 (<code>php7</code>) remains the default.

=== xorg-server has moved to community ===

xorg-server and related packages have been moved from main to community. To install it, make sure the community repository is added to <code>/etc/apk/repositories</code>.

== busybox ==

=== Removed applets ===

The following applets have been removed due to limited feature support and/or highly infrequent use:

* '''hdparm''': Use <code>hdparm</code> instead.
* '''fdformat''': Use <code>util-linux</code> instead.
* '''readprofile''': Use <code>util-linux</code> instead.
* '''lspci''': Use <code>pciutils</code> instead.
* '''sendmail''': Use <code>ssmtp</code>, <code>opensmtpd</code>, <code>dma</code>, <code>exim</code>, <code>nullmailer</code>, or <code>postfix</code> instead.
* '''conspy''': None
* '''smemcap''': None
* '''dumpleases''': None

For conspy and smemcap, alternative versions are available but not yet packaged. Please file an issue at [https://gitlab.alpinelinux.org/alpine/aports/ Alpine GitLab] if you require these programs.

=== Changes ===

The following applets now support long options:

* gzip
* install
* ipcalc

== apk-tools ==

=== Man page ===

apk-tools now has an official man-page: <code>apk-tools-docs</code>. If the <code>docs</code> package is installed, man pages will automatically be installed and updated for all installed packages.

APKBUILD Reference

2020-10-19T05:31:51Z

Leo: /* User-defined variables */

APKBUILDs are the scripts that are created in order to build Alpine packages using the [[abuild]] tool.

See [[aports]] for details on Alpine's official ports repository.

This page is intended to serve as a reference for creating APKBUILDs; if this is your first time creating a package for Alpine Linux, please see [[Creating an Alpine package]].

= Legend =
The following notes will assist you in understanding this document.

In description text:
* If a variable is not prefixed with a ''$'', it will be represented by italics (i.e., ''srcdir'' ).
* Functions will also be represented by italics, but will also end with a pair of parentheses (i.e., ''build()'' ).
* Shell commands will be represented <code>like this</code>.

= Variables =
{{Note|Variables that contain a path (e.g. ''$srcdir'' and ''$pkgdir'') should always be quoted using double quotes (i.e., ''"$srcdir"''). This is done to prevent things from breaking, should the user have the APKBUILD in a directory path that contains spaces.}}
{{Note|All arbitrary variable and function names should be prefixed with an underscore character ( _ ) to avoid name clashes with the internals of abuild (for example, ''_luaversions'').}}

== abuild-defined variables ==
The following variables are defined by abuild:

==== startdir ====
: The directory where the APKBUILD script is.
==== srcdir ====
: The directory where sources, from the ''source'' variable, are downloaded to and unpacked to.
==== pkgdir ====
: This directory should receive the files for the main package. For example, a normal [http://en.wikipedia.org/wiki/GNU_build_system autotools] package would have <code>make DESTDIR="$pkgdir" install</code> in the ''package()'' function.
==== subpkgdir ====
: This directory should receive the files for a subpackage. This variable should only be used from subpackage functions.
==== builddir ====
: This variable should point to the directory inside the ''srcdir'' where the main package source is unpacked. This is typically ''$srcdir/$pkgname-$pkgver''. It’s used by the default ''prepare()'' function as a working directory when applying patches.

== User-defined variables ==
The following variables should be defined by the user:
==== arch ====
: Package architecture(s) to build for. Can be one of: '''[[x86]], [[x86_64]], [[armhf]], [[aarch64]], [[ppc64le]], [[s390x]], all''', or '''noarch''', where '''all''' means all architectures, and '''noarch''' means it's architecture-independent (e.g., a pure-python package).
: {{Tip|To determine if your APKBUILD can use '''noarch''': First specify '''all''' and then build the package by executing <code>abuild -r</code>. Watch the output towards the end for warnings saying that '''noarch''' can be used. If the main package and all subpackages, if you have any subpackages, give a warning saying that '''noarch''' can be used, then you can use '''noarch'''.}}

==== depends ====
: Run-time dependency package(s) that are not shared-object dependencies. Shared objects dependencies are auto-detected and should not be specified here.
==== depends_dev ====
: Run-time dependency package(s) for the '''$pkgname-dev''' subpackage.

: {{Note|From ncopa on IRC: To find out if you need to add a package to depends_dev have a look at *requires* in usr/lib/pkgconfig/*.pc. With libtool it gets more complicated, but we should delete the .la files. Also check if there are any /usr/bin/*-configure #!/bin/bash #!/usr/bin/perl or Python. Sometimes scripts or similar are generated at build time (i.e autoconf automake) then you normally don't need add those to depends_dev. You can also just add all -dev makedepends to depends_dev but it will slow the build process a little bit (more build dependencies).}}

==== depends_doc ====
: Run-time dependency package(s) for the '''$pkgname-doc''' subpackage.

==== depends_openrc ====
: Run-time dependency package(s) for the '''$pkgname-openrc''' subpackage.

==== depends_libs ====
: Run-time dependency package(s) for the '''$pkgname-libs''' subpackage.

==== depends_static ====
: Run-time dependency package(s) for the '''$pkgname-static''' subpackage.

==== checkdepends ====
: Dependencies that are only required during the check phase, they are only installed if the check option is enabled

==== giturl ====
:Git repository from which <code>abuild checkout</code> checks out. You can checkout a specific branch in git by adding <code>-b $branch</code>.
==== install ====
: There are 6 different types of install scripts. Install scripts are named '''$pkgname.action''', where '''action''' can be: '''pre-install, post-install, pre-upgrade, post-upgrade, pre-deinstall''', or '''post-deinstall'''. For example, if ''pkgname'' is set to '''mypackage''' and ''install'' is set to '''$pkgname.post-install''', then a script named '''mypackage.post-install''' must exist along-side the APKBUILD.
<blockquote>{{Note|Always use <code>/bin/sh</code> for the command-line interpreter on the [http://en.wikipedia.org/wiki/Shebang_%28Unix%29 shebang line] of your install scripts.}}</blockquote>

The following are the different types of install scripts in detail:

===== $pkgname.pre-install =====
: This script is executed ''before installing'' the package. Typical use is when the package needs a group and a user to be created. For example:
<blockquote><pre>
#!/bin/sh

addgroup -S clamav 2>/dev/null
adduser -S -D -H -s /bin/false -G clamav -g clamav clamav 2>/dev/null

exit 0
</pre>
{{Note|If the script exits with a failure (e.g., if the user already exists), the package will not be installed and <code>apk</code> will exit with failure, hence the <code>exit 0</code> at the end.}}</blockquote>

===== $pkgname.post-install =====
: This script is executed ''after installing'' the package.

===== $pkgname.pre-upgrade =====
: This script is executed ''before upgrading/downgrading/reinstalling'' the package. Note that exiting with failure will not cause apk to exit with failure, but will mark the package as broken.

===== $pkgname.post-upgrade =====
: This script is executed ''after upgrading/downgrading/reinstalling'' the package.

===== $pkgname.pre-deinstall =====
: This script is executed ''before uninstalling'' the package.
: {{Note|If the script exits with failure, <code>apk</code> will not uninstall the package.}}

===== $pkgname.post-deinstall =====
: This script is executed ''after uninstalling'' the package.

==== install_if ====
:install_if can be used when a package needs to be installed when some packages are already installed or are in the dependency tree. It works in reverse to the ''recommends'' feature, that other package managers provide.

: '''Example:''' When package <code>A</code> has <code>install_if="B C"</code>, and the user runs <code>apk add B C</code>, then package <code>A</code> will get automatically installed.

: '''Example 2:''' A real use-case in Alpine is open-vm-tools. Currently it contains the userspace tools and separate packages for the kernel modules (grsec and vserver). When we install the userspace tools, apk should automatically install the correct kernel modules and will need to figure out for which kernel. This is where install_if jumps in. For any of the kernel modules package we would use:

:<pre>install_if="linux-${_flavor}=${_kernelver} open-vm-tools"</pre>

:This will automatically install the package when the specified packages are installed or are in dependency tree.

==== license ====
: License(s) for the package, for example <code>GPL-3.0-or-later</code>, <code>BSD-2-Clause</code> or <code>MIT</code> [[Creating_an_Alpine_package#license|(details)]].

==== makedepends ====
: Build-time dependency package(s).
==== md5sums/sha256sums/sha512sums ====
: Checksums for the files/URLs listed in ''source''. The checksums are normally generated and updated by executing <code>abuild checksum</code> and should be the last item in the APKBUILD.

New packages should use only sha512sums.

==== options ====
: Build-time options for the package.

: {| class="wikitable"
! Option
! Description
|-
| <code>!archcheck</code>
| Do not try to verify that the architecture of the binary files is the same architecture as abuild should build for. One example where it makes sense to set this are packages with firmware files, that get executed on another CPU (such as WiFi firmware).
|-
| <code>!check</code>
| Do not try to run the <code>check()</code> function. Please always add a short comment after the <code>!check</code> about why it's disabled. [https://github.com/alpinelinux/aports/pull/2322#discussion_r142545300] Creating a very simple check function, that calls <code>program --version</code> is worse than disabling tests completely because it gives the false impression that the package is thoroughly tested with the testsuite from upstream. [https://github.com/alpinelinux/aports/pull/7326#discussion_r278797457]
|-
| <code>checkroot</code>
| Specifies that the package's test suite will be run in ''fakeroot''. This is necessary for some test suites which fail when run as non-root.
|-
| <code>net</code>
| Allows network access when run in ''rootbld''.
|-
| <code>!strip</code>
| Avoid stripping symbols from binaries.
|-
| <code>suid</code>
| Allow [https://en.wikipedia.org/wiki/Setuid setuid] binaries.
|-
| <code>!tracedeps</code>
| Do not automatically find dependencies (e.g. by using <code>ldd</code> to find dynamic libraries, which the resulting binary links against).
|-
| <code>chmod-clean</code>
| Make all files writable in the src/ directory. Useful for packages that make files read-only in the process of building packages (go modules).
|-
| <code>toolchain</code>
| Don't warn when g++ is in makedepends
|-
| <code>!dbg</code>
| Don't create debugging subpackage
|-
| <code>ldpath-recursive</code>
| Scan directories recursively when creating .so providers
|-
| <code>!spdx</code>
| Do not check if the license= field has a SPDX compliant license
|-
| <code>textrels</code>
| Don't error out when text relocations are found
|-
| <code>charset.alias</code>
| Don't error out if /usr/lib/charset.alias is found
|-
| <code>libtool</code>
| Don't delete libtool .la files
|-
| <code>!fhs</code>
| Don't enforce checks on path that follow the FHS
|}

==== pkgdesc ====
: A brief, one-line description of what the package does.

: Here's an example from the OpenSSH client package:
: <pre>pkgdesc="Port of OpenBSD's free SSH release - client"</pre>
==== pkggroups ====
: System group(s) to be created during build-time. System group(s) should also be created in the '''[[APKBUILD Reference#.24pkgname.pre-install|$pkgname.pre-install]]''' script, so that the system group(s) are also created prior to package installation for run-time use.
==== pkgname ====
: The name of the package. All letters should be lowercase.
: {{Note|When creating an APKBUILD of a module or library for another package, we use some common package prefixes, such as: ''lua-'', ''perl-'', ''php-'', and ''py-''. Search aports for other common prefixes.}}

==== pkgrel ====
: Alpine package release number. Starts at 0 (zero). Always increment ''pkgrel'' when making updates to an aport; reset ''pkgrel'' to 0 (zero) when incrementing ''pkgver''.
==== pkgusers ====
: System user(s) to be created during build-time. System user(s) should also be created in the '''[[APKBUILD Reference#.24pkgname.pre-install|$pkgname.pre-install]]''' script, so that the system user(s) are also created prior to package installation for run-time use.
==== pkgver ====
: The version of the software being packaged. Format for valid versions: <code>{digit}{.digit}...{letter}{_suf{#}}...{-r#}</code> [https://git.alpinelinux.org/cgit/apk-tools/tree/src/version.c#n17]
: A Suffix <code>suf</code> in the above format can be one of the following to indicate that the release is ''less recent'' than the version without the suffix: <code>alpha</code>, <code>beta</code>, <code>pre</code>, <code>rc</code> [https://git.alpinelinux.org/cgit/apk-tools/tree/src/version.c#n75]
: These are for indicating ''more recent'' releases: <code>cvs</code>, <code>svn</code>, <code>git</code>, <code>hg</code>, <code>p</code> [https://git.alpinelinux.org/cgit/apk-tools/tree/src/version.c#n76]
: All other suffices are invalid. To package a specific git commit, the date of the commit gets appended to the latest release, e.g. <code>1.0.0_git20180204</code>.

==== provides ====
: List of package names (and optionally version info) this package provides.

: If package with a version is provided (provides='foo=1.2') apk will consider it as an alternate name and it will automatically consider the package for installation by the alternate name, and conflict with other packages having the same name, or provides.

: If version is not provided (provides='foo'), apk will consider it as virtual package name. Several package with same non-versioned provides can be installed simultaneously. However, none of them will be installed by default when requested by the virtual name - instead, error message is given and user is asked to choose which package providing the virtual name should be installed.
==== provider_priority ====
: A numeric value which is used by apk-tools to break ties when choosing a virtual package to satisfy a dependency. Higher values have higher priority. The primary use case is to specify the primary package that satisfies a virtual (provider).
==== replaces ====
: Package(s) that this package replaces. This package will "take over" files owned by packages listed in the ''replaces'' variable. This is useful when files move from one package to another, or when a package gets renamed.
==== replaces_priority ====
: The priority of the replaces. If multiple packages replace each other, then will the package with highest ''replaces_priority'' win.
==== source ====
: The source variable is not only used to list the remote source files to fetch, it is also used to list the local files that abuild will need in order to build the apk. Examples of such local files include: init.d files, conf.d files, install files (see [[APKBUILD Reference#install|install variable]]), patches, and all other necessary files.

: Here are few things to note:

:* When you are finished adding local and/or remote files to ''source'', you can execute the following command to add their checksums to the APKBUILD file:
:: {{Cmd|abuild checksum}}
:: {{Note|When later updating the content of ''source'', or updating a file that is listed in ''source'', you must also update their checksums again with the same command.}}

:* When the remote file is hosted at SourceForge, it's best to specify the special mirrors link used by SourceForge:
:: <pre>http://downloads.sourceforge.net/software/software-$pkgver.tar.gz</pre>
:: (or similar depending on the package).

:* You can set target filename (eg 'save as...') by prefixing the URI with ''filename::''. This is useful when the remote filename is not specified in the URI (ie, does not end in '/software-1.0.tar.gz'), such as:
:: <pre>http://oss.example.org/?get=software&ver=1.0</pre>
:: or when the filename is braindead, like githubs' download tags:
:: <pre>https://github.com/software/software/archive/v$pkgver.tar.gz</pre>
:: The above two examples needs a target filename prefix:
:: <pre>$pkgname-$pkgver.tar.gz::http://oss.example.org/?get=software&ver=$pkgver</pre>
:: and:
:: <pre>$pkgname-$pkgver.tar.gz::https://github.com/software/software/archive/v$pkgver.tar.gz</pre>

:* abuild currently supports the following protocols for remote file retrieval:
:** http
:** https
:** ftp

:* abuild currently supports the following archive types/archive file extensions:
:** .tar (only in Alpine >= 2.5)
:** .tar.gz / .tgz
:** .tar.bz2
:** .tar.lz (only in Alpine >=3.7)
:** .tar.lzma
:** .tar.xz
:** .zip

:* <code>source</code> should only include variables that change often like <code>pkgver</code> or a commit ID. CI will warn you if you include <code>pkgname</code> in source. Other variables like for example <code>_pkgname</code> or <code>_pyname</code> do not belong in <code>source</code> either.

==== subpackages ====
: Subpackages built from this APKBUILD. abuild will parse this variable and try to find a subpackage split function. The split function must ''move'' files that do not belong in the main package, from ''$pkgdir'' to ''$subpkgdir''. Files and directories can also be ''copied'' from ''$startdir'' and ''$srcdir'' to ''$subpkgdir''.

: The split function can be specified in 1 of 3 different methods:
:# subpkgname:'''splitfunc'''
:# $pkgname-'''splitfunc'''
:# '''splitfunc'''

: {{Note|Split function names '''cannot''' use hyphens; use the first method above if the subpackage name contains a hyphen (-) character, like this: ''subpkg-name:subpkg_name'', where <code>subpkg-name</code> is the name of the '''subpackage''' and <code>subpkg_name</code> is the name of the '''subpackage's split function'''.}}

: {{Tip|For more information, see the [[APKBUILD_examples:Subpackages|Subpackages example]].}}

==== triggers ====
: Apk-tools can "monitor" directories and execute a trigger if any package installed/uninstalled any file in the monitored dir. The triggers are always executed after the apk action (install, uninstall, upgrade).

: The triggers are specified in the format: ''scriptname''=''pathlist'' where ''scriptname'' is the (sub)package name + .trigger suffix and pathlist is : separated list of the dirs to monitor.

: The '''triggers''' variable must include the triggers for subpackages too if they have any.

: It is possible to use wildcards (*) in the dir list.

==== url ====
: The homepage for the package. This is to help users find upstream documentation and other information regarding the package.

==== langdir ====
: Path to where the language files are located for the '''-lang''' subpackage, defaults to '''/usr/share/locale'''

==== pcprefix ====
: Prefix all provides derived from parsing pkg-config Requires: with the value in this variable, example: ''''pcprefix="foo:"''' will produce '''pc:foo:bar'''

==== sonameprefix ====
: Prefix all provides derived from parsing shared objects with the value in this variable, example: '''sonameprefix="foo"''' will produce '''so:foo:bar.so.X'''

= Functions =
{{Note|All functions that are not ''prepare()'', ''build()'', ''check()'' and ''package()'' should consider the current working directory as undefined, and should therefore use the [[APKBUILD Reference#abuild-defined_variables|abuild-defined directory variables]] to their advantage.}}

sanitycheck() -> clean()-> fetch() -> verify() -> unpack() -> prepare() -> mkusers() -> build() -> check() -> package() -> subpackages() -> language packs -> apk -> cleanup()

== abuild-defined functions ==
The following functions are provided by abuild and can be overridden, but it is strongly discouraged on code review for some functions:

==== fetch() ====
: Downloads remote sources listed in ''source'' to ''SRCDEST'' (''SRCDEST'' is configured in ''/etc/abuild.conf'') and creates symlinks in ''$srcdir''.
==== unpack() ====
: unpack() will call default_unpack().

: [https://github.com/alpinelinux/abuild/blob/v3.1.0/abuild.in#L403 default_unpack()] unpacks .tar, .tgz, .tar.gz, .tar.lz (only available in Alpine >=3.7), .tar.bz2, .tar.lzma, .tar.xz, and .zip archives from a symlink in ''$srcdir'' associated with ''$SRCDEST'' (or distfiles folder) resulting in an unpacked folder in ''$srcdir''.

==== dev() ====
: Subpackage function for the '''$pkgname-dev''' package is used to collect developer files and folders for use in other packages in the compilation process nothing more. Without specifying a custom ''dev()'' function, abuild will call its internal ''dev()'' function, which in turn calls default_dev().

: ''[https://github.com/alpinelinux/abuild/blob/v3.1.0/abuild.in#L1605 default_dev()]'' will move any ''include'' folder and folders containing ''*.[acho]'' (static archive, c source, c header file, object file), ''*.prl'' file extension patterns in ''"$pkgdir"/{lib,usr}'' to ''"$subpkgdir"/{lib,usr}'' recursively; and ''*.so'' files from ''"$pkgdir"/{lib,usr/lib}'' to ''"$subpkgdir"/{lib,usr/lib}''. It will also scan and move ''usr/{include,lib/{pkgconfig,cmake,qt*/mkspecs},share/{aclocal,gettext,vala/vapi,gir-[0-9]*,qt*/mkspecs},bin/*-config}}'' developer only folders in ''$pkgdir'' and transfer them to ''$subpkgdir''.

: In general, default_dev() will support packages that share pkg-config, C programming language API, shared and static libraries, Autotools, gettext, Vala programming language bindings, Python GObject introspection, a provided custom pkg-config like command (*-config), Qt, and CMake. If you have packages that have C++, other languages, other build system, etc; you need to manually move those developer files only if they are to be used in other packages.

: '''Important''': For default_dev() to be called as in no dev(), you need to explicitly add subpackages="$pkgname-dev".

==== doc() ====
: Subpackage function for the '''$pkgname-doc''' package whose job is only to collect documentation folders from $pkgdir nothing more. Without specifying a custom ''doc()'' function, abuild will call its internal ''doc()'' function, which in turn calls default_doc().

: ''[https://github.com/alpinelinux/abuild/blob/v3.1.0/abuild.in#L1519 default_doc()]'' will move ''"$pkgdir"/usr/share/{doc,man,info,html,sgml,licenses,gtk-doc,ri,help}'' to ''$subpkgdir''.

: Overriding this function is strongly discouraged. Packaging docs should be done in the package() function while letting abuild automatically collect the doc folders.

: '''Important''': For default_doc() to be called as in no doc(), you need to explicitly add subpackages="$pkgname-doc".

==== openrc() ====
: Subpackage function for the '''$pkgname-opernc''' package whose job is to collect OpenRC service files that are in /etc/init.d and /etc/conf.d.

: ''[https://github.com/alpinelinux/abuild/blob/v3.1.0/abuild.in#L1661 default_openrc()]'' will move ''"$pkgdir"/etc/{conf,init}.d'' to ''$subpkgdir''.

: Overriding this function is strongly discouraged. Packaging OpenRC service definitions should be in the package() function while letting abuild automatically collect the openrc folders.

: '''Important''': for default_openrc() to be called as in no openrc(), you need to explicitly add subpackages="$pkgname-openrc".

==== static() ====
: Subpackage function for the '''$pkgname-static''' package whose job is to collect static libraries that are stored in /lib and /usr/lib.

: ''[https://github.com/alpinelinux/abuild/blob/v3.4.0_rc4/abuild.in#L1748 default_static()]'' will move all static libraries (files ending with .a) from ''"$pkgdir"/lib'' and ''"$pkgdir"/usr/lib'' to their equivalents in ''$subpkgdir''.

: Overriding this function is strongly discouraged. Packaging static libraries should be done in the package() function while letting abuild automatically collect the static libraries.

: '''Important''': for default_static() to be called as in no static(), you need to explicitly add subpackages="$pkgname-static".

==== snapshot() ====
: '''Optional'''. For live APKBUILDs or those with a _cvs, _svn, _git, _hg in their version number, you should create a snapshot function only if there is no download link to an archive file (.zip, .tar.gz, ...) to the commit/hash/tag. The purpose of the snapshot function is to create an archive of the source code so that the package source code is deterministic, and it doesn't waste time to fetch the source code but bypasses the download step after snapshotting. Those that download the source code from a git repository will follow head or the latest change to the source code. It is better to archive the source code as a zip / tar.gz / tar.bz2 up to the commit or the tag which you are trying to build a package. If it is not deterministic or not every part of the code frozen in time for every dependency and the main project, then the patches will fail or the package may fail to compile when you revisit the package months or years to backport a patch.

: The default [https://github.com/alpinelinux/abuild/blob/v3.1.0/abuild.in#L2310 snapshot()] function has variables associated with it:
:* $disturl - the base-url of the place to autoupload the snapshot
:* $svnurl - Subversion repository
:* $giturl - Git repository

: The default snapshot() can only support one repository. It is better to override it if there are multiple repositories involved in your package. CVS, Mercurial (hg), and alternative version control systems must override the default snapshot().

: See [[APKBUILD_examples:Git_checkout]] to how to use it with git. It takes 2-3 general steps. Clone the repository; check it out at a specific revision/commit or tag; then you use an archiver to dump it in the ''$SRCDEST'' variable which points to the distfiles folder and the base path to the full path to the archive that you want to create. You do this for every internal dependency that the package pulls.

: After you have created your snapshot function, you use <code>abuild snapshot</code> to run it.

: The archives produced by the snapshot will be saved in ''/var/cache/distfiles'' or whatever you set for ''$SRCDEST''. You may need to create symlinks to the archive if the archive is not saved to the Alpine server.

: After you snapshot it, you need to produce the checksums with <code>abuild checksum</code> to use it in the APKBUILD creation process.

: This feature is available since Alpine >=2.6.

==== default_prepare() ====

: Before build preparation it handles set of patches inside <code>$srcdir</code> and prints failed ones.

== User-defined functions ==
The following functions should be defined by the user:

==== prepare() ====
: {{note|Please adjust old APKBUILDs, which still have a ''prepare()'' function that does the same as the ''default_prepare()'' when you edit them anyway.}}
: '''''Optional''.''' Used for build preparation: patches, etc, should be applied here. When you don't specify a custom ''prepare()'', the built-in ''default_prepare()'' from abuild will be used. It applies patches already (always prepare them in the <code>-p1</code> format), so '''usually it makes sense to not create a custom ''prepare()'' function at all!''' If you do create one, call ''default_prepare()'' inside it:

: Before default_prepare gets called, you can define ''patch_args'' to supply the argument to the patch command in global scope then throw away prepare() so it is unnecessary to use the old template code floating around to patch. patch_args and autopatching is only available in Alpine >=3.4. See [[Creating_an_Alpine_package#Patches]] to fix the patch that uses a different patch level (-pX).

<pre>
prepare() {
default_prepare
# your custom code here
}
</pre>

==== build() ====
: '''Required.''' This is the compilation stage. This function will be called as the current user (unless the ''package()'' function is missing - for compatibility reasons). If no compilation is needed, this function can contain a single line: <code>return 0</code>

: To enable or disable CFLAGS, CXXFLAGS, CMake with option, or configure option per arch, use the CARCH variable:
<pre>
local cmakeoptions=
case "$CARCH" in
aarch64*|arm*|ppc64le|x86|s390x) cmakeoptions="$cmakeoptions -DWITH_OPENMP=OFF" ;;
x86_64) cmakeoptions="$cmakeoptions -DWITH_OPENMP=ON" ;;
*) msg "Unable to determine architecture from (CARCH=$CARCH)" ; return 1 ;;
esac
</pre>
: The block can be used in other parts of the APKBUILD even in global.

==== check() ====
: '''Required if functionality exists.''' This function is called right after the build stage. It should check that the packaged thing is actually working, typically by running (integration) tests, if provided by upstream. If there’s no (easy) way how to test the package, you can declare that it does not want to use ''check()'' by adding "!check" into the ''options'' variable (<code>options="!check"</code>).

: default_check() does nothing. You need to manually explicitly call the unit tests or test suite yourself. When you run the test, the program should return with an exit code of 0, indicating the tests were a success. Unit tests or test suites will do feature tests, per function correctness check, fuzz testing, benchmarks.

: A package may also require additional testing frameworks packages that are external dependencies. You should add those to the ''checkdepends='' in Alpine >=3.6 or ''makedepends='' for older for backporters. If the testing framework is not available, you need to create a package for it. If it requires a specific version of a testing framework, consider making it an internal dependency or a new package with a package name containing the major and minor version number like the python packages.

: Generally speaking, you should define the check functions for libraries, large programs like web browsers, or compilers and interpreters, cryptographic/security/anonymity stuff, mission critical stuff, PCI compliance/money/accounting software, server software with a lot of stakeholders or consumers. Soon for the new policy change will have virtually '''all packages with testing capabilities be required to have a working and defined check() function'''.

: There are times when the unit tests do not work, just because the test itself is broken, new unimplemented feature, external factors not taken into consideration, unbundling path differences, breakage caused by ccache, missing test dependency or version mismatch dependency as in python2 vs python3, test scripts only work for particular language implementation like only supporting python2 but not python3 having used the 2to3 conversion script. If a unit test is known not to work, you may need to patch it to omit that test or fix it; but, certain tests should not be disabled if it is important. You may need to alter the references to uncompiled internal dependencies to work with the external dependencies instead. For ccache, you can either disable it or remove it from the PATH environmental variable before running tests.

{{Note|Tests for graphical applications and toolkits might work on a X11 user setup but will fail on the server unless run with xvfb-run.}}

: If you don't add the ''check()'' and the ''options='', this is what you will see:

>>> WARNING: py-webtest*: APKBUILD does not run any tests!
Alpine policy will soon require that packages have any relevant testsuites run during the build process.
To fix, either define a check() function, or declare !check in $options to indicate the package does not have a testsuite.

: If you do not do a check or disable it, you must state there is no testsuite in comment form (#) next to options="!check" for the code reviewers.

: To run test suite with autotools do:

make check

: To run the test suite with python setuptools:

python2 setup.py test
python3 setup.py test

: For python it should be '''test''' not check. Check for python setuptools will check the packaging metadata fields[https://docs.python.org/3/distutils/examples.html#checking-a-package] only but not run the unit tests. There should be verbose output also. The dependencies for the tests are found in test_require in the setup.py.

: If it says <code>Ran 0 tests in 0.000s</code> that is not acceptable. check() will say it was good but it is not actually correct. It needs to run the test suite with an alternative method like <code>tox -e py27,py36</code> if you see a tox.ini file.

: You want to do it for each implementation to ensure that the API calls are correct per implementation but ncopa said it was just fine with python3.

: If there is a circular dependency for the checkdepends=, you need to disable the check and put the reason next to <code>options="!check"</code> that there is a circular dependency. You should disable it for the package that package that is least important or least security risk. The other solution is to make the conflicting dependency an internal dependency but making sure that it doesn't pull it at check time. This way they can both preform tests properly.

==== package() ====
: '''Required.''' This is the packaging stage. Here, the built application and support files should be installed into '''$pkgdir'''. If this is a metapackage, this function can contain a single line: <code>mkdir -p "$pkgdir"</code>

{{Note|Building in fakeroot will reduce performance for parallel builds dramatically. It is for this reason that we split the build and package process into two separate functions.}}

= Examples =
The [[APKBUILD examples]] page will assist you in understanding how to create an APKBUILD.

= Version =

This document assumes abuild for Alpine Edge. For older releases of abuild, some of these features may not be available if you are using an older release. A link to the implementation is linked for researchers and backporters.

For more information see [[APKBUILD_versions]].

[[Category:Development]]

Installation

2020-08-27T23:12:45Z

Leo:

Alpine Linux can be installed as the main operating system on a physical machine ("bare metal"), including on embedded devices. For example, [https://en.wikipedia.org/wiki/PostmarketOS PostmarketOS] is a smartphone operating system based on Alpine. While this use case is less common than Alpine Linux's main use as a base system for container images in systems like Docker, this document describes how Alpine can be installed as the primary operating system for a computer.

Alpine in fact works as a [https://en.wikipedia.org/wiki/Live_USB live system]—any install disk of Alpine can also be run without installing to local storage of the machine it's booted on, running directly from the install media!

__TOC__
__FORCETOC__

= Quick Requirements =

Nearly any hardware should run Alpine Linux but the following basic requirements are recommended:

* At least 128MB of RAM for server without GUI, or at least 1.6GB for graphical desktop
* At least 1GB storage device for server without GUI, or at least 10GB for graphical desktop with web browsing

For more information, see [[Requirements]].

[[File:Installation-alpine-alpine-setup-2-boot.png|350px|thumb|right|Installation : setup-alpine : booting process until login prompt]]

= Installation Overview =

The following steps are brief and intended for the common case; for complete info and other architectures, please consult the [[Alpine newbie install manual]].

== 1. Download the media source ==

The most common is to grab an ISO from [http://alpinelinux.org/downloads]. Take note of architectures in green buttons.

== 2. Dump, burn or flash the image ==

Dump the ISO image onto a media source like USB/SD flashing; or CD/DVD/BR disk with burning software.
In Linux, you can use <code><nowiki>dd if=<your iso filename> of=<your target media> bs=1M; sync</nowiki></code>, to flash a USB drive or SD card as target media install.

== 3. Boot and install process ==

Log in as the user <code>root</code> by typing <code>root</code> and hitting ''enter''. Then execute <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code>, answering the questions and hitting ''enter'' after each:

[[File:Installation-alpine-alpine-setup-3-setup-scripts.png|350px|thumb|right|Installation : setup-alpine : complete process single install]]

* '''Select keyboard layout''': Choose your keyboard layout, e.g. ''us'' or ''es''.
** '''Select variant''': Choose your keyboard layout variant, e.g. ''us-nodeadkeys'' or ''es-winkeys''.
* '''Enter system hostname''': Choose the name of your computer; '''localhost''' is good enough and recommended for starting.
* '''Initialize network cards''': Here most people can just go with the default (just press enter).
** '''Any manual configuration''': Perform other configuration if needed, otherwise just type "no" and hit enter.
** '''Select domain name''': This is not commonly asked, you can just hit enter.
* '''DNS nameservers?''': If asked, <code>8.8.8.8</code> is a recommended default that will be good for most people.
* '''Changing password for root''': Next a root password must be defined. Input a passphrase; what you type won't be shown on the screen.
** '''Retype password''': Type the same passphrase to confirm the root password; what you type won't be shown on the screen.
* '''Which timezone to choose?''': Set it to your local time zone or hit enter for <code>UTC</code>.
* '''Proxy chooser''': Type <code>none</code> and hit enter if you're not using a proxy.
* '''Which NTP client to run?''': This is for keeping the system clock in sync. The default is good enough for most people.
* '''Enter mirror number''': <code>1</code> is a good choice for most people.
* '''Which SSH server?''': An SSH server allows you to remotely manage your machine. The default is good enough for most people.
* '''Disk Setup''' Choose how to set up your disks.
** '''Which disks would you like to use?''': Choose the disk where files will be installed. Usually <code>sda</code> is the hard disk and <code>sdb</code> is the USB boot or CD/DVD image.
** '''How would you like to use it?''': Type "sys" and then press enter. This will cause the OS to be installed to the chosen disk—similar to how other distributions work.

Take care that '''all data on your chosen disk will be erased'''. A final question will prompt you to continue. After confirming by typing 'y' and hitting enter, you cannot turn back.

After the script finishes installing the system, it will tell you to reboot. Note that:

* If the configured [[Alpine_setup_scripts#sys_mode|runtime mode was "sys"]], then remove the initial installation media to boot the newly installed system.
* If the configured [[Alpine_setup_scripts#diskless_mode|runtime mode was "data"]], then keep the installation media inserted to boot the newly installed system.

To reboot, type <code>reboot</code> and hit enter. If you just wish to turn off the machine after installing, type <code>poweroff</code> instead.

= Further Documentation =

The installation script only installs the base operating system. Applications such as a web server, mail server, desktop environment, or web browser are not installed and <code>root</code> is the only normal user. For instructions on proceeding after installation, please see [[Tutorials_and_Howtos#Post-Install|Tutorials_and_Howtos Post-Install section]].

More specific instructions and instructions for other architectures or machines (e.g. ARM, RPi, etc) are defined in [[Tutorials_and_Howtos#Installation:_Use_cases|Installation:_Use_cases]]. Also see the following wiki pages for more information:

* [[FAQ|FAQs]]
* [[Tutorials and Howtos]]
* [[Contribute|How to Contribute]]
* [[Developer Documentation]]
* [[Newbie Alpine Ecosystem]]
* [https://mckayemu.github.io/alpineinstalls/ https://mckayemu.github.io/alpineinstalls/ All informatin for Spanish users]

[[Category:Installation]]

Release Notes for Alpine 3.12.0

2020-05-22T07:27:42Z

Leo: /* abuild */

== aports ==

===== python2 no longer provides python and python-devel =====

python2 no longer provides python and python-devel, nothing does, it is now required that you explicitly depend on either python2 or python3, any new contributions that depend on python2 will be rejected summarily, and python2 is in the process of being **completely** removed

===== llvm 10.0.0 =====

llvm 10 is now the default in Alpine Linux.

[https://gitlab.alpinelinux.org/alpine/aports/commit/7a1323c27479fb967749c163f34483bc1196055d commit]

===== Initial support for DLang =====

We've added initial support for the D language with this release. We now have GDC, the D compiler frontend using GCC, available on all arches but ppc64le and LDC, a D compiler using the LLVM backend, on x86, x86_64 and aarch64. Most things are built against LDC, since it offers superior optimization and a vastly newer versions of the D runtime and standard library. These contain many important bug fixes (especially on aarch64) and contain features required by many D applications.

===== py3-setuptools now uses system python3 modules instead of vendored dependencies =====

py3-setuptools now installs py3-packaging, py3-parsing, py3-appdirs, py3-six and py3-ordered-set from the system.

The following commits are the ones responsible for this change:

* [https://git.alpinelinux.org/aports/commit/?id=efca8852f37cb4028f234f92e2d035617f524820 py3-six] (use distutils)
* [https://git.alpinelinux.org/aports/commit/?id=55e3496387ad3f2df387b2cf6bc84e85ef729833 py3-ordered-set] (new aport)
* [https://git.alpinelinux.org/aports/commit/?id=cc1636b08fba58b629501d525d658aed4bcbeab2 py3-ordered-set] (move from testing to main)
* [https://git.alpinelinux.org/aports/commit/?id=da743693eda54b9faf5086746b91506495fc689f py3-appdirs] (move from community to main)
* [https://git.alpinelinux.org/aports/commit/?id=60efe787954008af546a5bde839db09f11682102 py3-appdirs] (use distutils)
* [https://git.alpinelinux.org/aports/commit/?id=a50097b40bcf80a9aec201fef73a722206f43a0d py3-packaging] (use distutils)
* [https://git.alpinelinux.org/aports/commit/?id=52ee5092c510657e9b1e8b4ae0104d405c9eac99 py3-parsing] (install manually)
* [https://git.alpinelinux.org/aports/commit/?id=33ea734e2d28d88a3d545500c96b4c72b3e78432 py3-setuptools] (use system component)

===== ncurses fixes =====

A few fixes trickled in relating exclusively to Alpine Linux that affect ncurses:

With this [https://git.alpinelinux.org/aports/commit/?id=762b9fd601983d8a6e6a60692158f3f22b1b60fe commit] the ncurses-lib package no longer depends on the ncurses-terminfo, which was too big at 7.5 MB, instead ncurses-lib now depends solely on the ncurses-terminfo-base package which weights at around 120 kB.

With this [https://git.alpinelinux.org/aports/commit/?id=56aa7795fecc48561deb095995abd335e16ba515 commit] the ncurses-terminfo-base now includes the most common terminfo databases like tmux, screen, xterm-256color and also databases for packaged terminals like gnome-terminal, vte, konsole, alacritty, kitty, putty. All other terminfo databases are now in ncurses-terminfo.

With this [https://git.alpinelinux.org/aports/commit/?id=1470a6c8e76491a8d059ebd4b7521c4bf20b837c commit] all terminals that have their terminfo databases provided by the ncurses-terminfo-base now depend on it.

===== python3 no longer provides pip3, use py3-pip from community =====

Python3 is now built with --without-ensurepip which removes pip3 and its libraries from it. Instead use the py3-pip pacakge which uses system components.

===== BPF JIT support =====

> TODO: Small preamble about BPF

So it (BPF JIT) has been enabled by default in [https://git.alpinelinux.org/aports/commit/?id=3bf2313adc57fe6b36bf459ddca6d65a392609db 3bf2313adc57fe6b36bf459ddca6d65a392609db], and unprivileged BPF JIT has been disabled in [https://git.alpinelinux.org/aports/commit/?id=4e286992d5ed751f6ca60eb18d77313bb0868513 4e286992d5ed751f6ca60eb18d77313bb0868513].

===== OpenRC now has a sane ordering of directories when configuring kernel parameters =====

Configuring kernel parameters is done by having configuration files in specific locations like <code>/etc/sysctl.conf</code> and files ending with <code>.conf</code> in certain directories like <code>/etc/sysctl.d</code>. Before 3.12.0 the ordering had no logical explanation and
surprised users that expected a hierarchy.

Starting with 3.12.0 the ordering is as follows:

# /lib/sysctl.d/*.conf
# /usr/lib/sysctl.d/*.conf
# /run/sysctl.d/*.conf
# /etc/sysctl.conf
# /etc/sysctl.d/*.conf

<code>/lib/sysctl.d</code> and <code>/usr/lib/sysctl.d</code> are to be used by the distribution and packages. Alpine Linux installs its default configuration file in <code>/lib/sysctl.d/00-alpine.conf</code>. Software installed via our package manager will install to either of those places.

<code>/run/sysctl.d</code> holds configuration that is created at run-time by daemons/services or at very early-boot. Neither the distribution nor the packaged software will install configuration to it, primarily because /run is in temporary memory. Configuration in this location that matches names the locations used by the distribution and packages will cause the latter not to be read and applied by the <code>sysctl</code> service.

<code>/etc/sysctl.d</code> holds configuration that is created and maintained by the local administrator, neither Alpine nor its packaged software will touch it, and configuration in that has the same name as in the location reserved for the distribution and packages, or the location for run-time configuration from daemons/services, will cause the latter to not be read and applied by the <code>sysctl</code> service.

<code>/etc/sysctl.conf</code> is a historical location for this kind of configuration and is kept for the same reasons.

===== OpenRC now has a sane ordering of directories when loading kernel modules =====

Loading kernel modules during boot is done with the <code>modules</code> OpenRC service, which reads configuration files in certain locations and loads kernel modules with the modprobe utility from either busybox or util-linux.

Starting with 3.12.0 a more logical ordering is adopted for which configuration files to read and ignore:

# /lib/modules-load.d/*.conf
# /usr/lib/modules-load.d/*.conf
# /run/modules-load.d/*.conf
# /etc/modules
# /etc/modules-load.d/*.conf

<code>/lib/modules-load.d</code> and <code>/usr/lib/modules-load.d</code> are to be used by the distribution and packages. Software installed via our package manager will install to either of those places.

<code>/run/modules-load.d</code> holds configuration that is created at run-time by daemons/services or at very early-boot. Neither the distribution nor the packaged software will install configuration to it, primarily because /run is in temporary memory. Configuration in this location that matches names in the locations used by the distribution and packages will cause the latter not to be read and applied by the <code>modules</code> service.

<code>/etc/modules-load.d</code> holds configuration that is created and maintained by the local administrator, neither Alpine nor its packaged software will touch it, and configuration in that has the same name as in the location reserved for the distribution and packages, or locations reserved for the run-time configuration of daemons/services, will cause the latter to not be read and applied by the <code>modules</code> service.

<code>/etc/modules</code> is a historical location for this kind of configuration and is kept for the same reasons.

===== Telegram Desktop is now available in the community repo =====

See [https://git.alpinelinux.org/aports/commit/?id=184355fdc44bc2e12976d65518fe029d8a6e459d commit] that moved the package to the community repo for explanation.

===== efitools and sbsigntool are now in main/ =====

Those packages have lived in testing/ for a long time and have been successfully used by one of our developers to implement secure-boot in his system. They have been moved to main/ and will be available for others.

===== Packages which need libsecret's DBus API now depend a provider of its API via dbus:org.freedesktop.Secret =====

Previously it was possible to install a program which required the DBus API of libsecret (e.g. Fractal), but not install a secrets provider (e.g. gnome-keyring), so logins wouldn't be saved. This has been corrected and packages which require this API depend on the provider-package dbus:org.freedesktop:Secret now. It's provided by gnome-keyring, kwallet and keepassxc (in that order of importance, i.e. if none of these is pulled in gnome-keyring will be chosen by default). Right now we manually declared the provider for dbus:org.freedesktop.Secret, but eventually we should have an automatic detection for the DBus API packages provide to make this easier for other packages.

===== Preferring enchant2 over enchant =====

All packages which support enchant2 have been moved over to it instead of using enchant(1). enchant2 now also supports nuspell, which is a faster drop-in replacement for hunspell, which utilizes hunspell's dictionaries.

===== Firefox is now in community =====

Firefox finally left testing and will be in community, supported for 6 months.

===== moonjit is now luajit =====

Our luajit package switched to the alive moonjit fork which has, among other things, s390x support and actual development.

This [https://git.alpinelinux.org/aports/commit/?id=af7f776d08cf7c12c3dd62347829fe33e66dceaa commit] switched luajit over to moonjit, the following [https://git.alpinelinux.org/aports/commit/?id=a7d057d98859940cc3347dba011957f99291b1fa commit] removes our **HUGE** 46k s390x support patch which is now handled by upstream.

===== Support for YubiKeys =====

yubikey-manager and yubikey-manager-qt have been added to the community repos for using and managing your yubikeys. Installing yubikey-manager and enabling the pcscd service should make yubikeys functional.

===== Support for apk in GNOME Software =====

GNOME Software now offers integration with apk, the Alpine Package Keeper, so desktop applications can be installed via a GUI.

===== busybox no longer provider 'patch' builtin =====

The builtin is a prototype which fails the moment any fuzzing needs to be done and as such is not usable too many cases to justify its inclusion, build-base (which provider compilers and other development tools) now depends on patch and others need to install patch by themselves if they plan on using it.

the abuild package already depended on it and it is widely used in Alpine Linux's aports.

== abuild ==

===== Add default functions for subpackages that hold Bash, Zsh and Fish completion =====

abuild now provides default functions for $pkgname-bash-completion, $pkgname-zsh-completion and $pkgname-fish-completion subpackages.

Expected location of the completion files per shell:

* Bash -> <code>/usr/share/bash-completion/completions</code>
* Zsh -> <code>/usr/share/zsh/site-functions</code>
* Fish -> <code>/usr/share/fish/completions</code>

Files must be installed in the expected location in relation to '''$pkgdir''' in '''pacakge()'''.

Introduced in [https://gitlab.alpinelinux.org/alpine/abuild/commit/d5826968b713123a4f51d3dec1adb1225d0e194f d5826968b713123a4f51d3dec1adb1225d0e194f].

===== newapkbuild when called with CMake (-C) does out-of-source builds by default =====

When packaging with newapkbuild and using the -C switch to pre-fill the apkbuild with skeleton functions for CMake now:

* Adds <code>-B build</code> to the <code>cmake</code> call in '''build()'''.
* Adds <code>-C build</code> the <code>make</code> calls.

Doing out-of-source builds are recommended upstream to the point where warnings are printed when calling CMake on a project.

Introduced in [https://gitlab.alpinelinux.org/alpine/abuild/commit/e125a764896d884c69cc409e614b65cb336c15e8 e125a764896d884c69cc409e614b65cb336c15e8].

===== set CARGO_HOME to cache dependencies of rust packages =====

CARGO_HOME is now set to '''$SRCDEST/cargo''' and will cache all dependencies downloaded.

Introduced in [https://gitlab.alpinelinux.org/alpine/abuild/commit/af0c88e6abbb1e49224759f5c51b3068e6eab28b af0c88e6abbb1e49224759f5c51b3068e6eab28b].

===== The "plain" buildtype for Meson and "None" buildtype for CMake are used now =====

We previously used the "release" or "debugoptimized" buildmode for Meson or "Release" or "RelWithDebInfo" for CMake. This caused Meson and CMake to ignore parts of our C{,XX}FLAGS, e.g. by setting -O2 or even -O3 instead of our default of -Os. We've changed to the "plain" buildtype and the "None" buildtype for CMake. This should result in smaller binaries since -Os is respected now. See [https://lists.alpinelinux.org/~alpine/devel/%3C2896c13070c508a49cbaa72c8fb7f34ea947358b.camel%40cogitri.dev%3E the respective mailing list post]

==== abuild-meson introduced ====

abuild-meson is a small wrapper shellscript that wraps meson (directly inspired by Arch Linux's arch-meson and Void Linux's build_style=meson), calling it with the correct options for packaging in Alpine Linux. APKBUILDs should switch to using it to guarantee all APKBUILDs that use meson have the same set of options.

Release Notes for Alpine 3.12.0

2020-05-22T07:20:00Z

Leo:

Release Notes for Alpine 3.12.0

2020-04-18T11:40:44Z

Leo: /* python3 now provides cmd:python */

== aports ==

===== python2 no longer provides python and python-devel =====

python2 no longer provides python and python-devel, nothing does, it is now required that you explicitly depend on either python2 or python3, any new contributions that depend on python2 will be rejected summarily, and python2 is in the process of being **completely** removed

===== llvm 10.0.0 =====

llvm 10 is now the default in Alpine Linux.

[https://gitlab.alpinelinux.org/alpine/aports/commit/7a1323c27479fb967749c163f34483bc1196055d commit]

===== Initial support for DLang =====

We've added initial support for the D language with this release. We now have GDC, the D compiler frontend using GCC, available on all arches but ppc64le and LDC, a D compiler using the LLVM backend, on x86_64. Most things are built against ldc and as such only available on x86_64 right now due to GDC shipping a rather outdated version of the Phobos, the D standard library.

===== py3-setuptools now uses system python3 modules instead of vendored dependencies =====

py3-setuptools now installs py3-packaging, py3-parsing, py3-appdirs, py3-six and py3-ordered-set from the system.

The following commits are the ones responsible for this change:

* [https://git.alpinelinux.org/aports/commit/?id=efca8852f37cb4028f234f92e2d035617f524820 py3-six] (use distutils)
* [https://git.alpinelinux.org/aports/commit/?id=55e3496387ad3f2df387b2cf6bc84e85ef729833 py3-ordered-set] (new aport)
* [https://git.alpinelinux.org/aports/commit/?id=cc1636b08fba58b629501d525d658aed4bcbeab2 py3-ordered-set] (move from testing to main)
* [https://git.alpinelinux.org/aports/commit/?id=da743693eda54b9faf5086746b91506495fc689f py3-appdirs] (move from community to main)
* [https://git.alpinelinux.org/aports/commit/?id=60efe787954008af546a5bde839db09f11682102 py3-appdirs] (use distutils)
* [https://git.alpinelinux.org/aports/commit/?id=a50097b40bcf80a9aec201fef73a722206f43a0d py3-packaging] (use distutils)
* [https://git.alpinelinux.org/aports/commit/?id=52ee5092c510657e9b1e8b4ae0104d405c9eac99 py3-parsing] (install manually)
* [https://git.alpinelinux.org/aports/commit/?id=33ea734e2d28d88a3d545500c96b4c72b3e78432 py3-setuptools] (use system component)

===== ncurses fixes =====

A few fixes trickled in relating exclusively to Alpine Linux that affect ncurses:

With this [https://git.alpinelinux.org/aports/commit/?id=762b9fd601983d8a6e6a60692158f3f22b1b60fe commit] the ncurses-lib package no longer depends on the ncurses-terminfo, which was too big at 7.5 MB, instead ncurses-lib now depends solely on the ncurses-terminfo-base package which weights at around 120 kB.

With this [https://git.alpinelinux.org/aports/commit/?id=56aa7795fecc48561deb095995abd335e16ba515 commit] the ncurses-terminfo-base now includes the most common terminfo databases like tmux, screen, xterm-256color and also databases for packaged terminals like gnome-terminal, vte, konsole, alacritty, kitty, putty. All other terminfo databases are now in ncurses-terminfo.

With this [https://git.alpinelinux.org/aports/commit/?id=1470a6c8e76491a8d059ebd4b7521c4bf20b837c commit] all terminals that have their terminfo databases provided by the ncurses-terminfo-base now depend on it.

===== python3 no longer provides pip3, use py3-pip from community =====

Python3 is now built with --without-ensurepip which removes pip3 and its libraries from it. Instead use the py3-pip pacakge which uses system components.

===== BPF JIT support =====

> TODO: Small preamble about BPF

So it (BPF JIT) has been enabled by default in [https://git.alpinelinux.org/aports/commit/?id=3bf2313adc57fe6b36bf459ddca6d65a392609db 3bf2313adc57fe6b36bf459ddca6d65a392609db], and unprivileged BPF JIT has been disabled in [https://git.alpinelinux.org/aports/commit/?id=4e286992d5ed751f6ca60eb18d77313bb0868513 4e286992d5ed751f6ca60eb18d77313bb0868513].

===== OpenRC now has a sane ordering of directories when configuring kernel parameters =====

Configuring kernel parameters is done by having configuration files in specific locations like <code>/etc/sysctl.conf</code> and files ending with <code>.conf</code> in certain directories like <code>/etc/sysctl.d</code>. Before 3.12.0 the ordering had no logical explanation and
surprised users that expected a hierarchy.

Starting with 3.12.0 the ordering is as follows:

# /lib/sysctl.d/*.conf
# /usr/lib/sysctl.d/*.conf
# /run/sysctl.d/*.conf
# /etc/sysctl.conf
# /etc/sysctl.d/*.conf

<code>/lib/sysctl.d</code> and <code>/usr/lib/sysctl.d</code> are to be used by the distribution and packages. Alpine Linux installs its default configuration file in <code>/lib/sysctl.d/00-alpine.conf</code>. Software installed via our package manager will install to either of those places.

<code>/run/sysctl.d</code> holds configuration that is created at run-time by daemons/services or at very early-boot. Neither the distribution nor the packaged software will install configuration to it, primarily because /run is in temporary memory. Configuration in this location that matches names the locations used by the distribution and packages will cause the latter not to be read and applied by the <code>sysctl</code> service.

<code>/etc/sysctl.d</code> holds configuration that is created and maintained by the local administrator, neither Alpine nor its packaged software will touch it, and configuration in that has the same name as in the location reserved for the distribution and packages, or the location for run-time configuration from daemons/services, will cause the latter to not be read and applied by the <code>sysctl</code> service.

<code>/etc/sysctl.conf</code> is a historical location for this kind of configuration and is kept for the same reasons.

===== OpenRC now has a sane ordering of directories when loading kernel modules =====

Loading kernel modules during boot is done with the <code>modules</code> OpenRC service, which reads configuration files in certain locations and loads kernel modules with the modprobe utility from either busybox or util-linux.

Starting with 3.12.0 a more logical ordering is adopted for which configuration files to read and ignore:

# /lib/modules-load.d/*.conf
# /usr/lib/modules-load.d/*.conf
# /run/modules-load.d/*.conf
# /etc/modules
# /etc/modules-load.d/*.conf

<code>/lib/modules-load.d</code> and <code>/usr/lib/modules-load.d</code> are to be used by the distribution and packages. Software installed via our package manager will install to either of those places.

<code>/run/modules-load.d</code> holds configuration that is created at run-time by daemons/services or at very early-boot. Neither the distribution nor the packaged software will install configuration to it, primarily because /run is in temporary memory. Configuration in this location that matches names in the locations used by the distribution and packages will cause the latter not to be read and applied by the <code>modules</code> service.

<code>/etc/modules-load.d</code> holds configuration that is created and maintained by the local administrator, neither Alpine nor its packaged software will touch it, and configuration in that has the same name as in the location reserved for the distribution and packages, or locations reserved for the run-time configuration of daemons/services, will cause the latter to not be read and applied by the <code>modules</code> service.

<code>/etc/modules</code> is a historical location for this kind of configuration and is kept for the same reasons.

===== Telegram Desktop is now available in the community repo =====

See [https://git.alpinelinux.org/aports/commit/?id=184355fdc44bc2e12976d65518fe029d8a6e459d commit] that moved the package to the community repo for explanation.

===== efitools and sbsigntool are now in main/ =====

Those packages have lived in testing/ for a long time and have been successfully used by one of our developers to implement secure-boot in his system. They have been moved to main/ and will be available for others.

===== Packages which need libsecret's DBus API now depend a provider of its API via dbus:org.freedesktop.Secret =====

Previously it was possible to install a program which required the DBus API of libsecret (e.g. Fractal), but not install a secrets provider (e.g. gnome-keyring), so logins wouldn't be saved. This has been corrected and packages which require this API depend on the provider-package dbus:org.freedesktop:Secret now. It's provided by gnome-keyring, kwallet and keepassxc (in that order of importance, i.e. if none of these is pulled in gnome-keyring will be chosen by default). Right now we manually declared the provider for dbus:org.freedesktop.Secret, but eventually we should have an automatic detection for the DBus API packages provide to make this easier for other packages.

===== Preferring enchant2 over enchant =====

All packages which support enchant2 have been moved over to it instead of using enchant(1). enchant2 now also supports nuspell, which is a faster drop-in replacement for hunspell, which utilizes hunspell's dictionaries.

===== Firefox is now in community =====

Firefox finally left testing and will be in community, supported for 6 months.

===== moonjit is now luajit =====

Our luajit package switched to the alive moonjit fork which has, among other things, s390x support and actual development.

This [https://git.alpinelinux.org/aports/commit/?id=af7f776d08cf7c12c3dd62347829fe33e66dceaa commit] switched luajit over to moonjit, the following [https://git.alpinelinux.org/aports/commit/?id=a7d057d98859940cc3347dba011957f99291b1fa commit] removes our **HUGE** 46k s390x support patch which is now handled by upstream.

===== Support for YubiKeys =====

yubikey-manager and yubikey-manager-qt have been added to the community repos for using and managing your yubikeys. Installing yubikey-manager and enabling the pcscd service should make yubikeys functional.

== abuild ==

===== Add default functions for subpackages that hold Bash, Zsh and Fish completion =====

abuild now provides default functions for $pkgname-bash-completion, $pkgname-zsh-completion and $pkgname-fish-completion subpackages.

Expected location of the completion files per shell:

* Bash -> <code>/usr/share/bash-completion/completions</code>
* Zsh -> <code>/usr/share/zsh/site-functions</code>
* Fish -> <code>/usr/share/fish/completions</code>

Files must be installed in the expected location in relation to '''$pkgdir''' in '''pacakge()'''.

Introduced in [https://gitlab.alpinelinux.org/alpine/abuild/commit/d5826968b713123a4f51d3dec1adb1225d0e194f d5826968b713123a4f51d3dec1adb1225d0e194f].

===== newapkbuild when called with CMake (-C) does out-of-source builds by default =====

When packaging with newapkbuild and using the -C switch to pre-fill the apkbuild with skeleton functions for CMake now:

* Adds <code>-B build</code> to the <code>cmake</code> call in '''build()'''.
* Adds <code>-C build</code> the <code>make</code> calls.

Doing out-of-source builds are recommended upstream to the point where warnings are printed when calling CMake on a project.

Introduced in [https://gitlab.alpinelinux.org/alpine/abuild/commit/e125a764896d884c69cc409e614b65cb336c15e8 e125a764896d884c69cc409e614b65cb336c15e8].

===== set CARGO_HOME to cache dependencies of rust packages =====

CARGO_HOME is now set to '''$SRCDEST/cargo''' and will cache all dependencies downloaded.

Introduced in [https://gitlab.alpinelinux.org/alpine/abuild/commit/af0c88e6abbb1e49224759f5c51b3068e6eab28b af0c88e6abbb1e49224759f5c51b3068e6eab28b].

===== The "plain" buildtype for Meson and "None" buildtype for CMake are used now =====

We previously used the "release" or "debugoptimized" buildmode for Meson or "Release" or "RelWithDebInfo" for CMake. This caused Meson and CMake to ignore parts of our C{,XX}FLAGS, e.g. by setting -O2 or even -O3 instead of our default of -Os. We've changed to the "plain" buildtype and the "None" buildtype for CMake. This should result in smaller binaries since -Os is respected now. See [https://lists.alpinelinux.org/~alpine/devel/%3C2896c13070c508a49cbaa72c8fb7f34ea947358b.camel%40cogitri.dev%3E the respective mailing list post]

Release Notes for Alpine 3.12.0

2020-04-06T22:38:19Z

Leo: /* aports */

== aports ==

===== python3 now provides cmd:python =====

calling python will open python3 instead of python2

===== llvm 10.0.0 =====

llvm 10 is now the default in Alpine Linux.

[https://gitlab.alpinelinux.org/alpine/aports/commit/7a1323c27479fb967749c163f34483bc1196055d commit]

===== Initial support for DLang =====

We've added initial support for the D language with this release. We now have GDC, the D compiler frontend using GCC, available on all arches but ppc64le and LDC, a D compiler using the LLVM backend, on x86_64. Most things are built against ldc and as such only available on x86_64 right now due to GDC shipping a rather outdated version of the Phobos, the D standard library.

===== py3-setuptools now uses system python3 modules instead of vendored dependencies =====

py3-setuptools now installs py3-packaging, py3-parsing, py3-appdirs, py3-six and py3-ordered-set from the system.

The following commits are the ones responsible for this change:

* [https://git.alpinelinux.org/aports/commit/?id=efca8852f37cb4028f234f92e2d035617f524820 py3-six] (use distutils)
* [https://git.alpinelinux.org/aports/commit/?id=55e3496387ad3f2df387b2cf6bc84e85ef729833 py3-ordered-set] (new aport)
* [https://git.alpinelinux.org/aports/commit/?id=cc1636b08fba58b629501d525d658aed4bcbeab2 py3-ordered-set] (move from testing to main)
* [https://git.alpinelinux.org/aports/commit/?id=da743693eda54b9faf5086746b91506495fc689f py3-appdirs] (move from community to main)
* [https://git.alpinelinux.org/aports/commit/?id=60efe787954008af546a5bde839db09f11682102 py3-appdirs] (use distutils)
* [https://git.alpinelinux.org/aports/commit/?id=a50097b40bcf80a9aec201fef73a722206f43a0d py3-packaging] (use distutils)
* [https://git.alpinelinux.org/aports/commit/?id=52ee5092c510657e9b1e8b4ae0104d405c9eac99 py3-parsing] (install manually)
* [https://git.alpinelinux.org/aports/commit/?id=33ea734e2d28d88a3d545500c96b4c72b3e78432 py3-setuptools] (use system component)

===== ncurses fixes =====

A few fixes trickled in relating exclusively to Alpine Linux that affect ncurses:

With this [https://git.alpinelinux.org/aports/commit/?id=762b9fd601983d8a6e6a60692158f3f22b1b60fe commit] the ncurses-lib package no longer depends on the ncurses-terminfo, which was too big at 7.5 MB, instead ncurses-lib now depends solely on the ncurses-terminfo-base package which weights at around 120 kB.

With this [https://git.alpinelinux.org/aports/commit/?id=56aa7795fecc48561deb095995abd335e16ba515 commit] the ncurses-terminfo-base now includes the most common terminfo databases like tmux, screen, xterm-256color and also databases for packaged terminals like gnome-terminal, vte, konsole, alacritty, kitty, putty. All other terminfo databases are now in ncurses-terminfo.

With this [https://git.alpinelinux.org/aports/commit/?id=1470a6c8e76491a8d059ebd4b7521c4bf20b837c commit] all terminals that have their terminfo databases provided by the ncurses-terminfo-base now depend on it.

===== python3 no longer provides pip3, use py3-pip from community =====

Python3 is now built with --without-ensurepip which removes pip3 and its libraries from it. Instead use the py3-pip pacakge which uses system components.

===== BPF JIT support =====

> TODO: Small preamble about BPF

So it (BPF JIT) has been enabled by default in [https://git.alpinelinux.org/aports/commit/?id=3bf2313adc57fe6b36bf459ddca6d65a392609db 3bf2313adc57fe6b36bf459ddca6d65a392609db], and unprivileged BPF JIT has been disabled in [https://git.alpinelinux.org/aports/commit/?id=4e286992d5ed751f6ca60eb18d77313bb0868513 4e286992d5ed751f6ca60eb18d77313bb0868513].

===== OpenRC now has a sane ordering of directories when configuring kernel parameters =====

Configuring kernel parameters is done by having configuration files in specific locations like <code>/etc/sysctl.conf</code> and files ending with <code>.conf</code> in certain directories like <code>/etc/sysctl.d</code>. Before 3.12.0 the ordering had no logical explanation and
surprised users that expected a hierarchy.

Starting with 3.12.0 the ordering is as follows:

# /lib/sysctl.d/*.conf
# /usr/lib/sysctl.d/*.conf
# /run/sysctl.d/*.conf
# /etc/sysctl.conf
# /etc/sysctl.d/*.conf

<code>/lib/sysctl.d</code> and <code>/usr/lib/sysctl.d</code> are to be used by the distribution and packages. Alpine Linux installs its default configuration file in <code>/lib/sysctl.d/00-alpine.conf</code>. Software installed via our package manager will install to either of those places.

<code>/run/sysctl.d</code> holds configuration that is created at run-time by daemons/services or at very early-boot. Neither the distribution nor the packaged software will install configuration to it, primarily because /run is in temporary memory. Configuration in this location that matches names the locations used by the distribution and packages will cause the latter not to be read and applied by the <code>sysctl</code> service.

<code>/etc/sysctl.d</code> holds configuration that is created and maintained by the local administrator, neither Alpine nor its packaged software will touch it, and configuration in that has the same name as in the location reserved for the distribution and packages, or the location for run-time configuration from daemons/services, will cause the latter to not be read and applied by the <code>sysctl</code> service.

<code>/etc/sysctl.conf</code> is a historical location for this kind of configuration and is kept for the same reasons.

===== OpenRC now has a sane ordering of directories when loading kernel modules =====

Loading kernel modules during boot is done with the <code>modules</code> OpenRC service, which reads configuration files in certain locations and loads kernel modules with the modprobe utility from either busybox or util-linux.

Starting with 3.12.0 a more logical ordering is adopted for which configuration files to read and ignore:

# /lib/modules-load.d/*.conf
# /usr/lib/modules-load.d/*.conf
# /run/modules-load.d/*.conf
# /etc/modules
# /etc/modules-load.d/*.conf

<code>/lib/modules-load.d</code> and <code>/usr/lib/modules-load.d</code> are to be used by the distribution and packages. Software installed via our package manager will install to either of those places.

<code>/run/modules-load.d</code> holds configuration that is created at run-time by daemons/services or at very early-boot. Neither the distribution nor the packaged software will install configuration to it, primarily because /run is in temporary memory. Configuration in this location that matches names in the locations used by the distribution and packages will cause the latter not to be read and applied by the <code>modules</code> service.

<code>/etc/modules-load.d</code> holds configuration that is created and maintained by the local administrator, neither Alpine nor its packaged software will touch it, and configuration in that has the same name as in the location reserved for the distribution and packages, or locations reserved for the run-time configuration of daemons/services, will cause the latter to not be read and applied by the <code>modules</code> service.

<code>/etc/modules</code> is a historical location for this kind of configuration and is kept for the same reasons.

===== Telegram Desktop is now available in the community repo =====

See [https://git.alpinelinux.org/aports/commit/?id=184355fdc44bc2e12976d65518fe029d8a6e459d commit] that moved the package to the community repo for explanation.

===== efitools and sbsigntool are now in main/ =====

Those packages have lived in testing/ for a long time and have been successfully used by one of our developers to implement secure-boot in his system. They have been moved to main/ and will be available for others.

===== Packages which need libsecret's DBus API now depend a provider of its API via dbus:org.freedesktop.Secret =====

Previously it was possible to install a program which required the DBus API of libsecret (e.g. Fractal), but not install a secrets provider (e.g. gnome-keyring), so logins wouldn't be saved. This has been corrected and packages which require this API depend on the provider-package dbus:org.freedesktop:Secret now. It's provided by gnome-keyring, kwallet and keepassxc (in that order of importance, i.e. if none of these is pulled in gnome-keyring will be chosen by default). Right now we manually declared the provider for dbus:org.freedesktop.Secret, but eventually we should have an automatic detection for the DBus API packages provide to make this easier for other packages.

===== Preferring enchant2 over enchant =====

All packages which support enchant2 have been moved over to it instead of using enchant(1). enchant2 now also supports nuspell, which is a faster drop-in replacement for hunspell, which utilizes hunspell's dictionaries.

===== Firefox is now in community =====

Firefox finally left testing and will be in community, supported for 6 months.

===== moonjit is now luajit =====

Our luajit package switched to the alive moonjit fork which has, among other things, s390x support and actual development.

This [https://git.alpinelinux.org/aports/commit/?id=af7f776d08cf7c12c3dd62347829fe33e66dceaa commit] switched luajit over to moonjit, the following [https://git.alpinelinux.org/aports/commit/?id=a7d057d98859940cc3347dba011957f99291b1fa commit] removes our **HUGE** 46k s390x support patch which is now handled by upstream.

===== Support for YubiKeys =====

yubikey-manager and yubikey-manager-qt have been added to the community repos for using and managing your yubikeys. Installing yubikey-manager and enabling the pcscd service should make yubikeys functional.

== abuild ==

===== Add default functions for subpackages that hold Bash, Zsh and Fish completion =====

abuild now provides default functions for $pkgname-bash-completion, $pkgname-zsh-completion and $pkgname-fish-completion subpackages.

Expected location of the completion files per shell:

* Bash -> <code>/usr/share/bash-completion/completions</code>
* Zsh -> <code>/usr/share/zsh/site-functions</code>
* Fish -> <code>/usr/share/fish/completions</code>

Files must be installed in the expected location in relation to '''$pkgdir''' in '''pacakge()'''.

Introduced in [https://gitlab.alpinelinux.org/alpine/abuild/commit/d5826968b713123a4f51d3dec1adb1225d0e194f d5826968b713123a4f51d3dec1adb1225d0e194f].

===== newapkbuild when called with CMake (-C) does out-of-source builds by default =====

When packaging with newapkbuild and using the -C switch to pre-fill the apkbuild with skeleton functions for CMake now:

* Adds <code>-B build</code> to the <code>cmake</code> call in '''build()'''.
* Adds <code>-C build</code> the <code>make</code> calls.

Doing out-of-source builds are recommended upstream to the point where warnings are printed when calling CMake on a project.

Introduced in [https://gitlab.alpinelinux.org/alpine/abuild/commit/e125a764896d884c69cc409e614b65cb336c15e8 e125a764896d884c69cc409e614b65cb336c15e8].

===== set CARGO_HOME to cache dependencies of rust packages =====

CARGO_HOME is now set to '''$SRCDEST/cargo''' and will cache all dependencies downloaded.

Introduced in [https://gitlab.alpinelinux.org/alpine/abuild/commit/af0c88e6abbb1e49224759f5c51b3068e6eab28b af0c88e6abbb1e49224759f5c51b3068e6eab28b].

===== The "plain" buildtype for Meson and "None" buildtype for CMake are used now =====

We previously used the "release" or "debugoptimized" buildmode for Meson or "Release" or "RelWithDebInfo" for CMake. This caused Meson and CMake to ignore parts of our C{,XX}FLAGS, e.g. by setting -O2 or even -O3 instead of our default of -Os. We've changed to the "plain" buildtype and the "None" buildtype for CMake. This should result in smaller binaries since -Os is respected now. See [https://lists.alpinelinux.org/~alpine/devel/%3C2896c13070c508a49cbaa72c8fb7f34ea947358b.camel%40cogitri.dev%3E the respective mailing list post]

Release Notes for Alpine 3.12.0

2020-03-29T20:24:30Z

Leo: /* aports */

== aports ==

===== llvm 10.0.0 =====

llvm 10 is now the default in Alpine Linux.

[https://gitlab.alpinelinux.org/alpine/aports/commit/7a1323c27479fb967749c163f34483bc1196055d commit]

===== Initial support for DLang =====

We've added initial support for the D language with this release. We now have GDC, the D compiler frontend using GCC, available on all arches but ppc64le and LDC, a D compiler using the LLVM backend, on x86_64. Most things are built against ldc and as such only available on x86_64 right now due to GDC shipping a rather outdated version of the Phobos, the D standard library.

===== py3-setuptools now uses system python3 modules instead of vendored dependencies =====

py3-setuptools now installs py3-packaging, py3-parsing, py3-appdirs, py3-six and py3-ordered-set from the system.

The following commits are the ones responsible for this change:

* [https://git.alpinelinux.org/aports/commit/?id=efca8852f37cb4028f234f92e2d035617f524820 py3-six] (use distutils)
* [https://git.alpinelinux.org/aports/commit/?id=55e3496387ad3f2df387b2cf6bc84e85ef729833 py3-ordered-set] (new aport)
* [https://git.alpinelinux.org/aports/commit/?id=cc1636b08fba58b629501d525d658aed4bcbeab2 py3-ordered-set] (move from testing to main)
* [https://git.alpinelinux.org/aports/commit/?id=da743693eda54b9faf5086746b91506495fc689f py3-appdirs] (move from community to main)
* [https://git.alpinelinux.org/aports/commit/?id=60efe787954008af546a5bde839db09f11682102 py3-appdirs] (use distutils)
* [https://git.alpinelinux.org/aports/commit/?id=a50097b40bcf80a9aec201fef73a722206f43a0d py3-packaging] (use distutils)
* [https://git.alpinelinux.org/aports/commit/?id=52ee5092c510657e9b1e8b4ae0104d405c9eac99 py3-parsing] (install manually)
* [https://git.alpinelinux.org/aports/commit/?id=33ea734e2d28d88a3d545500c96b4c72b3e78432 py3-setuptools] (use system component)

===== ncurses fixes =====

A few fixes trickled in relating exclusively to Alpine Linux that affect ncurses:

With this [https://git.alpinelinux.org/aports/commit/?id=762b9fd601983d8a6e6a60692158f3f22b1b60fe commit] the ncurses-lib package no longer depends on the ncurses-terminfo, which was too big at 7.5 MB, instead ncurses-lib now depends solely on the ncurses-terminfo-base package which weights at around 120 kB.

With this [https://git.alpinelinux.org/aports/commit/?id=56aa7795fecc48561deb095995abd335e16ba515 commit] the ncurses-terminfo-base now includes the most common terminfo databases like tmux, screen, xterm-256color and also databases for packaged terminals like gnome-terminal, vte, konsole, alacritty, kitty, putty. All other terminfo databases are now in ncurses-terminfo.

With this [https://git.alpinelinux.org/aports/commit/?id=1470a6c8e76491a8d059ebd4b7521c4bf20b837c commit] all terminals that have their terminfo databases provided by the ncurses-terminfo-base now depend on it.

===== python3 no longer provides pip3, use py3-pip from community =====

Python3 is now built with --without-ensurepip which removes pip3 and its libraries from it. Instead use the py3-pip pacakge which uses system components.

===== BPF JIT support =====

> TODO: Small preamble about BPF

So it (BPF JIT) has been enabled by default in [https://git.alpinelinux.org/aports/commit/?id=3bf2313adc57fe6b36bf459ddca6d65a392609db 3bf2313adc57fe6b36bf459ddca6d65a392609db], and unprivileged BPF JIT has been disabled in [https://git.alpinelinux.org/aports/commit/?id=4e286992d5ed751f6ca60eb18d77313bb0868513 4e286992d5ed751f6ca60eb18d77313bb0868513].

===== OpenRC now has a sane ordering of directories when configuring kernel parameters =====

Configuring kernel parameters is done by having configuration files in specific locations like <code>/etc/sysctl.conf</code> and files ending with <code>.conf</code> in certain directories like <code>/etc/sysctl.d</code>. Before 3.12.0 the ordering had no logical explanation and
surprised users that expected a hierarchy.

Starting with 3.12.0 the ordering is as follows:

# /lib/sysctl.d/*.conf
# /usr/lib/sysctl.d/*.conf
# /run/sysctl.d/*.conf
# /etc/sysctl.conf
# /etc/sysctl.d/*.conf

<code>/lib/sysctl.d</code> and <code>/usr/lib/sysctl.d</code> are to be used by the distribution and packages. Alpine Linux installs its default configuration file in <code>/lib/sysctl.d/00-alpine.conf</code>. Software installed via our package manager will install to either of those places.

<code>/run/sysctl.d</code> holds configuration that is created at run-time by daemons/services or at very early-boot. Neither the distribution nor the packaged software will install configuration to it, primarily because /run is in temporary memory. Configuration in this location that matches names the locations used by the distribution and packages will cause the latter not to be read and applied by the <code>sysctl</code> service.

<code>/etc/sysctl.d</code> holds configuration that is created and maintained by the local administrator, neither Alpine nor its packaged software will touch it, and configuration in that has the same name as in the location reserved for the distribution and packages, or the location for run-time configuration from daemons/services, will cause the latter to not be read and applied by the <code>sysctl</code> service.

<code>/etc/sysctl.conf</code> is a historical location for this kind of configuration and is kept for the same reasons.

===== OpenRC now has a sane ordering of directories when loading kernel modules =====

Loading kernel modules during boot is done with the <code>modules</code> OpenRC service, which reads configuration files in certain locations and loads kernel modules with the modprobe utility from either busybox or util-linux.

Starting with 3.12.0 a more logical ordering is adopted for which configuration files to read and ignore:

# /lib/modules-load.d/*.conf
# /usr/lib/modules-load.d/*.conf
# /run/modules-load.d/*.conf
# /etc/modules
# /etc/modules-load.d/*.conf

<code>/lib/modules-load.d</code> and <code>/usr/lib/modules-load.d</code> are to be used by the distribution and packages. Software installed via our package manager will install to either of those places.

<code>/run/modules-load.d</code> holds configuration that is created at run-time by daemons/services or at very early-boot. Neither the distribution nor the packaged software will install configuration to it, primarily because /run is in temporary memory. Configuration in this location that matches names in the locations used by the distribution and packages will cause the latter not to be read and applied by the <code>modules</code> service.

<code>/etc/modules-load.d</code> holds configuration that is created and maintained by the local administrator, neither Alpine nor its packaged software will touch it, and configuration in that has the same name as in the location reserved for the distribution and packages, or locations reserved for the run-time configuration of daemons/services, will cause the latter to not be read and applied by the <code>modules</code> service.

<code>/etc/modules</code> is a historical location for this kind of configuration and is kept for the same reasons.

===== Telegram Desktop is now available in the community repo =====

See [https://git.alpinelinux.org/aports/commit/?id=184355fdc44bc2e12976d65518fe029d8a6e459d commit] that moved the package to the community repo for explanation.

===== efitools and sbsigntool are now in main/ =====

Those packages have lived in testing/ for a long time and have been successfully used by one of our developers to implement secure-boot in his system. They have been moved to main/ and will be available for others.

===== Packages which need libsecret's DBus API now depend a provider of its API via dbus:org.freedesktop.Secret =====

Previously it was possible to install a program which required the DBus API of libsecret (e.g. Fractal), but not install a secrets provider (e.g. gnome-keyring), so logins wouldn't be saved. This has been corrected and packages which require this API depend on the provider-package dbus:org.freedesktop:Secret now. It's provided by gnome-keyring, kwallet and keepassxc (in that order of importance, i.e. if none of these is pulled in gnome-keyring will be chosen by default). Right now we manually declared the provider for dbus:org.freedesktop.Secret, but eventually we should have an automatic detection for the DBus API packages provide to make this easier for other packages.

===== Preferring enchant2 over enchant =====

All packages which support enchant2 have been moved over to it instead of using enchant(1). enchant2 now also supports nuspell, which is a faster drop-in replacement for hunspell, which utilizes hunspell's dictionaries.

===== Firefox is now in community =====

Firefox finally left testing and will be in community, supported for 6 months.

===== moonjit is now luajit =====

Our luajit package switched to the alive moonjit fork which has, among other things, s390x support and actual development.

This [https://git.alpinelinux.org/aports/commit/?id=af7f776d08cf7c12c3dd62347829fe33e66dceaa commit] switched luajit over to moonjit, the following [https://git.alpinelinux.org/aports/commit/?id=a7d057d98859940cc3347dba011957f99291b1fa commit] removes our **HUGE** 46k s390x support patch which is now handled by upstream.

===== Support for YubiKeys =====

yubikey-manager and yubikey-manager-qt have been added to the community repos for using and managing your yubikeys. Installing yubikey-manager and enabling the pcscd service should make yubikeys functional.

== abuild ==

===== Add default functions for subpackages that hold Bash, Zsh and Fish completion =====

abuild now provides default functions for $pkgname-bash-completion, $pkgname-zsh-completion and $pkgname-fish-completion subpackages.

Expected location of the completion files per shell:

* Bash -> <code>/usr/share/bash-completion/completions</code>
* Zsh -> <code>/usr/share/zsh/site-functions</code>
* Fish -> <code>/usr/share/fish/completions</code>

Files must be installed in the expected location in relation to '''$pkgdir''' in '''pacakge()'''.

Introduced in [https://gitlab.alpinelinux.org/alpine/abuild/commit/d5826968b713123a4f51d3dec1adb1225d0e194f d5826968b713123a4f51d3dec1adb1225d0e194f].

===== newapkbuild when called with CMake (-C) does out-of-source builds by default =====

When packaging with newapkbuild and using the -C switch to pre-fill the apkbuild with skeleton functions for CMake now:

* Adds <code>-B build</code> to the <code>cmake</code> call in '''build()'''.
* Adds <code>-C build</code> the <code>make</code> calls.

Doing out-of-source builds are recommended upstream to the point where warnings are printed when calling CMake on a project.

Introduced in [https://gitlab.alpinelinux.org/alpine/abuild/commit/e125a764896d884c69cc409e614b65cb336c15e8 e125a764896d884c69cc409e614b65cb336c15e8].

===== set CARGO_HOME to cache dependencies of rust packages =====

CARGO_HOME is now set to '''$SRCDEST/cargo''' and will cache all dependencies downloaded.

Introduced in [https://gitlab.alpinelinux.org/alpine/abuild/commit/af0c88e6abbb1e49224759f5c51b3068e6eab28b af0c88e6abbb1e49224759f5c51b3068e6eab28b].

===== The "plain" buildtype for Meson and "None" buildtype for CMake are used now =====

We previously used the "release" or "debugoptimized" buildmode for Meson or "Release" or "RelWithDebInfo" for CMake. This caused Meson and CMake to ignore parts of our C{,XX}FLAGS, e.g. by setting -O2 or even -O3 instead of our default of -Os. We've changed to the "plain" buildtype and the "None" buildtype for CMake. This should result in smaller binaries since -Os is respected now. See [https://lists.alpinelinux.org/~alpine/devel/%3C2896c13070c508a49cbaa72c8fb7f34ea947358b.camel%40cogitri.dev%3E the respective mailing list post]

Release Notes for Alpine 3.12.0

2020-03-29T20:24:17Z

Leo:

== aports ==

===== llvm 10.0.0 ====

llvm 10 is now the default in Alpine Linux.

[https://gitlab.alpinelinux.org/alpine/aports/commit/7a1323c27479fb967749c163f34483bc1196055d commit]

===== Initial support for DLang =====

We've added initial support for the D language with this release. We now have GDC, the D compiler frontend using GCC, available on all arches but ppc64le and LDC, a D compiler using the LLVM backend, on x86_64. Most things are built against ldc and as such only available on x86_64 right now due to GDC shipping a rather outdated version of the Phobos, the D standard library.

===== py3-setuptools now uses system python3 modules instead of vendored dependencies =====

py3-setuptools now installs py3-packaging, py3-parsing, py3-appdirs, py3-six and py3-ordered-set from the system.

The following commits are the ones responsible for this change:

* [https://git.alpinelinux.org/aports/commit/?id=efca8852f37cb4028f234f92e2d035617f524820 py3-six] (use distutils)
* [https://git.alpinelinux.org/aports/commit/?id=55e3496387ad3f2df387b2cf6bc84e85ef729833 py3-ordered-set] (new aport)
* [https://git.alpinelinux.org/aports/commit/?id=cc1636b08fba58b629501d525d658aed4bcbeab2 py3-ordered-set] (move from testing to main)
* [https://git.alpinelinux.org/aports/commit/?id=da743693eda54b9faf5086746b91506495fc689f py3-appdirs] (move from community to main)
* [https://git.alpinelinux.org/aports/commit/?id=60efe787954008af546a5bde839db09f11682102 py3-appdirs] (use distutils)
* [https://git.alpinelinux.org/aports/commit/?id=a50097b40bcf80a9aec201fef73a722206f43a0d py3-packaging] (use distutils)
* [https://git.alpinelinux.org/aports/commit/?id=52ee5092c510657e9b1e8b4ae0104d405c9eac99 py3-parsing] (install manually)
* [https://git.alpinelinux.org/aports/commit/?id=33ea734e2d28d88a3d545500c96b4c72b3e78432 py3-setuptools] (use system component)

===== ncurses fixes =====

A few fixes trickled in relating exclusively to Alpine Linux that affect ncurses:

With this [https://git.alpinelinux.org/aports/commit/?id=762b9fd601983d8a6e6a60692158f3f22b1b60fe commit] the ncurses-lib package no longer depends on the ncurses-terminfo, which was too big at 7.5 MB, instead ncurses-lib now depends solely on the ncurses-terminfo-base package which weights at around 120 kB.

With this [https://git.alpinelinux.org/aports/commit/?id=56aa7795fecc48561deb095995abd335e16ba515 commit] the ncurses-terminfo-base now includes the most common terminfo databases like tmux, screen, xterm-256color and also databases for packaged terminals like gnome-terminal, vte, konsole, alacritty, kitty, putty. All other terminfo databases are now in ncurses-terminfo.

With this [https://git.alpinelinux.org/aports/commit/?id=1470a6c8e76491a8d059ebd4b7521c4bf20b837c commit] all terminals that have their terminfo databases provided by the ncurses-terminfo-base now depend on it.

===== python3 no longer provides pip3, use py3-pip from community =====

Python3 is now built with --without-ensurepip which removes pip3 and its libraries from it. Instead use the py3-pip pacakge which uses system components.

===== BPF JIT support =====

> TODO: Small preamble about BPF

So it (BPF JIT) has been enabled by default in [https://git.alpinelinux.org/aports/commit/?id=3bf2313adc57fe6b36bf459ddca6d65a392609db 3bf2313adc57fe6b36bf459ddca6d65a392609db], and unprivileged BPF JIT has been disabled in [https://git.alpinelinux.org/aports/commit/?id=4e286992d5ed751f6ca60eb18d77313bb0868513 4e286992d5ed751f6ca60eb18d77313bb0868513].

===== OpenRC now has a sane ordering of directories when configuring kernel parameters =====

Configuring kernel parameters is done by having configuration files in specific locations like <code>/etc/sysctl.conf</code> and files ending with <code>.conf</code> in certain directories like <code>/etc/sysctl.d</code>. Before 3.12.0 the ordering had no logical explanation and
surprised users that expected a hierarchy.

Starting with 3.12.0 the ordering is as follows:

# /lib/sysctl.d/*.conf
# /usr/lib/sysctl.d/*.conf
# /run/sysctl.d/*.conf
# /etc/sysctl.conf
# /etc/sysctl.d/*.conf

<code>/lib/sysctl.d</code> and <code>/usr/lib/sysctl.d</code> are to be used by the distribution and packages. Alpine Linux installs its default configuration file in <code>/lib/sysctl.d/00-alpine.conf</code>. Software installed via our package manager will install to either of those places.

<code>/run/sysctl.d</code> holds configuration that is created at run-time by daemons/services or at very early-boot. Neither the distribution nor the packaged software will install configuration to it, primarily because /run is in temporary memory. Configuration in this location that matches names the locations used by the distribution and packages will cause the latter not to be read and applied by the <code>sysctl</code> service.

<code>/etc/sysctl.d</code> holds configuration that is created and maintained by the local administrator, neither Alpine nor its packaged software will touch it, and configuration in that has the same name as in the location reserved for the distribution and packages, or the location for run-time configuration from daemons/services, will cause the latter to not be read and applied by the <code>sysctl</code> service.

<code>/etc/sysctl.conf</code> is a historical location for this kind of configuration and is kept for the same reasons.

===== OpenRC now has a sane ordering of directories when loading kernel modules =====

Loading kernel modules during boot is done with the <code>modules</code> OpenRC service, which reads configuration files in certain locations and loads kernel modules with the modprobe utility from either busybox or util-linux.

Starting with 3.12.0 a more logical ordering is adopted for which configuration files to read and ignore:

# /lib/modules-load.d/*.conf
# /usr/lib/modules-load.d/*.conf
# /run/modules-load.d/*.conf
# /etc/modules
# /etc/modules-load.d/*.conf

<code>/lib/modules-load.d</code> and <code>/usr/lib/modules-load.d</code> are to be used by the distribution and packages. Software installed via our package manager will install to either of those places.

<code>/run/modules-load.d</code> holds configuration that is created at run-time by daemons/services or at very early-boot. Neither the distribution nor the packaged software will install configuration to it, primarily because /run is in temporary memory. Configuration in this location that matches names in the locations used by the distribution and packages will cause the latter not to be read and applied by the <code>modules</code> service.

<code>/etc/modules-load.d</code> holds configuration that is created and maintained by the local administrator, neither Alpine nor its packaged software will touch it, and configuration in that has the same name as in the location reserved for the distribution and packages, or locations reserved for the run-time configuration of daemons/services, will cause the latter to not be read and applied by the <code>modules</code> service.

<code>/etc/modules</code> is a historical location for this kind of configuration and is kept for the same reasons.

===== Telegram Desktop is now available in the community repo =====

See [https://git.alpinelinux.org/aports/commit/?id=184355fdc44bc2e12976d65518fe029d8a6e459d commit] that moved the package to the community repo for explanation.

===== efitools and sbsigntool are now in main/ =====

Those packages have lived in testing/ for a long time and have been successfully used by one of our developers to implement secure-boot in his system. They have been moved to main/ and will be available for others.

===== Packages which need libsecret's DBus API now depend a provider of its API via dbus:org.freedesktop.Secret =====

Previously it was possible to install a program which required the DBus API of libsecret (e.g. Fractal), but not install a secrets provider (e.g. gnome-keyring), so logins wouldn't be saved. This has been corrected and packages which require this API depend on the provider-package dbus:org.freedesktop:Secret now. It's provided by gnome-keyring, kwallet and keepassxc (in that order of importance, i.e. if none of these is pulled in gnome-keyring will be chosen by default). Right now we manually declared the provider for dbus:org.freedesktop.Secret, but eventually we should have an automatic detection for the DBus API packages provide to make this easier for other packages.

===== Preferring enchant2 over enchant =====

All packages which support enchant2 have been moved over to it instead of using enchant(1). enchant2 now also supports nuspell, which is a faster drop-in replacement for hunspell, which utilizes hunspell's dictionaries.

===== Firefox is now in community =====

Firefox finally left testing and will be in community, supported for 6 months.

===== moonjit is now luajit =====

Our luajit package switched to the alive moonjit fork which has, among other things, s390x support and actual development.

This [https://git.alpinelinux.org/aports/commit/?id=af7f776d08cf7c12c3dd62347829fe33e66dceaa commit] switched luajit over to moonjit, the following [https://git.alpinelinux.org/aports/commit/?id=a7d057d98859940cc3347dba011957f99291b1fa commit] removes our **HUGE** 46k s390x support patch which is now handled by upstream.

===== Support for YubiKeys =====

yubikey-manager and yubikey-manager-qt have been added to the community repos for using and managing your yubikeys. Installing yubikey-manager and enabling the pcscd service should make yubikeys functional.

== abuild ==

===== Add default functions for subpackages that hold Bash, Zsh and Fish completion =====

abuild now provides default functions for $pkgname-bash-completion, $pkgname-zsh-completion and $pkgname-fish-completion subpackages.

Expected location of the completion files per shell:

* Bash -> <code>/usr/share/bash-completion/completions</code>
* Zsh -> <code>/usr/share/zsh/site-functions</code>
* Fish -> <code>/usr/share/fish/completions</code>

Files must be installed in the expected location in relation to '''$pkgdir''' in '''pacakge()'''.

Introduced in [https://gitlab.alpinelinux.org/alpine/abuild/commit/d5826968b713123a4f51d3dec1adb1225d0e194f d5826968b713123a4f51d3dec1adb1225d0e194f].

===== newapkbuild when called with CMake (-C) does out-of-source builds by default =====

When packaging with newapkbuild and using the -C switch to pre-fill the apkbuild with skeleton functions for CMake now:

* Adds <code>-B build</code> to the <code>cmake</code> call in '''build()'''.
* Adds <code>-C build</code> the <code>make</code> calls.

Doing out-of-source builds are recommended upstream to the point where warnings are printed when calling CMake on a project.

Introduced in [https://gitlab.alpinelinux.org/alpine/abuild/commit/e125a764896d884c69cc409e614b65cb336c15e8 e125a764896d884c69cc409e614b65cb336c15e8].

===== set CARGO_HOME to cache dependencies of rust packages =====

CARGO_HOME is now set to '''$SRCDEST/cargo''' and will cache all dependencies downloaded.

Introduced in [https://gitlab.alpinelinux.org/alpine/abuild/commit/af0c88e6abbb1e49224759f5c51b3068e6eab28b af0c88e6abbb1e49224759f5c51b3068e6eab28b].

===== The "plain" buildtype for Meson and "None" buildtype for CMake are used now =====

We previously used the "release" or "debugoptimized" buildmode for Meson or "Release" or "RelWithDebInfo" for CMake. This caused Meson and CMake to ignore parts of our C{,XX}FLAGS, e.g. by setting -O2 or even -O3 instead of our default of -Os. We've changed to the "plain" buildtype and the "None" buildtype for CMake. This should result in smaller binaries since -Os is respected now. See [https://lists.alpinelinux.org/~alpine/devel/%3C2896c13070c508a49cbaa72c8fb7f34ea947358b.camel%40cogitri.dev%3E the respective mailing list post]

APKBUILD Reference

2020-03-14T18:20:15Z

Leo: /* options */

APKBUILDs are the scripts that are created in order to build Alpine packages using the [[abuild]] tool.

See [[aports]] for details on Alpine's official ports repository.

This page is intended to serve as a reference for creating APKBUILDs; if this is your first time creating a package for Alpine Linux, please see [[Creating an Alpine package]].

= Legend =
The following notes will assist you in understanding this document.

In description text:
* If a variable is not prefixed with a ''$'', it will be represented by italics (i.e., ''srcdir'' ).
* Functions will also be represented by italics, but will also end with a pair of parentheses (i.e., ''build()'' ).
* Shell commands will be represented <code>like this</code>.

= Variables =
{{Note|Variables that contain a path (e.g. ''$srcdir'' and ''$pkgdir'') should always be quoted using double quotes (i.e., ''"$srcdir"''). This is done to prevent things from breaking, should the user have the APKBUILD in a directory path that contains spaces.}}
{{Note|All arbitrary variable and function names should be prefixed with an underscore character ( _ ) to avoid name clashes with the internals of abuild (for example, ''_luaversions'').}}

== abuild-defined variables ==
The following variables are defined by abuild:

==== startdir ====
: The directory where the APKBUILD script is.
==== srcdir ====
: The directory where sources, from the ''source'' variable, are downloaded to and unpacked to.
==== pkgdir ====
: This directory should receive the files for the main package. For example, a normal [http://en.wikipedia.org/wiki/GNU_build_system autotools] package would have <code>make DESTDIR="$pkgdir" install</code> in the ''package()'' function.
==== subpkgdir ====
: This directory should receive the files for a subpackage. This variable should only be used from subpackage functions.
==== builddir ====
: This variable should point to the directory inside the ''srcdir'' where the main package source is unpacked. This is typically ''$srcdir/$pkgname-$pkgver''. It’s used by the default ''prepare()'' function as a working directory when applying patches.

== User-defined variables ==
The following variables should be defined by the user:
==== arch ====
: Package architecture(s) to build for. Can be one of: '''[[x86]], [[x86_64]], [[armhf]], [[aarch64]], [[ppc64le]], [[s390x]], all''', or '''noarch''', where '''all''' means all architectures, and '''noarch''' means it's architecture-independent (e.g., a pure-python package).
: {{Tip|To determine if your APKBUILD can use '''noarch''': First specify '''all''' and then build the package by executing <code>abuild -r</code>. Watch the output towards the end for warnings saying that '''noarch''' can be used. If the main package and all subpackages, if you have any subpackages, give a warning saying that '''noarch''' can be used, then you can use '''noarch'''.}}

==== depends ====
: Run-time dependency package(s) that are not shared-object dependencies. Shared objects dependencies are auto-detected and should not be specified here.
==== depends_dev ====
: Run-time dependency package(s) for the '''$pkgname-dev''' subpackage.

: {{Note|From ncopa on IRC: To find out if you need to add a package to depends_dev have a look at *requires* in usr/lib/pkgconfig/*.pc. With libtool it gets more complicated, but we should delete the .la files. Also check if there are any /usr/bin/*-configure #!/bin/bash #!/usr/bin/perl or Python. Sometimes scripts or similar are generated at build time (i.e autoconf automake) then you normally don't need add those to depends_dev. You can also just add all -dev makedepends to depends_dev but it will slow the build process a little bit (more build dependencies).}}

==== depends_doc ====
: Run-time dependency package(s) for the '''$pkgname-doc''' subpackage.

==== depends_openrc ====
: Run-time dependency package(s) for the '''$pkgname-openrc''' subpackage.

==== depends_libs ====
: Run-time dependency package(s) for the '''$pkgname-libs''' subpackage.

==== depends_static ====
: Run-time dependency package(s) for the '''$pkgname-static''' subpackage.

==== checkdepends ====
: Dependencies that are only required during the check phase, they are only installed if the check option is enabled

==== giturl ====
:Git repository from which <code>abuild checkout</code> checks out. You can checkout a specific branch in git by adding <code>-b $branch</code>.
==== install ====
: There are 6 different types of install scripts. Install scripts are named '''$pkgname.action''', where '''action''' can be: '''pre-install, post-install, pre-upgrade, post-upgrade, pre-deinstall''', or '''post-deinstall'''. For example, if ''pkgname'' is set to '''mypackage''' and ''install'' is set to '''$pkgname.post-install''', then a script named '''mypackage.post-install''' must exist along-side the APKBUILD.
<blockquote>{{Note|Always use <code>/bin/sh</code> for the command-line interpreter on the [http://en.wikipedia.org/wiki/Shebang_%28Unix%29 shebang line] of your install scripts.}}</blockquote>

The following are the different types of install scripts in detail:

===== $pkgname.pre-install =====
: This script is executed ''before installing'' the package. Typical use is when the package needs a group and a user to be created. For example:
<blockquote><pre>
#!/bin/sh

addgroup -S clamav 2>/dev/null
adduser -S -D -H -s /bin/false -G clamav -g clamav clamav 2>/dev/null

exit 0
</pre>
{{Note|If the script exits with a failure (e.g., if the user already exists), the package will not be installed and <code>apk</code> will exit with failure, hence the <code>exit 0</code> at the end.}}</blockquote>

===== $pkgname.post-install =====
: This script is executed ''after installing'' the package.

===== $pkgname.pre-upgrade =====
: This script is executed ''before upgrading/downgrading/reinstalling'' the package. Note that exiting with failure will not cause apk to exit with failure, but will mark the package as broken.

===== $pkgname.post-upgrade =====
: This script is executed ''after upgrading/downgrading/reinstalling'' the package.

===== $pkgname.pre-deinstall =====
: This script is executed ''before uninstalling'' the package.
: {{Note|If the script exits with failure, <code>apk</code> will not uninstall the package.}}

===== $pkgname.post-deinstall =====
: This script is executed ''after uninstalling'' the package.

==== install_if ====
:install_if can be used when a package needs to be installed when some packages are already installed or are in the dependency tree. It works in reverse to the ''recommends'' feature, that other package managers provide.

: '''Example:''' When package <code>A</code> has <code>install_if="B C"</code>, and the user runs <code>apk add B C</code>, then package <code>A</code> will get automatically installed.

: '''Example 2:''' A real use-case in Alpine is open-vm-tools. Currently it contains the userspace tools and separate packages for the kernel modules (grsec and vserver). When we install the userspace tools, apk should automatically install the correct kernel modules and will need to figure out for which kernel. This is where install_if jumps in. For any of the kernel modules package we would use:

:<pre>install_if="linux-${_flavor}=${_kernelver} open-vm-tools"</pre>

:This will automatically install the package when the specified packages are installed or are in dependency tree.

==== license ====
: License(s) for the package, for example <code>GPL-3.0-or-later</code>, <code>BSD-2-Clause</code> or <code>MIT</code> [[Creating_an_Alpine_package#license|(details)]].

==== makedepends ====
: Build-time dependency package(s).
==== md5sums/sha256sums/sha512sums ====
: Checksums for the files/URLs listed in ''source''. The checksums are normally generated and updated by executing <code>abuild checksum</code> and should be the last item in the APKBUILD.

New packages should use only sha512sums.

==== options ====
: Build-time options for the package.

: {| class="wikitable"
! Option
! Description
|-
| <code>!archcheck</code>
| Do not try to verify that the architecture of the binary files is the same architecture as abuild should build for. One example where it makes sense to set this are packages with firmware files, that get executed on another CPU (such as WiFi firmware).
|-
| <code>!check</code>
| Do not try to run the <code>check()</code> function. Please always add a short comment after the <code>!check</code> about why it's disabled. [https://github.com/alpinelinux/aports/pull/2322#discussion_r142545300] Creating a very simple check function, that calls <code>program --version</code> is worse than disabling tests completely because it gives the false impression that the package is thoroughly tested with the testsuite from upstream. [https://github.com/alpinelinux/aports/pull/7326#discussion_r278797457]
|-
| <code>checkroot</code>
| Specifies that the package's test suite will be run in ''fakeroot''. This is necessary for some test suites which fail when run as non-root.
|-
| <code>net</code>
| Allows network access when run in ''fakeroot''.
|-
| <code>!strip</code>
| Avoid stripping symbols from binaries.
|-
| <code>suid</code>
| Allow [https://en.wikipedia.org/wiki/Setuid setuid] binaries.
|-
| <code>!tracedeps</code>
| Do not automatically find dependencies (e.g. by using <code>ldd</code> to find dynamic libraries, which the resulting binary links against).
|-
| <code>chmod-clean</code>
| Make all files writable in the src/ directory. Useful for packages that make files read-only in the process of building packages (go modules).
|-
| <code>toolchain</code>
| Don't warn when g++ is in makedepends
|-
| <code>!dbg</code>
| Don't create debugging subpackage
|-
| <code>ldpath-recursive</code>
| Scan directories recursively when creating .so providers
|-
| <code>!spdx</code>
| Do not check if the license= field has a SPDX compliant license
|-
| <code>textrels</code>
| Don't error out when text relocations are found
|-
| <code>charset.alias</code>
| Don't error out if /usr/lib/charset.alias is found
|-
| <code>libtool</code>
| Don't delete libtool .la files
|-
| <code>!fhs</code>
| Don't enforce checks on path that follow the FHS
|}

==== pkgdesc ====
: A brief, one-line description of what the package does.

: Here's an example from the OpenSSH client package:
: <pre>pkgdesc="Port of OpenBSD's free SSH release - client"</pre>
==== pkggroups ====
: System group(s) to be created during build-time. System group(s) should also be created in the '''[[APKBUILD Reference#.24pkgname.pre-install|$pkgname.pre-install]]''' script, so that the system group(s) are also created prior to package installation for run-time use.
==== pkgname ====
: The name of the package. All letters should be lowercase.
: {{Note|When creating an APKBUILD of a module or library for another package, we use some common package prefixes, such as: ''lua-'', ''perl-'', ''php-'', and ''py-''. Search aports for other common prefixes.}}

==== pkgrel ====
: Alpine package release number. Starts at 0 (zero). Always increment ''pkgrel'' when making updates to an aport; reset ''pkgrel'' to 0 (zero) when incrementing ''pkgver''.
==== pkgusers ====
: System user(s) to be created during build-time. System user(s) should also be created in the '''[[APKBUILD Reference#.24pkgname.pre-install|$pkgname.pre-install]]''' script, so that the system user(s) are also created prior to package installation for run-time use.
==== pkgver ====
: The version of the software being packaged. Format for valid versions: <code>{digit}{.digit}...{letter}{_suf{#}}...{-r#}</code> [https://git.alpinelinux.org/cgit/apk-tools/tree/src/version.c#n17]
: A Suffix <code>suf</code> in the above format can be one of the following to indicate that the release is ''less recent'' than the version without the suffix: <code>alpha</code>, <code>beta</code>, <code>pre</code>, <code>rc</code> [https://git.alpinelinux.org/cgit/apk-tools/tree/src/version.c#n75]
: These are for indicating ''more recent'' releases: <code>cvs</code>, <code>svn</code>, <code>git</code>, <code>hg</code>, <code>p</code> [https://git.alpinelinux.org/cgit/apk-tools/tree/src/version.c#n76]
: All other suffices are invalid. To package a specific git commit, the date of the commit gets appended to the latest release, e.g. <code>1.0.0_git20180204</code>.

==== provides ====
: List of package names (and optionally version info) this package provides.

: If package with a version is provided (provides='foo=1.2') apk will consider it as an alternate name and it will automatically consider the package for installation by the alternate name, and conflict with other packages having the same name, or provides.

: If version is not provided (provides='foo'), apk will consider it as virtual package name. Several package with same non-versioned provides can be installed simultaneously. However, none of them will be installed by default when requested by the virtual name - instead, error message is given and user is asked to choose which package providing the virtual name should be installed.
==== provider_priority ====
: A numeric value which is used by apk-tools to break ties when choosing a virtual package to satisfy a dependency. Higher values have higher priority. The primary use case is to specify the primary package that satisfies a virtual (provider).
==== replaces ====
: Package(s) that this package replaces. This package will "take over" files owned by packages listed in the ''replaces'' variable. This is useful when files move from one package to another, or when a package gets renamed.
==== replaces_priority ====
: The priority of the replaces. If multiple packages replace each other, then will the package with highest ''replaces_priority'' win.
==== source ====
: The source variable is not only used to list the remote source files to fetch, it is also used to list the local files that abuild will need in order to build the apk. Examples of such local files include: init.d files, conf.d files, install files (see [[APKBUILD Reference#install|install variable]]), patches, and all other necessary files.

: Here are few things to note:

:* When you are finished adding local and/or remote files to ''source'', you can execute the following command to add their checksums to the APKBUILD file:
:: {{Cmd|abuild checksum}}
:: {{Note|When later updating the content of ''source'', or updating a file that is listed in ''source'', you must also update their checksums again with the same command.}}

:* When the remote file is hosted at SourceForge, it's best to specify the special mirrors link used by SourceForge:
:: <pre>http://downloads.sourceforge.net/$pkgname/$pkgname-$pkgver.tar.gz</pre>
:: (or similar depending on the package).

:* You can set target filename (eg 'save as...') by prefixing the URI with ''filename::''. This is useful when the remote filename is not specified in the URI (ie, does not end in '/software-1.0.tar.gz'), such as:
:: <pre>http://oss.example.org/?get=software&ver=1.0</pre>
:: or when the filename is braindead, like githubs' download tags:
:: <pre>https://github.com/software/software/archive/v$pkgver.tar.gz</pre>
:: The above two examples needs a target filename prefix:
:: <pre>$pkgname-$pkgver.tar.gz::http://oss.example.org/?get=software&ver=$pkgver</pre>
:: and:
:: <pre>$pkgname-$pkgver.tar.gz::https://github.com/software/software/archive/v$pkgver.tar.gz</pre>

:* abuild currently supports the following protocols for remote file retrieval:
:** http
:** https
:** ftp

:* abuild currently supports the following archive types/archive file extensions:
:** .tar (only in Alpine >= 2.5)
:** .tar.gz / .tgz
:** .tar.bz2
:** .tar.lz (only in Alpine >=3.7)
:** .tar.lzma
:** .tar.xz
:** .zip

==== subpackages ====
: Subpackages built from this APKBUILD. abuild will parse this variable and try to find a subpackage split function. The split function must ''move'' files that do not belong in the main package, from ''$pkgdir'' to ''$subpkgdir''. Files and directories can also be ''copied'' from ''$startdir'' and ''$srcdir'' to ''$subpkgdir''.

: The split function can be specified in 1 of 3 different methods:
:# subpkgname:'''splitfunc'''
:# $pkgname-'''splitfunc'''
:# '''splitfunc'''

: {{Note|Split function names '''cannot''' use hyphens; use the first method above if the subpackage name contains a hyphen (-) character, like this: ''subpkg-name:subpkg_name'', where <code>subpkg-name</code> is the name of the '''subpackage''' and <code>subpkg_name</code> is the name of the '''subpackage's split function'''.}}

: {{Tip|For more information, see the [[APKBUILD_examples:Subpackages|Subpackages example]].}}

==== triggers ====
: Apk-tools can "monitor" directories and execute a trigger if any package installed/uninstalled any file in the monitored dir. The triggers are always executed after the apk action (install, uninstall, upgrade).

: The triggers are specified in the format: ''scriptname''=''pathlist'' where ''scriptname'' is the (sub)package name + .trigger suffix and pathlist is : separated list of the dirs to monitor.

: The '''triggers''' variable must include the triggers for subpackages too if they have any.

: It is possible to use wildcards (*) in the dir list.

==== url ====
: The homepage for the package. This is to help users find upstream documentation and other information regarding the package.

==== langdir ====
: Path to where the language files are located for the '''-lang''' subpackage, defaults to '''/usr/share/locale'''

= Functions =
{{Note|All functions that are not ''prepare()'', ''build()'', ''check()'' and ''package()'' should consider the current working directory as undefined, and should therefore use the [[APKBUILD Reference#abuild-defined_variables|abuild-defined directory variables]] to their advantage.}}

sanitycheck() -> clean()-> fetch() -> verify() -> unpack() -> prepare() -> mkusers() -> build() -> check() -> package() -> subpackages() -> language packs -> apk -> cleanup()

== abuild-defined functions ==
The following functions are provided by abuild and can be overridden, but it is strongly discouraged on code review for some functions:

==== fetch() ====
: Downloads remote sources listed in ''source'' to ''SRCDEST'' (''SRCDEST'' is configured in ''/etc/abuild.conf'') and creates symlinks in ''$srcdir''.
==== unpack() ====
: unpack() will call default_unpack().

: [https://github.com/alpinelinux/abuild/blob/v3.1.0/abuild.in#L403 default_unpack()] unpacks .tar, .tgz, .tar.gz, .tar.lz (only available in Alpine >=3.7), .tar.bz2, .tar.lzma, .tar.xz, and .zip archives from a symlink in ''$srcdir'' associated with ''$SRCDEST'' (or distfiles folder) resulting in an unpacked folder in ''$srcdir''.

==== dev() ====
: Subpackage function for the '''$pkgname-dev''' package is used to collect developer files and folders for use in other packages in the compilation process nothing more. Without specifying a custom ''dev()'' function, abuild will call its internal ''dev()'' function, which in turn calls default_dev().

: ''[https://github.com/alpinelinux/abuild/blob/v3.1.0/abuild.in#L1605 default_dev()]'' will move any ''include'' folder and folders containing ''*.[acho]'' (static archive, c source, c header file, object file), ''*.prl'' file extension patterns in ''"$pkgdir"/{lib,usr}'' to ''"$subpkgdir"/{lib,usr}'' recursively; and ''*.so'' files from ''"$pkgdir"/{lib,usr/lib}'' to ''"$subpkgdir"/{lib,usr/lib}''. It will also scan and move ''usr/{include,lib/{pkgconfig,cmake,qt*/mkspecs},share/{aclocal,gettext,vala/vapi,gir-[0-9]*,qt*/mkspecs},bin/*-config}}'' developer only folders in ''$pkgdir'' and transfer them to ''$subpkgdir''.

: In general, default_dev() will support packages that share pkg-config, C programming language API, shared and static libraries, Autotools, gettext, Vala programming language bindings, Python GObject introspection, a provided custom pkg-config like command (*-config), Qt, and CMake. If you have packages that have C++, other languages, other build system, etc; you need to manually move those developer files only if they are to be used in other packages.

: '''Important''': For default_dev() to be called as in no dev(), you need to explicitly add subpackages="$pkgname-dev".

==== doc() ====
: Subpackage function for the '''$pkgname-doc''' package whose job is only to collect documentation folders from $pkgdir nothing more. Without specifying a custom ''doc()'' function, abuild will call its internal ''doc()'' function, which in turn calls default_doc().

: ''[https://github.com/alpinelinux/abuild/blob/v3.1.0/abuild.in#L1519 default_doc()]'' will move ''"$pkgdir"/usr/share/{doc,man,info,html,sgml,licenses,gtk-doc,ri,help}'' to ''$subpkgdir''.

: Overriding this function is strongly discouraged. Packaging docs should be done in the package() function while letting abuild automatically collect the doc folders.

: '''Important''': For default_doc() to be called as in no doc(), you need to explicitly add subpackages="$pkgname-doc".

==== openrc() ====
: Subpackage function for the '''$pkgname-opernc''' package whose job is to collect OpenRC service files that are in /etc/init.d and /etc/conf.d.

: ''[https://github.com/alpinelinux/abuild/blob/v3.1.0/abuild.in#L1661 default_openrc()]'' will move ''"$pkgdir"/etc/{conf,init}.d'' to ''$subpkgdir''.

: Overriding this function is strongly discouraged. Packaging OpenRC service definitions should be in the package() function while letting abuild automatically collect the openrc folders.

: '''Important''': for default_openrc() to be called as in no openrc(), you need to explicitly add subpackages="$pkgname-openrc".

==== static() ====
: Subpackage function for the '''$pkgname-static''' package whose job is to collect static libraries that are stored in /lib and /usr/lib.

: ''[https://github.com/alpinelinux/abuild/blob/v3.4.0_rc4/abuild.in#L1748 default_static()]'' will move all static libraries (files ending with .a) from ''"$pkgdir"/lib'' and ''"$pkgdir"/usr/lib'' to their equivalents in ''$subpkgdir''.

: Overriding this function is strongly discouraged. Packaging static libraries should be done in the package() function while letting abuild automatically collect the static libraries.

: '''Important''': for default_static() to be called as in no static(), you need to explicitly add subpackages="$pkgname-static".

==== snapshot() ====
: '''Optional'''. For live APKBUILDs or those with a _cvs, _svn, _git, _hg in their version number, you should create a snapshot function only if there is no download link to an archive file (.zip, .tar.gz, ...) to the commit/hash/tag. The purpose of the snapshot function is to create an archive of the source code so that the package source code is deterministic, and it doesn't waste time to fetch the source code but bypasses the download step after snapshotting. Those that download the source code from a git repository will follow head or the latest change to the source code. It is better to archive the source code as a zip / tar.gz / tar.bz2 up to the commit or the tag which you are trying to build a package. If it is not deterministic or not every part of the code frozen in time for every dependency and the main project, then the patches will fail or the package may fail to compile when you revisit the package months or years to backport a patch.

: The default [https://github.com/alpinelinux/abuild/blob/v3.1.0/abuild.in#L2310 snapshot()] function has variables associated with it:
:* $disturl - the base-url of the place to autoupload the snapshot
:* $svnurl - Subversion repository
:* $giturl - Git repository

: The default snapshot() can only support one repository. It is better to override it if there are multiple repositories involved in your package. CVS, Mercurial (hg), and alternative version control systems must override the default snapshot().

: See [[APKBUILD_examples:Git_checkout]] to how to use it with git. It takes 2-3 general steps. Clone the repository; check it out at a specific revision/commit or tag; then you use an archiver to dump it in the ''$SRCDEST'' variable which points to the distfiles folder and the base path to the full path to the archive that you want to create. You do this for every internal dependency that the package pulls.

: After you have created your snapshot function, you use <code>abuild snapshot</code> to run it.

: The archives produced by the snapshot will be saved in ''/var/cache/distfiles'' or whatever you set for ''$SRCDEST''. You may need to create symlinks to the archive if the archive is not saved to the Alpine server.

: After you snapshot it, you need to produce the checksums with <code>abuild checksum</code> to use it in the APKBUILD creation process.

: This feature is available since Alpine >=2.6.

== User-defined functions ==
The following functions should be defined by the user:

==== prepare() ====
: {{note|Please adjust old APKBUILDs, which still have a ''prepare()'' function that does the same as the ''default_prepare()'' when you edit them anyway.}}
: '''''Optional''.''' Used for build preparation: patches, etc, should be applied here. When you don't specify a custom ''prepare()'', the built-in ''default_prepare()'' from abuild will be used. It applies patches already (always prepare them in the <code>-p1</code> format), so '''usually it makes sense to not create a custom ''prepare()'' function at all!''' If you do create one, call ''default_prepare()'' inside it:

: Before default_prepare gets called, you can define ''patch_args'' to supply the argument to the patch command in global scope then throw away prepare() so it is unnecessary to use the old template code floating around to patch. patch_args and autopatching is only available in Alpine >=3.4. See [[Creating_an_Alpine_package#Patches]] to fix the patch that uses a different patch level (-pX).

<pre>
prepare() {
default_prepare
# your custom code here
}
</pre>

==== build() ====
: '''Required.''' This is the compilation stage. This function will be called as the current user (unless the ''package()'' function is missing - for compatibility reasons). If no compilation is needed, this function can contain a single line: <code>return 0</code>

: To enable or disable CFLAGS, CXXFLAGS, CMake with option, or configure option per arch, use the CARCH variable:
<pre>
local cmakeoptions=
case "$CARCH" in
aarch64*|arm*|ppc64le|x86|s390x) cmakeoptions="$cmakeoptions -DWITH_OPENMP=OFF" ;;
x86_64) cmakeoptions="$cmakeoptions -DWITH_OPENMP=ON" ;;
*) msg "Unable to determine architecture from (CARCH=$CARCH)" ; return 1 ;;
esac
</pre>
: The block can be used in other parts of the APKBUILD even in global.

==== check() ====
: '''Required if functionality exists.''' This function is called right after the build stage. It should check that the packaged thing is actually working, typically by running (integration) tests, if provided by upstream. If there’s no (easy) way how to test the package, you can declare that it does not want to use ''check()'' by adding "!check" into the ''options'' variable (<code>options="!check"</code>).

: default_check() does nothing. You need to manually explicitly call the unit tests or test suite yourself. When you run the test, the program should return with an exit code of 0, indicating the tests were a success. Unit tests or test suites will do feature tests, per function correctness check, fuzz testing, benchmarks.

: A package may also require additional testing frameworks packages that are external dependencies. You should add those to the ''checkdepends='' in Alpine >=3.6 or ''makedepends='' for older for backporters. If the testing framework is not available, you need to create a package for it. If it requires a specific version of a testing framework, consider making it an internal dependency or a new package with a package name containing the major and minor version number like the python packages.

: Generally speaking, you should define the check functions for libraries, large programs like web browsers, or compilers and interpreters, cryptographic/security/anonymity stuff, mission critical stuff, PCI compliance/money/accounting software, server software with a lot of stakeholders or consumers. Soon for the new policy change will have virtually '''all packages with testing capabilities be required to have a working and defined check() function'''.

: There are times when the unit tests do not work, just because the test itself is broken, new unimplemented feature, external factors not taken into consideration, unbundling path differences, breakage caused by ccache, missing test dependency or version mismatch dependency as in python2 vs python3, test scripts only work for particular language implementation like only supporting python2 but not python3 having used the 2to3 conversion script. If a unit test is known not to work, you may need to patch it to omit that test or fix it; but, certain tests should not be disabled if it is important. You may need to alter the references to uncompiled internal dependencies to work with the external dependencies instead. For ccache, you can either disable it or remove it from the PATH environmental variable before running tests.

{{Note|Tests for graphical applications and toolkits might work on a X11 user setup but will fail on the server unless run with xvfb-run.}}

: If you don't add the ''check()'' and the ''options='', this is what you will see:

>>> WARNING: py-webtest*: APKBUILD does not run any tests!
Alpine policy will soon require that packages have any relevant testsuites run during the build process.
To fix, either define a check() function, or declare !check in $options to indicate the package does not have a testsuite.

: If you do not do a check or disable it, you must state there is no testsuite in comment form (#) next to options="!check" for the code reviewers.

: To run test suite with autotools do:

make check

: To run the test suite with python setuptools:

python2 setup.py test
python3 setup.py test

: For python it should be '''test''' not check. Check for python setuptools will check the packaging metadata fields[https://docs.python.org/3/distutils/examples.html#checking-a-package] only but not run the unit tests. There should be verbose output also. The dependencies for the tests are found in test_require in the setup.py.

: If it says <code>Ran 0 tests in 0.000s</code> that is not acceptable. check() will say it was good but it is not actually correct. It needs to run the test suite with an alternative method like <code>tox -e py27,py36</code> if you see a tox.ini file.

: You want to do it for each implementation to ensure that the API calls are correct per implementation but ncopa said it was just fine with python3.

: If there is a circular dependency for the checkdepends=, you need to disable the check and put the reason next to <code>options="!check"</code> that there is a circular dependency. You should disable it for the package that package that is least important or least security risk. The other solution is to make the conflicting dependency an internal dependency but making sure that it doesn't pull it at check time. This way they can both preform tests properly.

==== package() ====
: '''Required.''' This is the packaging stage. Here, the built application and support files should be installed into '''$pkgdir'''. If this is a metapackage, this function can contain a single line: <code>mkdir -p "$pkgdir"</code>

{{Note|Building in fakeroot will reduce performance for parallel builds dramatically. It is for this reason that we split the build and package process into two separate functions.}}

= Examples =
The [[APKBUILD examples]] page will assist you in understanding how to create an APKBUILD.

= Version =

This document assumes abuild for Alpine Edge. For older releases of abuild, some of these features may not be available if you are using an older release. A link to the implementation is linked for researchers and backporters.

For more information see [[APKBUILD_versions]].

[[Category:Development]]

Release Notes for Alpine 3.12.0

2020-03-02T06:30:10Z

Leo: /* aports */

== aports ==

===== Initial support for DLang =====

We've added initial support for the D language with this release. We now have GDC, the D compiler frontend using GCC, available on all arches but ppc64le and LDC, a D compiler using the LLVM backend, on x86_64. Most things are built against ldc and as such only available on x86_64 right now due to GDC shipping a rather outdated version of the Phobos, the D standard library.

===== py3-setuptools now uses system python3 modules instead of vendored dependencies =====

py3-setuptools now installs py3-packaging, py3-parsing, py3-appdirs, py3-six and py3-ordered-set from the system.

The following commits are the ones responsible for this change:

* [https://git.alpinelinux.org/aports/commit/?id=efca8852f37cb4028f234f92e2d035617f524820 py3-six] (use distutils)
* [https://git.alpinelinux.org/aports/commit/?id=55e3496387ad3f2df387b2cf6bc84e85ef729833 py3-ordered-set] (new aport)
* [https://git.alpinelinux.org/aports/commit/?id=cc1636b08fba58b629501d525d658aed4bcbeab2 py3-ordered-set] (move from testing to main)
* [https://git.alpinelinux.org/aports/commit/?id=da743693eda54b9faf5086746b91506495fc689f py3-appdirs] (move from community to main)
* [https://git.alpinelinux.org/aports/commit/?id=60efe787954008af546a5bde839db09f11682102 py3-appdirs] (use distutils)
* [https://git.alpinelinux.org/aports/commit/?id=a50097b40bcf80a9aec201fef73a722206f43a0d py3-packaging] (use distutils)
* [https://git.alpinelinux.org/aports/commit/?id=52ee5092c510657e9b1e8b4ae0104d405c9eac99 py3-parsing] (install manually)
* [https://git.alpinelinux.org/aports/commit/?id=33ea734e2d28d88a3d545500c96b4c72b3e78432 py3-setuptools] (use system component)

===== ncurses fixes =====

A few fixes trickled in relating exclusively to Alpine Linux that affect ncurses:

With this [https://git.alpinelinux.org/aports/commit/?id=762b9fd601983d8a6e6a60692158f3f22b1b60fe commit] the ncurses-lib package no longer depends on the ncurses-terminfo, which was too big at 7.5 MB, instead ncurses-lib now depends solely on the ncurses-terminfo-base package which weights at around 120 kB.

With this [https://git.alpinelinux.org/aports/commit/?id=56aa7795fecc48561deb095995abd335e16ba515 commit] the ncurses-terminfo-base now includes the most common terminfo databases like tmux, screen, xterm-256color and also databases for packaged terminals like gnome-terminal, vte, konsole, alacritty, kitty, putty. All other terminfo databases are now in ncurses-terminfo.

With this [https://git.alpinelinux.org/aports/commit/?id=1470a6c8e76491a8d059ebd4b7521c4bf20b837c commit] all terminals that have their terminfo databases provided by the ncurses-terminfo-base now depend on it.

===== python3 no longer provides pip3, use py3-pip from community =====

Python3 is now built with --without-ensurepip which removes pip3 and its libraries from it. Instead use the py3-pip pacakge which uses system components.

===== BPF JIT support =====

> TODO: Small preamble about BPF

So it (BPF JIT) has been enabled by default in [https://git.alpinelinux.org/aports/commit/?id=3bf2313adc57fe6b36bf459ddca6d65a392609db 3bf2313adc57fe6b36bf459ddca6d65a392609db], and unprivileged BPF JIT has been disabled in [https://git.alpinelinux.org/aports/commit/?id=4e286992d5ed751f6ca60eb18d77313bb0868513 4e286992d5ed751f6ca60eb18d77313bb0868513].

===== OpenRC now has a sane ordering of directories when configuring kernel parameters =====

Configuring kernel parameters is done by having configuration files in specific locations like <code>/etc/sysctl.conf</code> and files ending with <code>.conf</code> in certain directories like <code>/etc/sysctl.d</code>. Before 3.12.0 the ordering had no logical explanation and
surprised users that expected a hierarchy.

Starting with 3.12.0 the ordering is as follows:

# /lib/sysctl.d/*.conf
# /usr/lib/sysctl.d/*.conf
# /run/sysctl.d/*.conf
# /etc/sysctl.conf
# /etc/sysctl.d/*.conf

<code>/lib/sysctl.d</code> and <code>/usr/lib/sysctl.d</code> are to be used by the distribution and packages. Alpine Linux installs its default configuration file in <code>/lib/sysctl.d/00-alpine.conf</code>. Software installed via our package manager will install to either of those places.

<code>/run/sysctl.d</code> holds configuration that is created at run-time by daemons/services or at very early-boot. Neither the distribution nor the packaged software will install configuration to it, primarily because /run is in temporary memory. Configuration in this location that matches names the locations used by the distribution and packages will cause the latter not to be read and applied by the <code>sysctl</code> service.

<code>/etc/sysctl.d</code> holds configuration that is created and maintained by the local administrator, neither Alpine nor its packaged software will touch it, and configuration in that has the same name as in the location reserved for the distribution and packages, or the location for run-time configuration from daemons/services, will cause the latter to not be read and applied by the <code>sysctl</code> service.

<code>/etc/sysctl.conf</code> is a historical location for this kind of configuration and is kept for the same reasons.

===== OpenRC now has a sane ordering of directories when loading kernel modules =====

Loading kernel modules during boot is done with the <code>modules</code> OpenRC service, which reads configuration files in certain locations and loads kernel modules with the modprobe utility from either busybox or util-linux.

Starting with 3.12.0 a more logical ordering is adopted for which configuration files to read and ignore:

# /lib/modules-load.d/*.conf
# /usr/lib/modules-load.d/*.conf
# /run/modules-load.d/*.conf
# /etc/modules
# /etc/modules-load.d/*.conf

<code>/lib/modules-load.d</code> and <code>/usr/lib/modules-load.d</code> are to be used by the distribution and packages. Software installed via our package manager will install to either of those places.

<code>/run/modules-load.d</code> holds configuration that is created at run-time by daemons/services or at very early-boot. Neither the distribution nor the packaged software will install configuration to it, primarily because /run is in temporary memory. Configuration in this location that matches names in the locations used by the distribution and packages will cause the latter not to be read and applied by the <code>modules</code> service.

<code>/etc/modules-load.d</code> holds configuration that is created and maintained by the local administrator, neither Alpine nor its packaged software will touch it, and configuration in that has the same name as in the location reserved for the distribution and packages, or locations reserved for the run-time configuration of daemons/services, will cause the latter to not be read and applied by the <code>modules</code> service.

<code>/etc/modules</code> is a historical location for this kind of configuration and is kept for the same reasons.

===== Telegram Desktop is now available in the community repo =====

See [https://git.alpinelinux.org/aports/commit/?id=184355fdc44bc2e12976d65518fe029d8a6e459d commit] that moved the package to the community repo for explanation.

===== efitools and sbsigntool are now in main/ =====

Those packages have lived in testing/ for a long time and have been successfully used by one of our developers to implement secure-boot in his system. They have been moved to main/ and will be available for others.

===== Packages which need libsecret's DBus API now depend a provider of its API via dbus:org.freedesktop.Secret =====

Previously it was possible to install a program which required the DBus API of libsecret (e.g. Fractal), but not install a secrets provider (e.g. gnome-keyring), so logins wouldn't be saved. This has been corrected and packages which require this API depend on the provider-package dbus:org.freedesktop:Secret now. It's provided by gnome-keyring, kwallet and keepassxc (in that order of importance, i.e. if none of these is pulled in gnome-keyring will be chosen by default). Right now we manually declared the provider for dbus:org.freedesktop.Secret, but eventually we should have an automatic detection for the DBus API packages provide to make this easier for other packages.

===== Preferring enchant2 over enchant =====

All packages which support enchant2 have been moved over to it instead of using enchant(1). enchant2 now also supports nuspell, which is a faster drop-in replacement for hunspell, which utilizes hunspell's dictionaries.

===== Firefox is now in community =====

Firefox finally left testing and will be in community, supported for 6 months.

===== moonjit is now luajit =====

Our luajit package switched to the alive moonjit fork which has, among other things, s390x support and actual development.

This [https://git.alpinelinux.org/aports/commit/?id=af7f776d08cf7c12c3dd62347829fe33e66dceaa commit] switched luajit over to moonjit, the following [https://git.alpinelinux.org/aports/commit/?id=a7d057d98859940cc3347dba011957f99291b1fa commit] removes our **HUGE** 46k s390x support patch which is now handled by upstream.

== abuild ==

===== Add default functions for subpackages that hold Bash, Zsh and Fish completion =====

abuild now provides default functions for $pkgname-bash-completion, $pkgname-zsh-completion and $pkgname-fish-completion subpackages.

Expected location of the completion files per shell:

* Bash -> <code>/usr/share/bash-completion/completions</code>
* Zsh -> <code>/usr/share/zsh/site-functions</code>
* Fish -> <code>/usr/share/fish/completions</code>

Files must be installed in the expected location in relation to '''$pkgdir''' in '''pacakge()'''.

Introduced in [https://gitlab.alpinelinux.org/alpine/abuild/commit/d5826968b713123a4f51d3dec1adb1225d0e194f d5826968b713123a4f51d3dec1adb1225d0e194f].

===== newapkbuild when called with CMake (-C) does out-of-source builds by default =====

When packaging with newapkbuild and using the -C switch to pre-fill the apkbuild with skeleton functions for CMake now:

* Adds <code>-B build</code> to the <code>cmake</code> call in '''build()'''.
* Adds <code>-C build</code> the <code>make</code> calls.

Doing out-of-source builds are recommended upstream to the point where warnings are printed when calling CMake on a project.

Introduced in [https://gitlab.alpinelinux.org/alpine/abuild/commit/e125a764896d884c69cc409e614b65cb336c15e8 e125a764896d884c69cc409e614b65cb336c15e8].

===== set CARGO_HOME to cache dependencies of rust packages =====

CARGO_HOME is now set to '''$SRCDEST/cargo''' and will cache all dependencies downloaded.

Introduced in [https://gitlab.alpinelinux.org/alpine/abuild/commit/af0c88e6abbb1e49224759f5c51b3068e6eab28b af0c88e6abbb1e49224759f5c51b3068e6eab28b].

Release Notes for Alpine 3.12.0

2020-03-02T04:39:55Z

Leo: /* aports */

== aports ==

===== Initial support for DLang =====

We've added initial support for the D language with this release. We now have GDC, the D compiler frontend using GCC, available on all arches but ppc64le and LDC, a D compiler using the LLVM backend, on x86_64. Most things are built against ldc and as such only available on x86_64 right now due to GDC shipping a rather outdated version of the Phobos, the D standard library.

===== py3-setuptools now uses system python3 modules instead of vendored dependencies =====

py3-setuptools now installs py3-packaging, py3-parsing, py3-appdirs, py3-six and py3-ordered-set from the system.

The following commits are the ones responsible for this change:

* [https://git.alpinelinux.org/aports/commit/?id=efca8852f37cb4028f234f92e2d035617f524820 py3-six] (use distutils)
* [https://git.alpinelinux.org/aports/commit/?id=55e3496387ad3f2df387b2cf6bc84e85ef729833 py3-ordered-set] (new aport)
* [https://git.alpinelinux.org/aports/commit/?id=cc1636b08fba58b629501d525d658aed4bcbeab2 py3-ordered-set] (move from testing to main)
* [https://git.alpinelinux.org/aports/commit/?id=da743693eda54b9faf5086746b91506495fc689f py3-appdirs] (move from community to main)
* [https://git.alpinelinux.org/aports/commit/?id=60efe787954008af546a5bde839db09f11682102 py3-appdirs] (use distutils)
* [https://git.alpinelinux.org/aports/commit/?id=a50097b40bcf80a9aec201fef73a722206f43a0d py3-packaging] (use distutils)
* [https://git.alpinelinux.org/aports/commit/?id=52ee5092c510657e9b1e8b4ae0104d405c9eac99 py3-parsing] (install manually)
* [https://git.alpinelinux.org/aports/commit/?id=33ea734e2d28d88a3d545500c96b4c72b3e78432 py3-setuptools] (use system component)

===== ncurses fixes =====

A few fixes trickled in relating exclusively to Alpine Linux that affect ncurses:

With this [https://git.alpinelinux.org/aports/commit/?id=762b9fd601983d8a6e6a60692158f3f22b1b60fe commit] the ncurses-lib package no longer depends on the ncurses-terminfo, which was too big at 7.5 MB, instead ncurses-lib now depends solely on the ncurses-terminfo-base package which weights at around 120 kB.

With this [https://git.alpinelinux.org/aports/commit/?id=56aa7795fecc48561deb095995abd335e16ba515 commit] the ncurses-terminfo-base now includes the most common terminfo databases like tmux, screen, xterm-256color and also databases for packaged terminals like gnome-terminal, vte, konsole, alacritty, kitty, putty. All other terminfo databases are now in ncurses-terminfo.

With this [https://git.alpinelinux.org/aports/commit/?id=1470a6c8e76491a8d059ebd4b7521c4bf20b837c commit] all terminals that have their terminfo databases provided by the ncurses-terminfo-base now depend on it.

===== python3 no longer provides pip3, use py3-pip from community =====

Python3 is now built with --without-ensurepip which removes pip3 and its libraries from it. Instead use the py3-pip pacakge which uses system components.

===== BPF JIT support =====

> TODO: Small preamble about BPF

So it (BPF JIT) has been enabled by default in [https://git.alpinelinux.org/aports/commit/?id=3bf2313adc57fe6b36bf459ddca6d65a392609db 3bf2313adc57fe6b36bf459ddca6d65a392609db], and unprivileged BPF JIT has been disabled in [https://git.alpinelinux.org/aports/commit/?id=4e286992d5ed751f6ca60eb18d77313bb0868513 4e286992d5ed751f6ca60eb18d77313bb0868513].

===== OpenRC now has a sane ordering of directories when configuring kernel parameters =====

Configuring kernel parameters is done by having configuration files in specific locations like <code>/etc/sysctl.conf</code> and files ending with <code>.conf</code> in certain directories like <code>/etc/sysctl.d</code>. Before 3.12.0 the ordering had no logical explanation and
surprised users that expected a hierarchy.

Starting with 3.12.0 the ordering is as follows:

# /lib/sysctl.d/*.conf
# /usr/lib/sysctl.d/*.conf
# /run/sysctl.d/*.conf
# /etc/sysctl.conf
# /etc/sysctl.d/*.conf

<code>/lib/sysctl.d</code> and <code>/usr/lib/sysctl.d</code> are to be used by the distribution and packages. Alpine Linux installs its default configuration file in <code>/lib/sysctl.d/00-alpine.conf</code>. Software installed via our package manager will install to either of those places.

<code>/run/sysctl.d</code> holds configuration that is created at run-time by daemons/services or at very early-boot. Neither the distribution nor the packaged software will install configuration to it, primarily because /run is in temporary memory. Configuration in this location that matches names the locations used by the distribution and packages will cause the latter not to be read and applied by the <code>sysctl</code> service.

<code>/etc/sysctl.d</code> holds configuration that is created and maintained by the local administrator, neither Alpine nor its packaged software will touch it, and configuration in that has the same name as in the location reserved for the distribution and packages, or the location for run-time configuration from daemons/services, will cause the latter to not be read and applied by the <code>sysctl</code> service.

<code>/etc/sysctl.conf</code> is a historical location for this kind of configuration and is kept for the same reasons.

===== OpenRC now has a sane ordering of directories when loading kernel modules =====

Loading kernel modules during boot is done with the <code>modules</code> OpenRC service, which reads configuration files in certain locations and loads kernel modules with the modprobe utility from either busybox or util-linux.

Starting with 3.12.0 a more logical ordering is adopted for which configuration files to read and ignore:

# /lib/modules-load.d/*.conf
# /usr/lib/modules-load.d/*.conf
# /run/modules-load.d/*.conf
# /etc/modules
# /etc/modules-load.d/*.conf

<code>/lib/modules-load.d</code> and <code>/usr/lib/modules-load.d</code> are to be used by the distribution and packages. Software installed via our package manager will install to either of those places.

<code>/run/modules-load.d</code> holds configuration that is created at run-time by daemons/services or at very early-boot. Neither the distribution nor the packaged software will install configuration to it, primarily because /run is in temporary memory. Configuration in this location that matches names in the locations used by the distribution and packages will cause the latter not to be read and applied by the <code>modules</code> service.

<code>/etc/modules-load.d</code> holds configuration that is created and maintained by the local administrator, neither Alpine nor its packaged software will touch it, and configuration in that has the same name as in the location reserved for the distribution and packages, or locations reserved for the run-time configuration of daemons/services, will cause the latter to not be read and applied by the <code>modules</code> service.

<code>/etc/modules</code> is a historical location for this kind of configuration and is kept for the same reasons.

===== Telegram Desktop is now available in the community repo =====

See [https://git.alpinelinux.org/aports/commit/?id=184355fdc44bc2e12976d65518fe029d8a6e459d commit] that moved the package to the community repo for explanation.

===== efitools and sbsigntool are now in main/ =====

Those packages have lived in testing/ for a long time and have been successfully used by one of our developers to implement secure-boot in his system. They have been moved to main/ and will be available for others.

===== Packages which need libsecret's DBus API now depend a provider of its API via dbus:org.freedesktop.Secret =====

Previously it was possible to install a program which required the DBus API of libsecret (e.g. Fractal), but not install a secrets provider (e.g. gnome-keyring), so logins wouldn't be saved. This has been corrected and packages which require this API depend on the provider-package dbus:org.freedesktop:Secret now. It's provided by gnome-keyring, kwallet and keepassxc (in that order of importance, i.e. if none of these is pulled in gnome-keyring will be chosen by default). Right now we manually declared the provider for dbus:org.freedesktop.Secret, but eventually we should have an automatic detection for the DBus API packages provide to make this easier for other packages.

===== Preferring enchant2 over enchant =====

All packages which support enchant2 have been moved over to it instead of using enchant(1). enchant2 now also supports nuspell, which is a faster drop-in replacement for hunspell, which utilizes hunspell's dictionaries.

===== Firefox is now in community =====

Firefox finally left testing and will be in community, supported for 6 months.

== abuild ==

===== Add default functions for subpackages that hold Bash, Zsh and Fish completion =====

abuild now provides default functions for $pkgname-bash-completion, $pkgname-zsh-completion and $pkgname-fish-completion subpackages.

Expected location of the completion files per shell:

* Bash -> <code>/usr/share/bash-completion/completions</code>
* Zsh -> <code>/usr/share/zsh/site-functions</code>
* Fish -> <code>/usr/share/fish/completions</code>

Files must be installed in the expected location in relation to '''$pkgdir''' in '''pacakge()'''.

Introduced in [https://gitlab.alpinelinux.org/alpine/abuild/commit/d5826968b713123a4f51d3dec1adb1225d0e194f d5826968b713123a4f51d3dec1adb1225d0e194f].

===== newapkbuild when called with CMake (-C) does out-of-source builds by default =====

When packaging with newapkbuild and using the -C switch to pre-fill the apkbuild with skeleton functions for CMake now:

* Adds <code>-B build</code> to the <code>cmake</code> call in '''build()'''.
* Adds <code>-C build</code> the <code>make</code> calls.

Doing out-of-source builds are recommended upstream to the point where warnings are printed when calling CMake on a project.

Introduced in [https://gitlab.alpinelinux.org/alpine/abuild/commit/e125a764896d884c69cc409e614b65cb336c15e8 e125a764896d884c69cc409e614b65cb336c15e8].

===== set CARGO_HOME to cache dependencies of rust packages =====

CARGO_HOME is now set to '''$SRCDEST/cargo''' and will cache all dependencies downloaded.

Introduced in [https://gitlab.alpinelinux.org/alpine/abuild/commit/af0c88e6abbb1e49224759f5c51b3068e6eab28b af0c88e6abbb1e49224759f5c51b3068e6eab28b].

Release Notes for Alpine 3.12.0

2020-03-02T04:38:28Z

Leo:

== aports ==

===== Initial support for DLang =====

We've added initial support for the D language with this release. We now have GDC, the D compiler frontend using GCC, available on all arches but ppc64le and LDC, a D compiler using the LLVM backend, on x86_64. Most things are built against ldc and as such only available on x86_64 right now due to GDC shipping a rather outdated version of the Phobos, the D standard library.

===== py3-setuptools now uses system python3 modules instead of vendored dependencies =====

py3-setuptools now installs py3-packaging, py3-parsing, py3-appdirs, py3-six and py3-ordered-set from the system.

The following commits are the ones responsible for this change:

* [https://git.alpinelinux.org/aports/commit/?id=efca8852f37cb4028f234f92e2d035617f524820 py3-six] (use distutils)
* [https://git.alpinelinux.org/aports/commit/?id=55e3496387ad3f2df387b2cf6bc84e85ef729833 py3-ordered-set] (new aport)
* [https://git.alpinelinux.org/aports/commit/?id=cc1636b08fba58b629501d525d658aed4bcbeab2 py3-ordered-set] (move from testing to main)
* [https://git.alpinelinux.org/aports/commit/?id=da743693eda54b9faf5086746b91506495fc689f py3-appdirs] (move from community to main)
* [https://git.alpinelinux.org/aports/commit/?id=60efe787954008af546a5bde839db09f11682102 py3-appdirs] (use distutils)
* [https://git.alpinelinux.org/aports/commit/?id=a50097b40bcf80a9aec201fef73a722206f43a0d py3-packaging] (use distutils)
* [https://git.alpinelinux.org/aports/commit/?id=52ee5092c510657e9b1e8b4ae0104d405c9eac99 py3-parsing] (install manually)
* [https://git.alpinelinux.org/aports/commit/?id=33ea734e2d28d88a3d545500c96b4c72b3e78432 py3-setuptools] (use system component)

===== ncurses fixes =====

A few fixes trickled in relating exclusively to Alpine Linux that affect ncurses:

With this [https://git.alpinelinux.org/aports/commit/?id=762b9fd601983d8a6e6a60692158f3f22b1b60fe commit] the ncurses-lib package no longer depends on the ncurses-terminfo, which was too big at 7.5 MB, instead ncurses-lib now depends solely on the ncurses-terminfo-base package which weights at around 120 kB.

With this [https://git.alpinelinux.org/aports/commit/?id=56aa7795fecc48561deb095995abd335e16ba515 commit] the ncurses-terminfo-base now includes the most common terminfo databases like tmux, screen, xterm-256color and also databases for packaged terminals like gnome-terminal, vte, konsole, alacritty, kitty, putty. All other terminfo databases are now in ncurses-terminfo.

With this [https://git.alpinelinux.org/aports/commit/?id=1470a6c8e76491a8d059ebd4b7521c4bf20b837c commit] all terminals that have their terminfo databases provided by the ncurses-terminfo-base now depend on it.

===== python3 no longer provides pip3, use py3-pip from community =====

Python3 is now built with --without-ensurepip which removes pip3 and its libraries from it. Instead use the py3-pip pacakge which uses system components.

===== BPF JIT support =====

> TODO: Small preamble about BPF

So it (BPF JIT) has been enabled by default in [https://git.alpinelinux.org/aports/commit/?id=3bf2313adc57fe6b36bf459ddca6d65a392609db 3bf2313adc57fe6b36bf459ddca6d65a392609db], and unprivileged BPF JIT has been disabled in [https://git.alpinelinux.org/aports/commit/?id=4e286992d5ed751f6ca60eb18d77313bb0868513 4e286992d5ed751f6ca60eb18d77313bb0868513].

===== OpenRC now has a sane ordering of directories when configuring kernel parameters =====

Configuring kernel parameters is done by having configuration files in specific locations like <code>/etc/sysctl.conf</code> and files ending with <code>.conf</code> in certain directories like <code>/etc/sysctl.d</code>. Before 3.12.0 the ordering had no logical explanation and
surprised users that expected a hierarchy.

Starting with 3.12.0 the ordering is as follows:

# /lib/sysctl.d/*.conf
# /usr/lib/sysctl.d/*.conf
# /run/sysctl.d/*.conf
# /etc/sysctl.conf
# /etc/sysctl.d/*.conf

<code>/lib/sysctl.d</code> and <code>/usr/lib/sysctl.d</code> are to be used by the distribution and packages. Alpine Linux installs its default configuration file in <code>/lib/sysctl.d/00-alpine.conf</code>. Software installed via our package manager will install to either of those places.

<code>/run/sysctl.d</code> holds configuration that is created at run-time by daemons/services or at very early-boot. Neither the distribution nor the packaged software will install configuration to it, primarily because /run is in temporary memory. Configuration in this location that matches names the locations used by the distribution and packages will cause the latter not to be read and applied by the <code>sysctl</code> service.

<code>/etc/sysctl.d</code> holds configuration that is created and maintained by the local administrator, neither Alpine nor its packaged software will touch it, and configuration in that has the same name as in the location reserved for the distribution and packages, or the location for run-time configuration from daemons/services, will cause the latter to not be read and applied by the <code>sysctl</code> service.

<code>/etc/sysctl.conf</code> is a historical location for this kind of configuration and is kept for the same reasons.

===== OpenRC now has a sane ordering of directories when loading kernel modules =====

Loading kernel modules during boot is done with the <code>modules</code> OpenRC service, which reads configuration files in certain locations and loads kernel modules with the modprobe utility from either busybox or util-linux.

Starting with 3.12.0 a more logical ordering is adopted for which configuration files to read and ignore:

# /lib/modules-load.d/*.conf
# /usr/lib/modules-load.d/*.conf
# /run/modules-load.d/*.conf
# /etc/modules
# /etc/modules-load.d/*.conf

<code>/lib/modules-load.d</code> and <code>/usr/lib/modules-load.d</code> are to be used by the distribution and packages. Software installed via our package manager will install to either of those places.

<code>/run/modules-load.d</code> holds configuration that is created at run-time by daemons/services or at very early-boot. Neither the distribution nor the packaged software will install configuration to it, primarily because /run is in temporary memory. Configuration in this location that matches names in the locations used by the distribution and packages will cause the latter not to be read and applied by the <code>modules</code> service.

<code>/etc/modules-load.d</code> holds configuration that is created and maintained by the local administrator, neither Alpine nor its packaged software will touch it, and configuration in that has the same name as in the location reserved for the distribution and packages, or locations reserved for the run-time configuration of daemons/services, will cause the latter to not be read and applied by the <code>modules</code> service.

<code>/etc/modules</code> is a historical location for this kind of configuration and is kept for the same reasons.

===== Telegram Desktop is now available in the community repo =====

See [https://git.alpinelinux.org/aports/commit/?id=184355fdc44bc2e12976d65518fe029d8a6e459d commit] that moved the package to the community repo for explanation.

===== efitools and sbsigntool are now in main/ =====

Those packages have lived in testing/ for a long time and have been successfully used by one of our developers to implement secure-boot in his system. They have been moved to main/ and will be available for others.

===== Packages which need libsecret's DBus API now depend a provider of its API via dbus:org.freedesktop.Secret =====

Previously it was possible to install a program which required the DBus API of libsecret (e.g. Fractal), but not install a secrets provider (e.g. gnome-keyring), so logins wouldn't be saved. This has been corrected and packages which require this API depend on the provider-package dbus:org.freedesktop:Secret now. It's provided by gnome-keyring, kwallet and keepassxc (in that order of importance, i.e. if none of these is pulled in gnome-keyring will be chosen by default). Right now we manually declared the provider for dbus:org.freedesktop.Secret, but eventually we should have an automatic detection for the DBus API packages provide to make this easier for other packages.

===== Preferring enchant2 over enchant =====

All packages which support enchant2 have been moved over to it instead of using enchant(1). enchant2 now also supports nuspell, which is a faster drop-in replacement for hunspell, which utilizes hunspell's dictionaries.

== abuild ==

===== Add default functions for subpackages that hold Bash, Zsh and Fish completion =====

abuild now provides default functions for $pkgname-bash-completion, $pkgname-zsh-completion and $pkgname-fish-completion subpackages.

Expected location of the completion files per shell:

* Bash -> <code>/usr/share/bash-completion/completions</code>
* Zsh -> <code>/usr/share/zsh/site-functions</code>
* Fish -> <code>/usr/share/fish/completions</code>

Files must be installed in the expected location in relation to '''$pkgdir''' in '''pacakge()'''.

Introduced in [https://gitlab.alpinelinux.org/alpine/abuild/commit/d5826968b713123a4f51d3dec1adb1225d0e194f d5826968b713123a4f51d3dec1adb1225d0e194f].

===== newapkbuild when called with CMake (-C) does out-of-source builds by default =====

When packaging with newapkbuild and using the -C switch to pre-fill the apkbuild with skeleton functions for CMake now:

* Adds <code>-B build</code> to the <code>cmake</code> call in '''build()'''.
* Adds <code>-C build</code> the <code>make</code> calls.

Doing out-of-source builds are recommended upstream to the point where warnings are printed when calling CMake on a project.

Introduced in [https://gitlab.alpinelinux.org/alpine/abuild/commit/e125a764896d884c69cc409e614b65cb336c15e8 e125a764896d884c69cc409e614b65cb336c15e8].

===== set CARGO_HOME to cache dependencies of rust packages =====

CARGO_HOME is now set to '''$SRCDEST/cargo''' and will cache all dependencies downloaded.

Introduced in [https://gitlab.alpinelinux.org/alpine/abuild/commit/af0c88e6abbb1e49224759f5c51b3068e6eab28b af0c88e6abbb1e49224759f5c51b3068e6eab28b].

Release Notes for Alpine 3.12.0

2020-02-29T09:49:11Z

Leo: /* aports */

== aports ==

===== py3-setuptools now uses system python3 modules instead of vendored dependencies =====

py3-setuptools now installs py3-packaging, py3-parsing, py3-appdirs, py3-six and py3-ordered-set from the system.

The following commits are the ones responsible for this change:

* [https://git.alpinelinux.org/aports/commit/?id=efca8852f37cb4028f234f92e2d035617f524820 py3-six] (use distutils)
* [https://git.alpinelinux.org/aports/commit/?id=55e3496387ad3f2df387b2cf6bc84e85ef729833 py3-ordered-set] (new aport)
* [https://git.alpinelinux.org/aports/commit/?id=cc1636b08fba58b629501d525d658aed4bcbeab2 py3-ordered-set] (move from testing to main)
* [https://git.alpinelinux.org/aports/commit/?id=da743693eda54b9faf5086746b91506495fc689f py3-appdirs] (move from community to main)
* [https://git.alpinelinux.org/aports/commit/?id=60efe787954008af546a5bde839db09f11682102 py3-appdirs] (use distutils)
* [https://git.alpinelinux.org/aports/commit/?id=a50097b40bcf80a9aec201fef73a722206f43a0d py3-packaging] (use distutils)
* [https://git.alpinelinux.org/aports/commit/?id=52ee5092c510657e9b1e8b4ae0104d405c9eac99 py3-parsing] (install manually)
* [https://git.alpinelinux.org/aports/commit/?id=33ea734e2d28d88a3d545500c96b4c72b3e78432 py3-setuptools] (use system component)

===== ncurses fixes =====

A few fixes trickled in relating exclusively to Alpine Linux that affect ncurses:

With this [https://git.alpinelinux.org/aports/commit/?id=762b9fd601983d8a6e6a60692158f3f22b1b60fe commit] the ncurses-lib package no longer depends on the ncurses-terminfo, which was too big at 7.5 MB, instead ncurses-lib now depends solely on the ncurses-terminfo-base package which weights at around 120 kB.

With this [https://git.alpinelinux.org/aports/commit/?id=56aa7795fecc48561deb095995abd335e16ba515 commit] the ncurses-terminfo-base now includes the most common terminfo databases like tmux, screen, xterm-256color and also databases for packaged terminals like gnome-terminal, vte, konsole, alacritty, kitty, putty. All other terminfo databases are now in ncurses-terminfo.

With this [https://git.alpinelinux.org/aports/commit/?id=1470a6c8e76491a8d059ebd4b7521c4bf20b837c commit] all terminals that have their terminfo databases provided by the ncurses-terminfo-base now depend on it.

===== python3 no longer provides pip3, use py3-pip from community =====

Python3 is now built with --without-ensurepip which removes pip3 and its libraries from it. Instead use the py3-pip pacakge which uses system components.

===== BPF JIT support =====

> TODO: Small preamble about BPF

So it (BPF JIT) has been enabled by default in [https://git.alpinelinux.org/aports/commit/?id=3bf2313adc57fe6b36bf459ddca6d65a392609db 3bf2313adc57fe6b36bf459ddca6d65a392609db], and unprivileged BPF JIT has been disabled in [https://git.alpinelinux.org/aports/commit/?id=4e286992d5ed751f6ca60eb18d77313bb0868513 4e286992d5ed751f6ca60eb18d77313bb0868513].

===== OpenRC now has a sane ordering of directories when configuring kernel parameters =====

Configuring kernel parameters is done by having configuration files in specific locations like <code>/etc/sysctl.conf</code> and files ending with <code>.conf</code> in certain directories like <code>/etc/sysctl.d</code>. Before 3.12.0 the ordering had no logical explanation and
surprised users that expected a hierarchy.

Starting with 3.12.0 the ordering is as follows:

# /lib/sysctl.d/*.conf
# /usr/lib/sysctl.d/*.conf
# /run/sysctl.d/*.conf
# /etc/sysctl.conf
# /etc/sysctl.d/*.conf

<code>/lib/sysctl.d</code> and <code>/usr/lib/sysctl.d</code> are to be used by the distribution and packages. Alpine Linux installs its default configuration file in <code>/lib/sysctl.d/00-alpine.conf</code>. Software installed via our package manager will install to either of those places.

<code>/run/sysctl.d</code> holds configuration that is created at run-time by daemons/services or at very early-boot. Neither the distribution nor the packaged software will install configuration to it, primarily because /run is in temporary memory. Configuration in this location that matches names the locations used by the distribution and packages will cause the latter not to be read and applied by the <code>sysctl</code> service.

<code>/etc/sysctl.d</code> holds configuration that is created and maintained by the local administrator, neither Alpine nor its packaged software will touch it, and configuration in that has the same name as in the location reserved for the distribution and packages, or the location for run-time configuration from daemons/services, will cause the latter to not be read and applied by the <code>sysctl</code> service.

<code>/etc/sysctl.conf</code> is a historical location for this kind of configuration and is kept for the same reasons.

===== OpenRC now has a sane ordering of directories when loading kernel modules =====

Loading kernel modules during boot is done with the <code>modules</code> OpenRC service, which reads configuration files in certain locations and loads kernel modules with the modprobe utility from either busybox or util-linux.

Starting with 3.12.0 a more logical ordering is adopted for which configuration files to read and ignore:

# /lib/modules-load.d/*.conf
# /usr/lib/modules-load.d/*.conf
# /run/modules-load.d/*.conf
# /etc/modules
# /etc/modules-load.d/*.conf

<code>/lib/modules-load.d</code> and <code>/usr/lib/modules-load.d</code> are to be used by the distribution and packages. Software installed via our package manager will install to either of those places.

<code>/run/modules-load.d</code> holds configuration that is created at run-time by daemons/services or at very early-boot. Neither the distribution nor the packaged software will install configuration to it, primarily because /run is in temporary memory. Configuration in this location that matches names in the locations used by the distribution and packages will cause the latter not to be read and applied by the <code>modules</code> service.

<code>/etc/modules-load.d</code> holds configuration that is created and maintained by the local administrator, neither Alpine nor its packaged software will touch it, and configuration in that has the same name as in the location reserved for the distribution and packages, or locations reserved for the run-time configuration of daemons/services, will cause the latter to not be read and applied by the <code>modules</code> service.

<code>/etc/modules</code> is a historical location for this kind of configuration and is kept for the same reasons.

===== Telegram Desktop is now available in the community repo =====

See [https://git.alpinelinux.org/aports/commit/?id=184355fdc44bc2e12976d65518fe029d8a6e459d commit] that moved the package to the community repo for explanation.

===== efitools and sbsigntool are now in main/ =====

Those packages have lived in testing/ for a long time and have been successfully used by one of our developers to implement secure-boot in his system. They have been moved to main/ and will be available for others.

== abuild ==

===== Add default functions for subpackages that hold Bash, Zsh and Fish completion =====

abuild now provides default functions for $pkgname-bash-completion, $pkgname-zsh-completion and $pkgname-fish-completion subpackages.

Expected location of the completion files per shell:

* Bash -> <code>/usr/share/bash-completion/completions</code>
* Zsh -> <code>/usr/share/zsh/site-functions</code>
* Fish -> <code>/usr/share/fish/completions</code>

Files must be installed in the expected location in relation to '''$pkgdir''' in '''pacakge()'''.

Introduced in [https://gitlab.alpinelinux.org/alpine/abuild/commit/d5826968b713123a4f51d3dec1adb1225d0e194f d5826968b713123a4f51d3dec1adb1225d0e194f].

===== newapkbuild when called with CMake (-C) does out-of-source builds by default =====

When packaging with newapkbuild and using the -C switch to pre-fill the apkbuild with skeleton functions for CMake now:

* Adds <code>-B build</code> to the <code>cmake</code> call in '''build()'''.
* Adds <code>-C build</code> the <code>make</code> calls.

Doing out-of-source builds are recommended upstream to the point where warnings are printed when calling CMake on a project.

Introduced in [https://gitlab.alpinelinux.org/alpine/abuild/commit/e125a764896d884c69cc409e614b65cb336c15e8 e125a764896d884c69cc409e614b65cb336c15e8].

===== set CARGO_HOME to cache dependencies of rust packages =====

CARGO_HOME is now set to '''$SRCDEST/cargo''' and will cache all dependencies downloaded.

Introduced in [https://gitlab.alpinelinux.org/alpine/abuild/commit/af0c88e6abbb1e49224759f5c51b3068e6eab28b af0c88e6abbb1e49224759f5c51b3068e6eab28b].

Release Notes for Alpine 3.12.0

2020-02-26T06:37:29Z

Leo: /* ncurses fixes */

== aports ==

===== ncurses fixes =====

A few fixes trickled in relating exclusively to Alpine Linux that affect ncurses:

With this [https://git.alpinelinux.org/aports/commit/?id=762b9fd601983d8a6e6a60692158f3f22b1b60fe commit] the ncurses-lib package no longer depends on the ncurses-terminfo, which was too big at 7.5 MB, instead ncurses-lib now depends solely on the ncurses-terminfo-base package which weights at around 120 kB.

With this [https://git.alpinelinux.org/aports/commit/?id=56aa7795fecc48561deb095995abd335e16ba515 commit] the ncurses-terminfo-base now includes the most common terminfo databases like tmux, screen, xterm-256color and also databases for packaged terminals like gnome-terminal, vte, konsole, alacritty, kitty, putty. All other terminfo databases are now in ncurses-terminfo.

With this [https://git.alpinelinux.org/aports/commit/?id=1470a6c8e76491a8d059ebd4b7521c4bf20b837c commit] all terminals that have their terminfo databases provided by the ncurses-terminfo-base now depend on it.

===== python3 no longer provides pip3, use py3-pip from community =====

Python3 is now built with --without-ensurepip which removes pip3 and its libraries from it. Instead use the py3-pip pacakge which uses system components.

===== BPF JIT support =====

> TODO: Small preamble about BPF

So it (BPF JIT) has been enabled by default in [https://git.alpinelinux.org/aports/commit/?id=3bf2313adc57fe6b36bf459ddca6d65a392609db 3bf2313adc57fe6b36bf459ddca6d65a392609db], and unprivileged BPF JIT has been disabled in [https://git.alpinelinux.org/aports/commit/?id=4e286992d5ed751f6ca60eb18d77313bb0868513 4e286992d5ed751f6ca60eb18d77313bb0868513].

===== OpenRC now has a sane ordering of directories when configuring kernel parameters =====

Configuring kernel parameters is done by having configuration files in specific locations like <code>/etc/sysctl.conf</code> and files ending with <code>.conf</code> in certain directories like <code>/etc/sysctl.d</code>. Before 3.12.0 the ordering had no logical explanation and
surprised users that expected a hierarchy.

Starting with 3.12.0 the ordering is as follows:

# /lib/sysctl.d/*.conf
# /usr/lib/sysctl.d/*.conf
# /run/sysctl.d/*.conf
# /etc/sysctl.conf
# /etc/sysctl.d/*.conf

<code>/lib/sysctl.d</code> and <code>/usr/lib/sysctl.d</code> are to be used by the distribution and packages. Alpine Linux installs its default configuration file in <code>/lib/sysctl.d/00-alpine.conf</code>. Software installed via our package manager will install to either of those places.

<code>/run/sysctl.d</code> holds configuration that is created at run-time by daemons/services or at very early-boot. Neither the distribution nor the packaged software will install configuration to it, primarily because /run is in temporary memory. Configuration in this location that matches names the locations used by the distribution and packages will cause the latter not to be read and applied by the <code>sysctl</code> service.

<code>/etc/sysctl.d</code> holds configuration that is created and maintained by the local administrator, neither Alpine nor its packaged software will touch it, and configuration in that has the same name as in the location reserved for the distribution and packages, or the location for run-time configuration from daemons/services, will cause the latter to not be read and applied by the <code>sysctl</code> service.

<code>/etc/sysctl.conf</code> is a historical location for this kind of configuration and is kept for the same reasons.

===== OpenRC now has a sane ordering of directories when loading kernel modules =====

Loading kernel modules during boot is done with the <code>modules</code> OpenRC service, which reads configuration files in certain locations and loads kernel modules with the modprobe utility from either busybox or util-linux.

Starting with 3.12.0 a more logical ordering is adopted for which configuration files to read and ignore:

# /lib/modules-load.d/*.conf
# /usr/lib/modules-load.d/*.conf
# /run/modules-load.d/*.conf
# /etc/modules
# /etc/modules-load.d/*.conf

<code>/lib/modules-load.d</code> and <code>/usr/lib/modules-load.d</code> are to be used by the distribution and packages. Software installed via our package manager will install to either of those places.

<code>/run/modules-load.d</code> holds configuration that is created at run-time by daemons/services or at very early-boot. Neither the distribution nor the packaged software will install configuration to it, primarily because /run is in temporary memory. Configuration in this location that matches names in the locations used by the distribution and packages will cause the latter not to be read and applied by the <code>modules</code> service.

<code>/etc/modules-load.d</code> holds configuration that is created and maintained by the local administrator, neither Alpine nor its packaged software will touch it, and configuration in that has the same name as in the location reserved for the distribution and packages, or locations reserved for the run-time configuration of daemons/services, will cause the latter to not be read and applied by the <code>modules</code> service.

<code>/etc/modules</code> is a historical location for this kind of configuration and is kept for the same reasons.

===== Telegram Desktop is now available in the community repo =====

See [https://git.alpinelinux.org/aports/commit/?id=184355fdc44bc2e12976d65518fe029d8a6e459d commit] that moved the package to the community repo for explanation.

===== efitools and sbsigntool are now in main/ =====

Those packages have lived in testing/ for a long time and have been successfully used by one of our developers to implement secure-boot in his system. They have been moved to main/ and will be available for others.

== abuild ==

===== Add default functions for subpackages that hold Bash, Zsh and Fish completion =====

abuild now provides default functions for $pkgname-bash-completion, $pkgname-zsh-completion and $pkgname-fish-completion subpackages.

Expected location of the completion files per shell:

* Bash -> <code>/usr/share/bash-completion/completions</code>
* Zsh -> <code>/usr/share/zsh/site-functions</code>
* Fish -> <code>/usr/share/fish/completions</code>

Files must be installed in the expected location in relation to '''$pkgdir''' in '''pacakge()'''.

Introduced in [https://gitlab.alpinelinux.org/alpine/abuild/commit/d5826968b713123a4f51d3dec1adb1225d0e194f d5826968b713123a4f51d3dec1adb1225d0e194f].

===== newapkbuild when called with CMake (-C) does out-of-source builds by default =====

When packaging with newapkbuild and using the -C switch to pre-fill the apkbuild with skeleton functions for CMake now:

* Adds <code>-B build</code> to the <code>cmake</code> call in '''build()'''.
* Adds <code>-C build</code> the <code>make</code> calls.

Doing out-of-source builds are recommended upstream to the point where warnings are printed when calling CMake on a project.

Introduced in [https://gitlab.alpinelinux.org/alpine/abuild/commit/e125a764896d884c69cc409e614b65cb336c15e8 e125a764896d884c69cc409e614b65cb336c15e8].

===== set CARGO_HOME to cache dependencies of rust packages =====

CARGO_HOME is now set to '''$SRCDEST/cargo''' and will cache all dependencies downloaded.

Introduced in [https://gitlab.alpinelinux.org/alpine/abuild/commit/af0c88e6abbb1e49224759f5c51b3068e6eab28b af0c88e6abbb1e49224759f5c51b3068e6eab28b].

Release Notes for Alpine 3.12.0

2020-02-26T05:13:03Z

Leo: /* ncurses fixes */

== aports ==

===== ncurses fixes =====

A few fixes trickled in relating exclusively to Alpine Linux that affect ncurses:

With this [https://git.alpinelinux.org/aports/commit/?id=762b9fd601983d8a6e6a60692158f3f22b1b60fe commit] the ncurses-lib package no longer depends on the ncurses-terminfo, which was too big at 7.5 MB, instead ncurses-lib now depends solely on the ncurses-terminfo-base package which weights at around 120 kB.

With this commit the ncurses-terminfo-base now includes the most common terminfo databases like tmux, screen, xterm-256color and also databases for packaged terminals like gnome-terminal, vte, konsole, alacritty, kitty, putty. All other terminfo databases are now in ncurses-terminfo.

With this commit all terminals that have their terminfo databases provided by the ncurses-terminfo-base now depend on it.

===== python3 no longer provides pip3, use py3-pip from community =====

Python3 is now built with --without-ensurepip which removes pip3 and its libraries from it. Instead use the py3-pip pacakge which uses system components.

===== BPF JIT support =====

> TODO: Small preamble about BPF

So it (BPF JIT) has been enabled by default in [https://git.alpinelinux.org/aports/commit/?id=3bf2313adc57fe6b36bf459ddca6d65a392609db 3bf2313adc57fe6b36bf459ddca6d65a392609db], and unprivileged BPF JIT has been disabled in [https://git.alpinelinux.org/aports/commit/?id=4e286992d5ed751f6ca60eb18d77313bb0868513 4e286992d5ed751f6ca60eb18d77313bb0868513].

===== OpenRC now has a sane ordering of directories when configuring kernel parameters =====

Configuring kernel parameters is done by having configuration files in specific locations like <code>/etc/sysctl.conf</code> and files ending with <code>.conf</code> in certain directories like <code>/etc/sysctl.d</code>. Before 3.12.0 the ordering had no logical explanation and
surprised users that expected a hierarchy.

Starting with 3.12.0 the ordering is as follows:

# /lib/sysctl.d/*.conf
# /usr/lib/sysctl.d/*.conf
# /run/sysctl.d/*.conf
# /etc/sysctl.conf
# /etc/sysctl.d/*.conf

<code>/lib/sysctl.d</code> and <code>/usr/lib/sysctl.d</code> are to be used by the distribution and packages. Alpine Linux installs its default configuration file in <code>/lib/sysctl.d/00-alpine.conf</code>. Software installed via our package manager will install to either of those places.

<code>/run/sysctl.d</code> holds configuration that is created at run-time by daemons/services or at very early-boot. Neither the distribution nor the packaged software will install configuration to it, primarily because /run is in temporary memory. Configuration in this location that matches names the locations used by the distribution and packages will cause the latter not to be read and applied by the <code>sysctl</code> service.

<code>/etc/sysctl.d</code> holds configuration that is created and maintained by the local administrator, neither Alpine nor its packaged software will touch it, and configuration in that has the same name as in the location reserved for the distribution and packages, or the location for run-time configuration from daemons/services, will cause the latter to not be read and applied by the <code>sysctl</code> service.

<code>/etc/sysctl.conf</code> is a historical location for this kind of configuration and is kept for the same reasons.

===== OpenRC now has a sane ordering of directories when loading kernel modules =====

Loading kernel modules during boot is done with the <code>modules</code> OpenRC service, which reads configuration files in certain locations and loads kernel modules with the modprobe utility from either busybox or util-linux.

Starting with 3.12.0 a more logical ordering is adopted for which configuration files to read and ignore:

# /lib/modules-load.d/*.conf
# /usr/lib/modules-load.d/*.conf
# /run/modules-load.d/*.conf
# /etc/modules
# /etc/modules-load.d/*.conf

<code>/lib/modules-load.d</code> and <code>/usr/lib/modules-load.d</code> are to be used by the distribution and packages. Software installed via our package manager will install to either of those places.

<code>/run/modules-load.d</code> holds configuration that is created at run-time by daemons/services or at very early-boot. Neither the distribution nor the packaged software will install configuration to it, primarily because /run is in temporary memory. Configuration in this location that matches names in the locations used by the distribution and packages will cause the latter not to be read and applied by the <code>modules</code> service.

<code>/etc/modules-load.d</code> holds configuration that is created and maintained by the local administrator, neither Alpine nor its packaged software will touch it, and configuration in that has the same name as in the location reserved for the distribution and packages, or locations reserved for the run-time configuration of daemons/services, will cause the latter to not be read and applied by the <code>modules</code> service.

<code>/etc/modules</code> is a historical location for this kind of configuration and is kept for the same reasons.

===== Telegram Desktop is now available in the community repo =====

See [https://git.alpinelinux.org/aports/commit/?id=184355fdc44bc2e12976d65518fe029d8a6e459d commit] that moved the package to the community repo for explanation.

===== efitools and sbsigntool are now in main/ =====

Those packages have lived in testing/ for a long time and have been successfully used by one of our developers to implement secure-boot in his system. They have been moved to main/ and will be available for others.

== abuild ==

===== Add default functions for subpackages that hold Bash, Zsh and Fish completion =====

abuild now provides default functions for $pkgname-bash-completion, $pkgname-zsh-completion and $pkgname-fish-completion subpackages.

Expected location of the completion files per shell:

* Bash -> <code>/usr/share/bash-completion/completions</code>
* Zsh -> <code>/usr/share/zsh/site-functions</code>
* Fish -> <code>/usr/share/fish/completions</code>

Files must be installed in the expected location in relation to '''$pkgdir''' in '''pacakge()'''.

Introduced in [https://gitlab.alpinelinux.org/alpine/abuild/commit/d5826968b713123a4f51d3dec1adb1225d0e194f d5826968b713123a4f51d3dec1adb1225d0e194f].

===== newapkbuild when called with CMake (-C) does out-of-source builds by default =====

When packaging with newapkbuild and using the -C switch to pre-fill the apkbuild with skeleton functions for CMake now:

* Adds <code>-B build</code> to the <code>cmake</code> call in '''build()'''.
* Adds <code>-C build</code> the <code>make</code> calls.

Doing out-of-source builds are recommended upstream to the point where warnings are printed when calling CMake on a project.

Introduced in [https://gitlab.alpinelinux.org/alpine/abuild/commit/e125a764896d884c69cc409e614b65cb336c15e8 e125a764896d884c69cc409e614b65cb336c15e8].

===== set CARGO_HOME to cache dependencies of rust packages =====

CARGO_HOME is now set to '''$SRCDEST/cargo''' and will cache all dependencies downloaded.

Introduced in [https://gitlab.alpinelinux.org/alpine/abuild/commit/af0c88e6abbb1e49224759f5c51b3068e6eab28b af0c88e6abbb1e49224759f5c51b3068e6eab28b].

Release Notes for Alpine 3.12.0

2020-02-26T05:10:21Z

Leo: /* ncurses fixes */

== aports ==

===== ncurses fixes =====

A few fixes trickled in relating exclusively to Alpine Linux that affect ncurses:

* ncurses-libs no longer depend on the 7.5 MB ncurses-terminfo, instead depending only on the 120 kB ncurses-terminfo-base.
* ncurses-terminfo-base now includes the most common terminfo databases like tmux, screen, xterm-256color and also databases
for packaged terminals like gnome-terminal, vte, konsole, alacritty, kitty, putty. All other terminfo databases are now
in ncurses-terminfo.
* All terminals now depend on ncurses-terminfo-base if it provides the terminfo database for the terminal.

===== python3 no longer provides pip3, use py3-pip from community =====

Python3 is now built with --without-ensurepip which removes pip3 and its libraries from it. Instead use the py3-pip pacakge which uses system components.

===== BPF JIT support =====

> TODO: Small preamble about BPF

So it (BPF JIT) has been enabled by default in [https://git.alpinelinux.org/aports/commit/?id=3bf2313adc57fe6b36bf459ddca6d65a392609db 3bf2313adc57fe6b36bf459ddca6d65a392609db], and unprivileged BPF JIT has been disabled in [https://git.alpinelinux.org/aports/commit/?id=4e286992d5ed751f6ca60eb18d77313bb0868513 4e286992d5ed751f6ca60eb18d77313bb0868513].

===== OpenRC now has a sane ordering of directories when configuring kernel parameters =====

Configuring kernel parameters is done by having configuration files in specific locations like <code>/etc/sysctl.conf</code> and files ending with <code>.conf</code> in certain directories like <code>/etc/sysctl.d</code>. Before 3.12.0 the ordering had no logical explanation and
surprised users that expected a hierarchy.

Starting with 3.12.0 the ordering is as follows:

# /lib/sysctl.d/*.conf
# /usr/lib/sysctl.d/*.conf
# /run/sysctl.d/*.conf
# /etc/sysctl.conf
# /etc/sysctl.d/*.conf

<code>/lib/sysctl.d</code> and <code>/usr/lib/sysctl.d</code> are to be used by the distribution and packages. Alpine Linux installs its default configuration file in <code>/lib/sysctl.d/00-alpine.conf</code>. Software installed via our package manager will install to either of those places.

<code>/run/sysctl.d</code> holds configuration that is created at run-time by daemons/services or at very early-boot. Neither the distribution nor the packaged software will install configuration to it, primarily because /run is in temporary memory. Configuration in this location that matches names the locations used by the distribution and packages will cause the latter not to be read and applied by the <code>sysctl</code> service.

<code>/etc/sysctl.d</code> holds configuration that is created and maintained by the local administrator, neither Alpine nor its packaged software will touch it, and configuration in that has the same name as in the location reserved for the distribution and packages, or the location for run-time configuration from daemons/services, will cause the latter to not be read and applied by the <code>sysctl</code> service.

<code>/etc/sysctl.conf</code> is a historical location for this kind of configuration and is kept for the same reasons.

===== OpenRC now has a sane ordering of directories when loading kernel modules =====

Loading kernel modules during boot is done with the <code>modules</code> OpenRC service, which reads configuration files in certain locations and loads kernel modules with the modprobe utility from either busybox or util-linux.

Starting with 3.12.0 a more logical ordering is adopted for which configuration files to read and ignore:

# /lib/modules-load.d/*.conf
# /usr/lib/modules-load.d/*.conf
# /run/modules-load.d/*.conf
# /etc/modules
# /etc/modules-load.d/*.conf

<code>/lib/modules-load.d</code> and <code>/usr/lib/modules-load.d</code> are to be used by the distribution and packages. Software installed via our package manager will install to either of those places.

<code>/run/modules-load.d</code> holds configuration that is created at run-time by daemons/services or at very early-boot. Neither the distribution nor the packaged software will install configuration to it, primarily because /run is in temporary memory. Configuration in this location that matches names in the locations used by the distribution and packages will cause the latter not to be read and applied by the <code>modules</code> service.

<code>/etc/modules-load.d</code> holds configuration that is created and maintained by the local administrator, neither Alpine nor its packaged software will touch it, and configuration in that has the same name as in the location reserved for the distribution and packages, or locations reserved for the run-time configuration of daemons/services, will cause the latter to not be read and applied by the <code>modules</code> service.

<code>/etc/modules</code> is a historical location for this kind of configuration and is kept for the same reasons.

===== Telegram Desktop is now available in the community repo =====

See [https://git.alpinelinux.org/aports/commit/?id=184355fdc44bc2e12976d65518fe029d8a6e459d commit] that moved the package to the community repo for explanation.

===== efitools and sbsigntool are now in main/ =====

Those packages have lived in testing/ for a long time and have been successfully used by one of our developers to implement secure-boot in his system. They have been moved to main/ and will be available for others.

== abuild ==

===== Add default functions for subpackages that hold Bash, Zsh and Fish completion =====

abuild now provides default functions for $pkgname-bash-completion, $pkgname-zsh-completion and $pkgname-fish-completion subpackages.

Expected location of the completion files per shell:

* Bash -> <code>/usr/share/bash-completion/completions</code>
* Zsh -> <code>/usr/share/zsh/site-functions</code>
* Fish -> <code>/usr/share/fish/completions</code>

Files must be installed in the expected location in relation to '''$pkgdir''' in '''pacakge()'''.

Introduced in [https://gitlab.alpinelinux.org/alpine/abuild/commit/d5826968b713123a4f51d3dec1adb1225d0e194f d5826968b713123a4f51d3dec1adb1225d0e194f].

===== newapkbuild when called with CMake (-C) does out-of-source builds by default =====

When packaging with newapkbuild and using the -C switch to pre-fill the apkbuild with skeleton functions for CMake now:

* Adds <code>-B build</code> to the <code>cmake</code> call in '''build()'''.
* Adds <code>-C build</code> the <code>make</code> calls.

Doing out-of-source builds are recommended upstream to the point where warnings are printed when calling CMake on a project.

Introduced in [https://gitlab.alpinelinux.org/alpine/abuild/commit/e125a764896d884c69cc409e614b65cb336c15e8 e125a764896d884c69cc409e614b65cb336c15e8].

===== set CARGO_HOME to cache dependencies of rust packages =====

CARGO_HOME is now set to '''$SRCDEST/cargo''' and will cache all dependencies downloaded.

Introduced in [https://gitlab.alpinelinux.org/alpine/abuild/commit/af0c88e6abbb1e49224759f5c51b3068e6eab28b af0c88e6abbb1e49224759f5c51b3068e6eab28b].

Release Notes for Alpine 3.12.0

2020-02-26T05:09:58Z

Leo: /* OpenRC now has a sane ordering of directories when loading kernel modules */

== aports ==

===== ncurses fixes =====

A few fixes trickled in relating exclusively to Alpine Linux that affect ncurses:

- ncurses-libs no longer depend on the 7.5 MB ncurses-terminfo, instead depending only on the 120 kB ncurses-terminfo-base.
- ncurses-terminfo-base now includes the most common terminfo databases like tmux, screen, xterm-256color and also databases
for packaged terminals like gnome-terminal, vte, konsole, alacritty, kitty, putty. All other terminfo databases are now
in ncurses-terminfo.
- All terminals now depend on ncurses-terminfo-base if it provides the terminfo database for the terminal.

===== python3 no longer provides pip3, use py3-pip from community =====

Python3 is now built with --without-ensurepip which removes pip3 and its libraries from it. Instead use the py3-pip pacakge which uses system components.

===== BPF JIT support =====

> TODO: Small preamble about BPF

So it (BPF JIT) has been enabled by default in [https://git.alpinelinux.org/aports/commit/?id=3bf2313adc57fe6b36bf459ddca6d65a392609db 3bf2313adc57fe6b36bf459ddca6d65a392609db], and unprivileged BPF JIT has been disabled in [https://git.alpinelinux.org/aports/commit/?id=4e286992d5ed751f6ca60eb18d77313bb0868513 4e286992d5ed751f6ca60eb18d77313bb0868513].

===== OpenRC now has a sane ordering of directories when configuring kernel parameters =====

Configuring kernel parameters is done by having configuration files in specific locations like <code>/etc/sysctl.conf</code> and files ending with <code>.conf</code> in certain directories like <code>/etc/sysctl.d</code>. Before 3.12.0 the ordering had no logical explanation and
surprised users that expected a hierarchy.

Starting with 3.12.0 the ordering is as follows:

# /lib/sysctl.d/*.conf
# /usr/lib/sysctl.d/*.conf
# /run/sysctl.d/*.conf
# /etc/sysctl.conf
# /etc/sysctl.d/*.conf

<code>/lib/sysctl.d</code> and <code>/usr/lib/sysctl.d</code> are to be used by the distribution and packages. Alpine Linux installs its default configuration file in <code>/lib/sysctl.d/00-alpine.conf</code>. Software installed via our package manager will install to either of those places.

<code>/run/sysctl.d</code> holds configuration that is created at run-time by daemons/services or at very early-boot. Neither the distribution nor the packaged software will install configuration to it, primarily because /run is in temporary memory. Configuration in this location that matches names the locations used by the distribution and packages will cause the latter not to be read and applied by the <code>sysctl</code> service.

<code>/etc/sysctl.d</code> holds configuration that is created and maintained by the local administrator, neither Alpine nor its packaged software will touch it, and configuration in that has the same name as in the location reserved for the distribution and packages, or the location for run-time configuration from daemons/services, will cause the latter to not be read and applied by the <code>sysctl</code> service.

<code>/etc/sysctl.conf</code> is a historical location for this kind of configuration and is kept for the same reasons.

===== OpenRC now has a sane ordering of directories when loading kernel modules =====

Loading kernel modules during boot is done with the <code>modules</code> OpenRC service, which reads configuration files in certain locations and loads kernel modules with the modprobe utility from either busybox or util-linux.

Starting with 3.12.0 a more logical ordering is adopted for which configuration files to read and ignore:

# /lib/modules-load.d/*.conf
# /usr/lib/modules-load.d/*.conf
# /run/modules-load.d/*.conf
# /etc/modules
# /etc/modules-load.d/*.conf

<code>/lib/modules-load.d</code> and <code>/usr/lib/modules-load.d</code> are to be used by the distribution and packages. Software installed via our package manager will install to either of those places.

<code>/run/modules-load.d</code> holds configuration that is created at run-time by daemons/services or at very early-boot. Neither the distribution nor the packaged software will install configuration to it, primarily because /run is in temporary memory. Configuration in this location that matches names in the locations used by the distribution and packages will cause the latter not to be read and applied by the <code>modules</code> service.

<code>/etc/modules-load.d</code> holds configuration that is created and maintained by the local administrator, neither Alpine nor its packaged software will touch it, and configuration in that has the same name as in the location reserved for the distribution and packages, or locations reserved for the run-time configuration of daemons/services, will cause the latter to not be read and applied by the <code>modules</code> service.

<code>/etc/modules</code> is a historical location for this kind of configuration and is kept for the same reasons.

===== Telegram Desktop is now available in the community repo =====

See [https://git.alpinelinux.org/aports/commit/?id=184355fdc44bc2e12976d65518fe029d8a6e459d commit] that moved the package to the community repo for explanation.

===== efitools and sbsigntool are now in main/ =====

Those packages have lived in testing/ for a long time and have been successfully used by one of our developers to implement secure-boot in his system. They have been moved to main/ and will be available for others.

== abuild ==

===== Add default functions for subpackages that hold Bash, Zsh and Fish completion =====

abuild now provides default functions for $pkgname-bash-completion, $pkgname-zsh-completion and $pkgname-fish-completion subpackages.

Expected location of the completion files per shell:

* Bash -> <code>/usr/share/bash-completion/completions</code>
* Zsh -> <code>/usr/share/zsh/site-functions</code>
* Fish -> <code>/usr/share/fish/completions</code>

Files must be installed in the expected location in relation to '''$pkgdir''' in '''pacakge()'''.

Introduced in [https://gitlab.alpinelinux.org/alpine/abuild/commit/d5826968b713123a4f51d3dec1adb1225d0e194f d5826968b713123a4f51d3dec1adb1225d0e194f].

===== newapkbuild when called with CMake (-C) does out-of-source builds by default =====

When packaging with newapkbuild and using the -C switch to pre-fill the apkbuild with skeleton functions for CMake now:

* Adds <code>-B build</code> to the <code>cmake</code> call in '''build()'''.
* Adds <code>-C build</code> the <code>make</code> calls.

Doing out-of-source builds are recommended upstream to the point where warnings are printed when calling CMake on a project.

Introduced in [https://gitlab.alpinelinux.org/alpine/abuild/commit/e125a764896d884c69cc409e614b65cb336c15e8 e125a764896d884c69cc409e614b65cb336c15e8].

===== set CARGO_HOME to cache dependencies of rust packages =====

CARGO_HOME is now set to '''$SRCDEST/cargo''' and will cache all dependencies downloaded.

Introduced in [https://gitlab.alpinelinux.org/alpine/abuild/commit/af0c88e6abbb1e49224759f5c51b3068e6eab28b af0c88e6abbb1e49224759f5c51b3068e6eab28b].

Release Notes for Alpine 3.12.0

2020-02-26T05:09:02Z

Leo: /* OpenRC now has a sane ordering of directories when configuring kernel parameters */

== aports ==

===== ncurses fixes =====

A few fixes trickled in relating exclusively to Alpine Linux that affect ncurses:

- ncurses-libs no longer depend on the 7.5 MB ncurses-terminfo, instead depending only on the 120 kB ncurses-terminfo-base.
- ncurses-terminfo-base now includes the most common terminfo databases like tmux, screen, xterm-256color and also databases
for packaged terminals like gnome-terminal, vte, konsole, alacritty, kitty, putty. All other terminfo databases are now
in ncurses-terminfo.
- All terminals now depend on ncurses-terminfo-base if it provides the terminfo database for the terminal.

===== python3 no longer provides pip3, use py3-pip from community =====

Python3 is now built with --without-ensurepip which removes pip3 and its libraries from it. Instead use the py3-pip pacakge which uses system components.

===== BPF JIT support =====

> TODO: Small preamble about BPF

So it (BPF JIT) has been enabled by default in [https://git.alpinelinux.org/aports/commit/?id=3bf2313adc57fe6b36bf459ddca6d65a392609db 3bf2313adc57fe6b36bf459ddca6d65a392609db], and unprivileged BPF JIT has been disabled in [https://git.alpinelinux.org/aports/commit/?id=4e286992d5ed751f6ca60eb18d77313bb0868513 4e286992d5ed751f6ca60eb18d77313bb0868513].

===== OpenRC now has a sane ordering of directories when configuring kernel parameters =====

Configuring kernel parameters is done by having configuration files in specific locations like <code>/etc/sysctl.conf</code> and files ending with <code>.conf</code> in certain directories like <code>/etc/sysctl.d</code>. Before 3.12.0 the ordering had no logical explanation and
surprised users that expected a hierarchy.

Starting with 3.12.0 the ordering is as follows:

# /lib/sysctl.d/*.conf
# /usr/lib/sysctl.d/*.conf
# /run/sysctl.d/*.conf
# /etc/sysctl.conf
# /etc/sysctl.d/*.conf

<code>/lib/sysctl.d</code> and <code>/usr/lib/sysctl.d</code> are to be used by the distribution and packages. Alpine Linux installs its default configuration file in <code>/lib/sysctl.d/00-alpine.conf</code>. Software installed via our package manager will install to either of those places.

<code>/run/sysctl.d</code> holds configuration that is created at run-time by daemons/services or at very early-boot. Neither the distribution nor the packaged software will install configuration to it, primarily because /run is in temporary memory. Configuration in this location that matches names the locations used by the distribution and packages will cause the latter not to be read and applied by the <code>sysctl</code> service.

<code>/etc/sysctl.d</code> holds configuration that is created and maintained by the local administrator, neither Alpine nor its packaged software will touch it, and configuration in that has the same name as in the location reserved for the distribution and packages, or the location for run-time configuration from daemons/services, will cause the latter to not be read and applied by the <code>sysctl</code> service.

<code>/etc/sysctl.conf</code> is a historical location for this kind of configuration and is kept for the same reasons.

===== OpenRC now has a sane ordering of directories when loading kernel modules =====

Loading kernel modules during boot is done with the <code>modules</code> OpenRC service, which reads configuration files in certain locations and loads kernel modules with the modprobe utility from either busybox or util-linux.

Starting with 3.12.0 a more logical ordering is adopted for which configuration files to read and ignore:

# /lib/modules-load.d/*.conf
# /usr/lib/modules-load.d/*.conf
# /etc/modules
# /etc/modules-load.d/*.conf
# /run/modules-load.d/*.conf

<code>/lib/modules-load.d</code> and <code>/usr/lib/modules-load.d</code> are to be used by the distribution and packages. Software installed via our package manager will install to either of those places.

<code>/etc/modules-load.d</code> holds configuration that is created and maintained by the local administrator, neither Alpine nor its packaged software will touch it, and configuration in that has the same name as in the location reserved for the distribution and packages will cause the latter to not be read and applied by the <code>modules</code> service.

<code>/etc/modules</code> is a historical location for this kind of configuration and is kept for the same reasons.

<code>/run/modules-load.d</code> holds configuration that is created at run-time by daemons/services or at very early-boot. Neither the distribution nor the packaged software will install configuration to it, primarily because /run is in temporary memory. Configuration in this location that matches names in the local administrator or the locations used by the distribution and packages will cause the latter not to be read and applied by the <code>modules</code> service.

===== Telegram Desktop is now available in the community repo =====

See [https://git.alpinelinux.org/aports/commit/?id=184355fdc44bc2e12976d65518fe029d8a6e459d commit] that moved the package to the community repo for explanation.

===== efitools and sbsigntool are now in main/ =====

Those packages have lived in testing/ for a long time and have been successfully used by one of our developers to implement secure-boot in his system. They have been moved to main/ and will be available for others.

== abuild ==

===== Add default functions for subpackages that hold Bash, Zsh and Fish completion =====

abuild now provides default functions for $pkgname-bash-completion, $pkgname-zsh-completion and $pkgname-fish-completion subpackages.

Expected location of the completion files per shell:

* Bash -> <code>/usr/share/bash-completion/completions</code>
* Zsh -> <code>/usr/share/zsh/site-functions</code>
* Fish -> <code>/usr/share/fish/completions</code>

Files must be installed in the expected location in relation to '''$pkgdir''' in '''pacakge()'''.

Introduced in [https://gitlab.alpinelinux.org/alpine/abuild/commit/d5826968b713123a4f51d3dec1adb1225d0e194f d5826968b713123a4f51d3dec1adb1225d0e194f].

===== newapkbuild when called with CMake (-C) does out-of-source builds by default =====

When packaging with newapkbuild and using the -C switch to pre-fill the apkbuild with skeleton functions for CMake now:

* Adds <code>-B build</code> to the <code>cmake</code> call in '''build()'''.
* Adds <code>-C build</code> the <code>make</code> calls.

Doing out-of-source builds are recommended upstream to the point where warnings are printed when calling CMake on a project.

Introduced in [https://gitlab.alpinelinux.org/alpine/abuild/commit/e125a764896d884c69cc409e614b65cb336c15e8 e125a764896d884c69cc409e614b65cb336c15e8].

===== set CARGO_HOME to cache dependencies of rust packages =====

CARGO_HOME is now set to '''$SRCDEST/cargo''' and will cache all dependencies downloaded.

Introduced in [https://gitlab.alpinelinux.org/alpine/abuild/commit/af0c88e6abbb1e49224759f5c51b3068e6eab28b af0c88e6abbb1e49224759f5c51b3068e6eab28b].

Release Notes for Alpine 3.12.0

2020-02-26T05:03:51Z

Leo:

== aports ==

===== ncurses fixes =====

A few fixes trickled in relating exclusively to Alpine Linux that affect ncurses:

- ncurses-libs no longer depend on the 7.5 MB ncurses-terminfo, instead depending only on the 120 kB ncurses-terminfo-base.
- ncurses-terminfo-base now includes the most common terminfo databases like tmux, screen, xterm-256color and also databases
for packaged terminals like gnome-terminal, vte, konsole, alacritty, kitty, putty. All other terminfo databases are now
in ncurses-terminfo.
- All terminals now depend on ncurses-terminfo-base if it provides the terminfo database for the terminal.

===== python3 no longer provides pip3, use py3-pip from community =====

Python3 is now built with --without-ensurepip which removes pip3 and its libraries from it. Instead use the py3-pip pacakge which uses system components.

===== BPF JIT support =====

> TODO: Small preamble about BPF

So it (BPF JIT) has been enabled by default in [https://git.alpinelinux.org/aports/commit/?id=3bf2313adc57fe6b36bf459ddca6d65a392609db 3bf2313adc57fe6b36bf459ddca6d65a392609db], and unprivileged BPF JIT has been disabled in [https://git.alpinelinux.org/aports/commit/?id=4e286992d5ed751f6ca60eb18d77313bb0868513 4e286992d5ed751f6ca60eb18d77313bb0868513].

===== OpenRC now has a sane ordering of directories when configuring kernel parameters =====

Configuring kernel parameters is done by having configuration files in specific locations like <code>/etc/sysctl.conf</code> and files ending with <code>.conf</code> in certain directories like <code>/etc/sysctl.d</code>. Before 3.12.0 the ordering had no logical explanation and
surprised users that expected a hierarchy.

Starting with 3.12.0 the ordering is as follows:

# /lib/sysctl.d/*.conf
# /usr/lib/sysctl.d/*.conf
# /etc/sysctl.d/*.conf
# /etc/sysctl.conf
# /run/sysctl.d/*.conf

<code>/lib/sysctl.d</code> and <code>/usr/lib/sysctl.d</code> are to be used by the distribution and packages. Alpine Linux installs its default configuration file in <code>/lib/sysctl.d/00-alpine.conf</code>. Software installed via our package manager will install to either of those places.

<code>/etc/sysctl.d</code> holds configuration that is created and maintained by the local administrator, neither Alpine nor its packaged software will touch it, and configuration in that has the same name as in the location reserved for the distribution and packages will cause the latter to not be read and applied by the <code>sysctl</code> service.

<code>/etc/sysctl.conf</code> is a historical location for this kind of configuration and is kept for the same reasons.

<code>/run/sysctl.d</code> holds configuration that is created at run-time by daemons/services or at very early-boot. Neither the distribution nor the packaged software will install configuration to it, primarily because /run is in temporary memory. Configuration in this location that matches names in the local administrator or the locations used by the distribution and packages will cause the latter not to be read and applied by the <code>sysctl</code> service.

===== OpenRC now has a sane ordering of directories when loading kernel modules =====

Loading kernel modules during boot is done with the <code>modules</code> OpenRC service, which reads configuration files in certain locations and loads kernel modules with the modprobe utility from either busybox or util-linux.

Starting with 3.12.0 a more logical ordering is adopted for which configuration files to read and ignore:

# /lib/modules-load.d/*.conf
# /usr/lib/modules-load.d/*.conf
# /etc/modules
# /etc/modules-load.d/*.conf
# /run/modules-load.d/*.conf

<code>/lib/modules-load.d</code> and <code>/usr/lib/modules-load.d</code> are to be used by the distribution and packages. Software installed via our package manager will install to either of those places.

<code>/etc/modules-load.d</code> holds configuration that is created and maintained by the local administrator, neither Alpine nor its packaged software will touch it, and configuration in that has the same name as in the location reserved for the distribution and packages will cause the latter to not be read and applied by the <code>modules</code> service.

<code>/etc/modules</code> is a historical location for this kind of configuration and is kept for the same reasons.

<code>/run/modules-load.d</code> holds configuration that is created at run-time by daemons/services or at very early-boot. Neither the distribution nor the packaged software will install configuration to it, primarily because /run is in temporary memory. Configuration in this location that matches names in the local administrator or the locations used by the distribution and packages will cause the latter not to be read and applied by the <code>modules</code> service.

===== Telegram Desktop is now available in the community repo =====

See [https://git.alpinelinux.org/aports/commit/?id=184355fdc44bc2e12976d65518fe029d8a6e459d commit] that moved the package to the community repo for explanation.

===== efitools and sbsigntool are now in main/ =====

Those packages have lived in testing/ for a long time and have been successfully used by one of our developers to implement secure-boot in his system. They have been moved to main/ and will be available for others.

== abuild ==

===== Add default functions for subpackages that hold Bash, Zsh and Fish completion =====

abuild now provides default functions for $pkgname-bash-completion, $pkgname-zsh-completion and $pkgname-fish-completion subpackages.

Expected location of the completion files per shell:

* Bash -> <code>/usr/share/bash-completion/completions</code>
* Zsh -> <code>/usr/share/zsh/site-functions</code>
* Fish -> <code>/usr/share/fish/completions</code>

Files must be installed in the expected location in relation to '''$pkgdir''' in '''pacakge()'''.

Introduced in [https://gitlab.alpinelinux.org/alpine/abuild/commit/d5826968b713123a4f51d3dec1adb1225d0e194f d5826968b713123a4f51d3dec1adb1225d0e194f].

===== newapkbuild when called with CMake (-C) does out-of-source builds by default =====

When packaging with newapkbuild and using the -C switch to pre-fill the apkbuild with skeleton functions for CMake now:

* Adds <code>-B build</code> to the <code>cmake</code> call in '''build()'''.
* Adds <code>-C build</code> the <code>make</code> calls.

Doing out-of-source builds are recommended upstream to the point where warnings are printed when calling CMake on a project.

Introduced in [https://gitlab.alpinelinux.org/alpine/abuild/commit/e125a764896d884c69cc409e614b65cb336c15e8 e125a764896d884c69cc409e614b65cb336c15e8].

===== set CARGO_HOME to cache dependencies of rust packages =====

CARGO_HOME is now set to '''$SRCDEST/cargo''' and will cache all dependencies downloaded.

Introduced in [https://gitlab.alpinelinux.org/alpine/abuild/commit/af0c88e6abbb1e49224759f5c51b3068e6eab28b af0c88e6abbb1e49224759f5c51b3068e6eab28b].

Aports what is edge

2020-02-25T07:43:18Z

Leo: /* How packages move in edge (The Juggler) */

== What is edge (The Definition) ==
: '''Short definition'''
:: Edge is a rolling release branch.

[Illustration] 
* bleeding edge
* tree on the cliff

== How packages move in edge (The Juggler) ==

What are repositories (main|community|testing) ?
See, https://wiki.alpinelinux.org/wiki/Aports_tree

# MAIN
## Main has a support cycle of 2 years
## Support the main repository for 1.5 year (a total of 2 years)
## We also try to limit the amount of packages in main to only include base system packages, in base you can think of packages which are needed by other packages or are needed to setup a basic system.
## Packages in main must not have dependencies in other repositories.
# COMMUNITY
## Community has a maximum support cycle of 6 months.
## Support will stop (you will need to upgrade to the new release to continue to have support)
## Packages limited if its a bloat
# TESTING
## No support (staging only), only built for edge.
## If it stays here long enough it gets moved to unmaintained/purged (gets cleaned up every 6 months)
## No limit
# UNMAINTAINED
## Unmaintained packages are not build.
#NON-FREE
## Don't ask, don't tell, we only like opensource.

[Illustration] 
* bananas for repos (green=testing, green/yellow=community, yellow=main)
* unmaintained(brown), algibot with closed nose, brooming it away
* non-free(transparent), we act as if they do not exist

Before a package can move from testing to main or community, the following requirements must be met:

# Package must work correctly, including the init.d script (if provided) and default configuration
# Packaging must be done correctly, with files installed in the right places, e.g. configs are in /etc/ and not in /usr/etc
# Package dependencies are handled correctly. Abuild can (and should) autodetect shared libs, for example sqlite-libs provides so:libsqlite3.so.0, any package linked to sqlite should have an automatically (by abuild) added depend=so:libsqlite3.so.0 and user should not manually add a depend="sqlite-libs" in the APKBUILD
# There is a maintainer who claims responsibility for the maintenance of the package and can help fixing things if they break in the future

== Packages that go to next stable release (The Reap) ==
Every new stable release will be a branch created from our master branch (our current edge release).
The only two repositories included in stable branches are main and community.
This means any package that is currently in our testing repository will not be included in our new release. This is because testing is a kind of staging directory where we test packaging before we move them to one of the two other repositories (most probably community).

Please also keep in mind that our community repository is still young so many packages will still need to be moved to community, we try to do that when we bump into them.

[Illustration] 
* Hoga-boga dance around fire
* Harvesting season

== What is stable release (Fruits of Labor) ==
- How to find latest stable release?

[Illustration] 
* Vacation to alpine wilderness

== Do we backport new packages(from edge) to previous stable releases (The Gift, Favor) ==
# Make a request on forum/irc, mailing list or add to bugs.a.o and wait.
# Don't forget to say why (in short).
# Be prepared for rejection.

[Illustration] 
* Algibot controlled drone dropping packages (the gift).

== How packages are deleted (The Purge) ==
Presently applies mostly to "testing".

=== Checks before purge ===
# If packages is feature complete
# If its stable and no equivalent package is available
# If its a hard-depends for another package.
# If its requiring extra maintenance then move to a lower priority level
# If its a problem, add to bugs.alpinelinux.org first, once bugs get comments, vote or veto
# If its in 'testing' long enough (this is shaky)

=== After purge ===
# Remember to replace with equivalent packages if its only of a kind
# Notify in "detailed changes list" in release notes (applies to main|community)

[Illustration] 
* Algibot shooting packages with nose clips on
* Algibot brooming it away

== Glossary ==
# '''Support''' - mostly security fixes and major software issues
# '''Special packages''' - packages voted to be special (not otherwise as understood as basic system package)

=See Also=
*[[Aports tree]]

[[Category:Development]]

Release Notes for Alpine 3.12.0

2020-02-21T19:31:22Z

Leo:

== secfixes ==

{{Note|pending discussion with other developers}}

This is the last release that will have secfixes information embedded into the APKBUILD in the form of shell comments, future
versions will have a separate <code>secfixes.yaml</code> file that resides in the same directory as the APKBUILD, it will be
a purely yaml file.

This removes the potentially troublesome operation of reading the APKBUILD and extracting the secfixes comment, allowing us
to simplify secfixes-check from [https://gitlab.alpinelinux.org/Leo/atools Leo/atools] to validate the yaml by simply loading
the separate yaml file.

== aports ==

===== BPF JIT support =====

> TODO: Small preamble about BPF

So it (BPF JIT) has been enabled by default in [https://git.alpinelinux.org/aports/commit/?id=3bf2313adc57fe6b36bf459ddca6d65a392609db 3bf2313adc57fe6b36bf459ddca6d65a392609db], and unprivileged BPF JIT has been disabled in [https://git.alpinelinux.org/aports/commit/?id=4e286992d5ed751f6ca60eb18d77313bb0868513 4e286992d5ed751f6ca60eb18d77313bb0868513].

===== OpenRC now has a sane ordering of directories when configuring kernel parameters =====

Configuring kernel parameters is done by having configuration files in specific locations like <code>/etc/sysctl.conf</code> and files ending with <code>.conf</code> in certain directories like <code>/etc/sysctl.d</code>. Before 3.12.0 the ordering had no logical explanation and
surprised users that expected a hierarchy.

Starting with 3.12.0 the ordering is as follows:

# /lib/sysctl.d/*.conf
# /usr/lib/sysctl.d/*.conf
# /etc/sysctl.d/*.conf
# /etc/sysctl.conf
# /run/sysctl.d/*.conf

<code>/lib/sysctl.d</code> and <code>/usr/lib/sysctl.d</code> are to be used by the distribution and packages. Alpine Linux installs its default configuration file in <code>/lib/sysctl.d/00-alpine.conf</code>. Software installed via our package manager will install to either of those places.

<code>/etc/sysctl.d</code> holds configuration that is created and maintained by the local administrator, neither Alpine nor its packaged software will touch it, and configuration in that has the same name as in the location reserved for the distribution and packages will cause the latter to not be read and applied by the <code>sysctl</code> service.

<code>/etc/sysctl.conf</code> is a historical location for this kind of configuration and is kept for the same reasons.

<code>/run/sysctl.d</code> holds configuration that is created at run-time by daemons/services or at very early-boot. Neither the distribution nor the packaged software will install configuration to it, primarily because /run is in temporary memory. Configuration in this location that matches names in the local administrator or the locations used by the distribution and packages will cause the latter not to be read and applied by the <code>sysctl</code> service.

===== OpenRC now has a sane ordering of directories when loading kernel modules =====

Loading kernel modules during boot is done with the <code>modules</code> OpenRC service, which reads configuration files in certain locations and loads kernel modules with the modprobe utility from either busybox or util-linux.

Starting with 3.12.0 a more logical ordering is adopted for which configuration files to read and ignore:

# /lib/modules-load.d/*.conf
# /usr/lib/modules-load.d/*.conf
# /etc/modules
# /etc/modules-load.d/*.conf
# /run/modules-load.d/*.conf

<code>/lib/modules-load.d</code> and <code>/usr/lib/modules-load.d</code> are to be used by the distribution and packages. Software installed via our package manager will install to either of those places.

<code>/etc/modules-load.d</code> holds configuration that is created and maintained by the local administrator, neither Alpine nor its packaged software will touch it, and configuration in that has the same name as in the location reserved for the distribution and packages will cause the latter to not be read and applied by the <code>modules</code> service.

<code>/etc/modules</code> is a historical location for this kind of configuration and is kept for the same reasons.

<code>/run/modules-load.d</code> holds configuration that is created at run-time by daemons/services or at very early-boot. Neither the distribution nor the packaged software will install configuration to it, primarily because /run is in temporary memory. Configuration in this location that matches names in the local administrator or the locations used by the distribution and packages will cause the latter not to be read and applied by the <code>modules</code> service.

===== Telegram Desktop is now available in the community repo =====

See [https://git.alpinelinux.org/aports/commit/?id=184355fdc44bc2e12976d65518fe029d8a6e459d commit] that moved the package to the community repo for explanation.

===== efitools and sbsigntool are now in main/ =====

Those packages have lived in testing/ for a long time and have been successfully used by one of our developers to implement secure-boot in his system. They have been moved to main/ and will be available for others.

== abuild ==

===== Add default functions for subpackages that hold Bash, Zsh and Fish completion =====

abuild now provides default functions for $pkgname-bash-completion, $pkgname-zsh-completion and $pkgname-fish-completion subpackages.

Expected location of the completion files per shell:

* Bash -> <code>/usr/share/bash-completion/completions</code>
* Zsh -> <code>/usr/share/zsh/site-functions</code>
* Fish -> <code>/usr/share/fish/completions</code>

Files must be installed in the expected location in relation to '''$pkgdir''' in '''pacakge()'''.

Introduced in [https://gitlab.alpinelinux.org/alpine/abuild/commit/d5826968b713123a4f51d3dec1adb1225d0e194f d5826968b713123a4f51d3dec1adb1225d0e194f].

===== newapkbuild when called with CMake (-C) does out-of-source builds by default =====

When packaging with newapkbuild and using the -C switch to pre-fill the apkbuild with skeleton functions for CMake now:

* Adds <code>-B build</code> to the <code>cmake</code> call in '''build()'''.
* Adds <code>-C build</code> the <code>make</code> calls.

Doing out-of-source builds are recommended upstream to the point where warnings are printed when calling CMake on a project.

Introduced in [https://gitlab.alpinelinux.org/alpine/abuild/commit/e125a764896d884c69cc409e614b65cb336c15e8 e125a764896d884c69cc409e614b65cb336c15e8].

===== set CARGO_HOME to cache dependencies of rust packages =====

CARGO_HOME is now set to '''$SRCDEST/cargo''' and will cache all dependencies downloaded.

Introduced in [https://gitlab.alpinelinux.org/alpine/abuild/commit/af0c88e6abbb1e49224759f5c51b3068e6eab28b af0c88e6abbb1e49224759f5c51b3068e6eab28b].

Release Notes for Alpine 3.12.0

2020-02-19T04:45:50Z

Leo:

== aports ==

===== BPF JIT support =====

> TODO: Small preamble about BPF

So it (BPF JIT) has been enabled by default in [https://git.alpinelinux.org/aports/commit/?id=3bf2313adc57fe6b36bf459ddca6d65a392609db 3bf2313adc57fe6b36bf459ddca6d65a392609db], and unprivileged BPF JIT has been disabled in [https://git.alpinelinux.org/aports/commit/?id=4e286992d5ed751f6ca60eb18d77313bb0868513 4e286992d5ed751f6ca60eb18d77313bb0868513].

===== OpenRC now has a sane ordering of directories when configuring kernel parameters =====

Configuring kernel parameters is done by having configuration files in specific locations like <code>/etc/sysctl.conf</code> and files ending with <code>.conf</code> in certain directories like <code>/etc/sysctl.d</code>. Before 3.12.0 the ordering had no logical explanation and
surprised users that expected a hierarchy.

Starting with 3.12.0 the ordering is as follows:

# /lib/sysctl.d/*.conf
# /usr/lib/sysctl.d/*.conf
# /etc/sysctl.d/*.conf
# /etc/sysctl.conf
# /run/sysctl.d/*.conf

<code>/lib/sysctl.d</code> and <code>/usr/lib/sysctl.d</code> are to be used by the distribution and packages. Alpine Linux installs its default configuration file in <code>/lib/sysctl.d/00-alpine.conf</code>. Software installed via our package manager will install to either of those places.

<code>/etc/sysctl.d</code> holds configuration that is created and maintained by the local administrator, neither Alpine nor its packaged software will touch it, and configuration in that has the same name as in the location reserved for the distribution and packages will cause the latter to not be read and applied by the <code>sysctl</code> service.

<code>/etc/sysctl.conf</code> is a historical location for this kind of configuration and is kept for the same reasons.

<code>/run/sysctl.d</code> holds configuration that is created at run-time by daemons/services or at very early-boot. Neither the distribution nor the packaged software will install configuration to it, primarily because /run is in temporary memory. Configuration in this location that matches names in the local administrator or the locations used by the distribution and packages will cause the latter not to be read and applied by the <code>sysctl</code> service.

===== OpenRC now has a sane ordering of directories when loading kernel modules =====

Loading kernel modules during boot is done with the <code>modules</code> OpenRC service, which reads configuration files in certain locations and loads kernel modules with the modprobe utility from either busybox or util-linux.

Starting with 3.12.0 a more logical ordering is adopted for which configuration files to read and ignore:

# /lib/modules-load.d/*.conf
# /usr/lib/modules-load.d/*.conf
# /etc/modules
# /etc/modules-load.d/*.conf
# /run/modules-load.d/*.conf

<code>/lib/modules-load.d</code> and <code>/usr/lib/modules-load.d</code> are to be used by the distribution and packages. Software installed via our package manager will install to either of those places.

<code>/etc/modules-load.d</code> holds configuration that is created and maintained by the local administrator, neither Alpine nor its packaged software will touch it, and configuration in that has the same name as in the location reserved for the distribution and packages will cause the latter to not be read and applied by the <code>modules</code> service.

<code>/etc/modules</code> is a historical location for this kind of configuration and is kept for the same reasons.

<code>/run/modules-load.d</code> holds configuration that is created at run-time by daemons/services or at very early-boot. Neither the distribution nor the packaged software will install configuration to it, primarily because /run is in temporary memory. Configuration in this location that matches names in the local administrator or the locations used by the distribution and packages will cause the latter not to be read and applied by the <code>modules</code> service.

===== Telegram Desktop is now available in the community repo =====

See [https://git.alpinelinux.org/aports/commit/?id=184355fdc44bc2e12976d65518fe029d8a6e459d commit] that moved the package to the community repo for explanation.

===== efitools and sbsigntool are now in main/ =====

Those packages have lived in testing/ for a long time and have been successfully used by one of our developers to implement secure-boot in his system. They have been moved to main/ and will be available for others.

== abuild ==

===== Add default functions for subpackages that hold Bash, Zsh and Fish completion =====

abuild now provides default functions for $pkgname-bash-completion, $pkgname-zsh-completion and $pkgname-fish-completion subpackages.

Expected location of the completion files per shell:

* Bash -> <code>/usr/share/bash-completion/completions</code>
* Zsh -> <code>/usr/share/zsh/site-functions</code>
* Fish -> <code>/usr/share/fish/completions</code>

Files must be installed in the expected location in relation to '''$pkgdir''' in '''pacakge()'''.

Introduced in [https://gitlab.alpinelinux.org/alpine/abuild/commit/d5826968b713123a4f51d3dec1adb1225d0e194f d5826968b713123a4f51d3dec1adb1225d0e194f].

===== newapkbuild when called with CMake (-C) does out-of-source builds by default =====

When packaging with newapkbuild and using the -C switch to pre-fill the apkbuild with skeleton functions for CMake now:

* Adds <code>-B build</code> to the <code>cmake</code> call in '''build()'''.
* Adds <code>-C build</code> the <code>make</code> calls.

Doing out-of-source builds are recommended upstream to the point where warnings are printed when calling CMake on a project.

Introduced in [https://gitlab.alpinelinux.org/alpine/abuild/commit/e125a764896d884c69cc409e614b65cb336c15e8 e125a764896d884c69cc409e614b65cb336c15e8].

===== set CARGO_HOME to cache dependencies of rust packages =====

CARGO_HOME is now set to '''$SRCDEST/cargo''' and will cache all dependencies downloaded.

Introduced in [https://gitlab.alpinelinux.org/alpine/abuild/commit/af0c88e6abbb1e49224759f5c51b3068e6eab28b af0c88e6abbb1e49224759f5c51b3068e6eab28b].

Release Notes for Alpine 3.12.0

2020-02-19T04:34:12Z

Leo: /* aports */

== aports ==

===== OpenRC now has a sane ordering of directories when configuring kernel parameters =====

Configuring kernel parameters is done by having configuration files in specific locations like <code>/etc/sysctl.conf</code> and files ending with <code>.conf</code> in certain directories like <code>/etc/sysctl.d</code>. Before 3.12.0 the ordering had no logical explanation and
surprised users that expected a hierarchy.

Starting with 3.12.0 the ordering is as follows:

# /lib/sysctl.d/*.conf
# /usr/lib/sysctl.d/*.conf
# /etc/sysctl.d/*.conf
# /etc/sysctl.conf
# /run/sysctl.d/*.conf

<code>/lib/sysctl.d</code> and <code>/usr/lib/sysctl.d</code> are to be used by the distribution and packages. Alpine Linux installs its default configuration file in <code>/lib/sysctl.d/00-alpine.conf</code>. Software installed via our package manager will install to either of those places.

<code>/etc/sysctl.d</code> holds configuration that is created and maintained by the local administrator, neither Alpine nor its packaged software will touch it, and configuration in that has the same name as in the location reserved for the distribution and packages will cause the latter to not be read and applied by the <code>sysctl</code> service.

<code>/etc/sysctl.conf</code> is a historical location for this kind of configuration and is kept for the same reasons.

<code>/run/sysctl.d</code> holds configuration that is created at run-time by daemons/services or at very early-boot. Neither the distribution nor the packaged software will install configuration to it, primarily because /run is in temporary memory. Configuration in this location that matches names in the local administrator or the locations used by the distribution and packages will cause the latter not to be read and applied by the <code>sysctl</code> service.

===== OpenRC now has a sane ordering of directories when loading kernel modules =====

Loading kernel modules during boot is done with the <code>modules</code> OpenRC service, which reads configuration files in certain locations and loads kernel modules with the modprobe utility from either busybox or util-linux.

Starting with 3.12.0 a more logical ordering is adopted for which configuration files to read and ignore:

# /lib/modules-load.d/*.conf
# /usr/lib/modules-load.d/*.conf
# /etc/modules
# /etc/modules-load.d/*.conf
# /run/modules-load.d/*.conf

<code>/lib/modules-load.d</code> and <code>/usr/lib/modules-load.d</code> are to be used by the distribution and packages. Software installed via our package manager will install to either of those places.

<code>/etc/modules-load.d</code> holds configuration that is created and maintained by the local administrator, neither Alpine nor its packaged software will touch it, and configuration in that has the same name as in the location reserved for the distribution and packages will cause the latter to not be read and applied by the <code>modules</code> service.

<code>/etc/modules</code> is a historical location for this kind of configuration and is kept for the same reasons.

<code>/run/modules-load.d</code> holds configuration that is created at run-time by daemons/services or at very early-boot. Neither the distribution nor the packaged software will install configuration to it, primarily because /run is in temporary memory. Configuration in this location that matches names in the local administrator or the locations used by the distribution and packages will cause the latter not to be read and applied by the <code>modules</code> service.

===== Telegram Desktop is now available in the community repo =====

See [https://git.alpinelinux.org/aports/commit/?id=184355fdc44bc2e12976d65518fe029d8a6e459d commit] that moved the package to the community repo for explanation.

===== efitools and sbsigntool are now in main/ =====

Those packages have lived in testing/ for a long time and have been successfully used by one of our developers to implement secure-boot in his system. They have been moved to main/ and will be available for others.

== abuild ==

===== Add default functions for subpackages that hold Bash, Zsh and Fish completion =====

abuild now provides default functions for $pkgname-bash-completion, $pkgname-zsh-completion and $pkgname-fish-completion subpackages.

Expected location of the completion files per shell:

* Bash -> <code>/usr/share/bash-completion/completions</code>
* Zsh -> <code>/usr/share/zsh/site-functions</code>
* Fish -> <code>/usr/share/fish/completions</code>

Files must be installed in the expected location in relation to '''$pkgdir''' in '''pacakge()'''.

Introduced in [https://gitlab.alpinelinux.org/alpine/abuild/commit/d5826968b713123a4f51d3dec1adb1225d0e194f d5826968b713123a4f51d3dec1adb1225d0e194f].

===== newapkbuild when called with CMake (-C) does out-of-source builds by default =====

When packaging with newapkbuild and using the -C switch to pre-fill the apkbuild with skeleton functions for CMake now:

* Adds <code>-B build</code> to the <code>cmake</code> call in '''build()'''.
* Adds <code>-C build</code> the <code>make</code> calls.

Doing out-of-source builds are recommended upstream to the point where warnings are printed when calling CMake on a project.

Introduced in [https://gitlab.alpinelinux.org/alpine/abuild/commit/e125a764896d884c69cc409e614b65cb336c15e8 e125a764896d884c69cc409e614b65cb336c15e8].

===== set CARGO_HOME to cache dependencies of rust packages =====

CARGO_HOME is now set to '''$SRCDEST/cargo''' and will cache all dependencies downloaded.

Introduced in [https://gitlab.alpinelinux.org/alpine/abuild/commit/af0c88e6abbb1e49224759f5c51b3068e6eab28b af0c88e6abbb1e49224759f5c51b3068e6eab28b].

Release Notes for Alpine 3.12.0

2020-02-19T04:33:15Z

Leo: /* aports */

== aports ==

===== OpenRC now has a sane ordering of directories when configuring kernel parameters =====

Configuring kernel parameters is done by having files in specific locations like <code>/etc/sysctl.conf</code> and files ending with <code>.conf</code> in certain directories like <code>/etc/sysctl.d</code>. Before 3.12.0 the ordering had no logical explanation and
surprised users that expected a hierarchy.

Starting with 3.12.0 the ordering is as follows:

# /lib/sysctl.d/*.conf
# /usr/lib/sysctl.d/*.conf
# /etc/sysctl.d/*.conf
# /etc/sysctl.conf
# /run/sysctl.d/*.conf

<code>/lib/sysctl.d</code> and <code>/usr/lib/sysctl.d</code> are to be used by the distribution and packages. Alpine Linux installs its default configuration file in <code>/lib/sysctl.d/00-alpine.conf</code>. Software installed via our package manager will install to either of those places.

<code>/etc/sysctl.d</code> holds configuration that is created and maintained by the local administrator, neither Alpine nor its packaged software will touch it, and configuration in that has the same name as in the location reserved for the distribution and packages will cause the latter to not be read and applied by the <code>sysctl</code> service.

<code>/etc/sysctl.conf</code> is a historical location for this kind of configuration and is kept for the same reasons.

<code>/run/sysctl.d</code> holds configuration that is created at run-time by daemons/services or at very early-boot. Neither the distribution nor the packaged software will install files to it, primarily because /run is in temporary memory. Files in this location that matches names in the local administrator or the locations used by the distribution and packages will cause the latter not to be read and applied by the <code>sysctl</code> service.

===== OpenRC now has a sane ordering of directories when loading kernel modules =====

Loading kernel modules during boot is done with the <code>modules</code> OpenRC service, which reads configuration files in certain locations and loads kernel modules with the modprobe utility from either busybox or util-linux.

Starting with 3.12.0 a more logical ordering is adopted for which files to read and ignore:

# /lib/modules-load.d/*.conf
# /usr/lib/modules-load.d/*.conf
# /etc/modules
# /etc/modules-load.d/*.conf
# /run/modules-load.d/*.conf

<code>/lib/modules-load.d</code> and <code>/usr/lib/modules-load.d</code> are to be used by the distribution and packages. Software installed via our package manager will install to either of those places.

<code>/etc/modules-load.d</code> holds configuration that is created and maintained by the local administrator, neither Alpine nor its packaged software will touch it, and configuration in that has the same name as in the location reserved for the distribution and packages will cause the latter to not be read and applied by the <code>modules</code> service.

<code>/etc/modules</code> is a historical location for this kind of configuration and is kept for the same reasons.

<code>/run/modules-load.d</code> holds configuration that is created at run-time by daemons/services or at very early-boot. Neither the distribution nor the packaged software will install files to it, primarily because /run is in temporary memory. Files in this location that matches names in the local administrator or the locations used by the distribution and packages will cause the latter not to be read and applied by the <code>modules</code> service.

===== Telegram Desktop is now available in the community repo =====

See [https://git.alpinelinux.org/aports/commit/?id=184355fdc44bc2e12976d65518fe029d8a6e459d commit] that moved the package to the community repo for explanation.

===== efitools and sbsigntool are now in main/ =====

Those packages have lived in testing/ for a long time and have been successfully used by one of our developers to implement secure-boot in his system. They have been moved to main/ and will be available for others.

== abuild ==

===== Add default functions for subpackages that hold Bash, Zsh and Fish completion =====

abuild now provides default functions for $pkgname-bash-completion, $pkgname-zsh-completion and $pkgname-fish-completion subpackages.

Expected location of the completion files per shell:

* Bash -> <code>/usr/share/bash-completion/completions</code>
* Zsh -> <code>/usr/share/zsh/site-functions</code>
* Fish -> <code>/usr/share/fish/completions</code>

Files must be installed in the expected location in relation to '''$pkgdir''' in '''pacakge()'''.

Introduced in [https://gitlab.alpinelinux.org/alpine/abuild/commit/d5826968b713123a4f51d3dec1adb1225d0e194f d5826968b713123a4f51d3dec1adb1225d0e194f].

===== newapkbuild when called with CMake (-C) does out-of-source builds by default =====

When packaging with newapkbuild and using the -C switch to pre-fill the apkbuild with skeleton functions for CMake now:

* Adds <code>-B build</code> to the <code>cmake</code> call in '''build()'''.
* Adds <code>-C build</code> the <code>make</code> calls.

Doing out-of-source builds are recommended upstream to the point where warnings are printed when calling CMake on a project.

Introduced in [https://gitlab.alpinelinux.org/alpine/abuild/commit/e125a764896d884c69cc409e614b65cb336c15e8 e125a764896d884c69cc409e614b65cb336c15e8].

===== set CARGO_HOME to cache dependencies of rust packages =====

CARGO_HOME is now set to '''$SRCDEST/cargo''' and will cache all dependencies downloaded.

Introduced in [https://gitlab.alpinelinux.org/alpine/abuild/commit/af0c88e6abbb1e49224759f5c51b3068e6eab28b af0c88e6abbb1e49224759f5c51b3068e6eab28b].

Release Notes for Alpine 3.12.0

2020-02-19T04:32:25Z

Leo: /* OpenRC now has a sane ordering of directories when loading kernel modules */

== aports ==

===== OpenRC now has a sane ordering of directories when configuring kernel parameters =====

Configuring kernel parameters is done by having files in specific locations like <code>/etc/sysctl.conf</code> and files ending with <code>.conf</code> in certain directories like <code>/etc/sysctl.d</code>. Before 3.12.0 the ordering had no logical explanation and
surprised users that expected a hierarchy.

Starting with 3.12.0 the ordering is as follows:

# /lib/sysctl.d/*.conf
# /usr/lib/sysctl.d/*.conf
# /etc/sysctl.d/*.conf
# /etc/sysctl.conf
# /run/sysctl.d/*.conf

<code>/lib/sysctl.d</code> and <code>/usr/lib/sysctl.d</code> are to be used by the distribution and packages. Alpine Linux installs its default configuration file in <code>/lib/sysctl.d/00-alpine.conf</code>. Software installed via our package manager will install to either of those places.

<code>/etc/sysctl.d</code> holds configuration that is created and maintained by the local administrator, neither Alpine nor its packaged software will touch it, and configuration in that has the same name as in the location reserved for the distribution and packages will cause the latter to not be read and applied by the <code>sysctl</code> service.

<code>/etc/sysctl.conf</code> is a historical location for this kind of configuration and is kept for the same reasons.

<code>/run/sysctl.d</code> holds configuration that is created at run-time by daemons/services or at very early-boot. Neither the distribution nor the packaged software will install files to it, primarily because /run is in temporary memory. Files in this location that matches names in the local administrator or the locations used by the distribution and packages will cause the latter not to be read and applied by the <code>sysctl</code> service.

===== OpenRC now has a sane ordering of directories when loading kernel modules =====

Loading kernel modules during boot is done with the <code>modules</code> OpenRC service, which reads configuration files in certain locations and loads kernel modules with the modprobe utility from either busybox or util-linux.

Starting with 3.12.0 a more logical ordering is adopted for which files to read and ignore:

# /lib/modules-load.d/*.conf
# /usr/lib/modules-load.d/*.conf
# /etc/modules
# /etc/modules-load.d/*.conf
# /run/modules-load.d/*.conf

===== Telegram Desktop is now available in the community repo =====

See [https://git.alpinelinux.org/aports/commit/?id=184355fdc44bc2e12976d65518fe029d8a6e459d commit] that moved the package to the community repo for explanation.

===== efitools and sbsigntool are now in main/ =====

Those packages have lived in testing/ for a long time and have been successfully used by one of our developers to implement secure-boot in his system. They have been moved to main/ and will be available for others.

== abuild ==

===== Add default functions for subpackages that hold Bash, Zsh and Fish completion =====

abuild now provides default functions for $pkgname-bash-completion, $pkgname-zsh-completion and $pkgname-fish-completion subpackages.

Expected location of the completion files per shell:

* Bash -> <code>/usr/share/bash-completion/completions</code>
* Zsh -> <code>/usr/share/zsh/site-functions</code>
* Fish -> <code>/usr/share/fish/completions</code>

Files must be installed in the expected location in relation to '''$pkgdir''' in '''pacakge()'''.

Introduced in [https://gitlab.alpinelinux.org/alpine/abuild/commit/d5826968b713123a4f51d3dec1adb1225d0e194f d5826968b713123a4f51d3dec1adb1225d0e194f].

===== newapkbuild when called with CMake (-C) does out-of-source builds by default =====

When packaging with newapkbuild and using the -C switch to pre-fill the apkbuild with skeleton functions for CMake now:

* Adds <code>-B build</code> to the <code>cmake</code> call in '''build()'''.
* Adds <code>-C build</code> the <code>make</code> calls.

Doing out-of-source builds are recommended upstream to the point where warnings are printed when calling CMake on a project.

Introduced in [https://gitlab.alpinelinux.org/alpine/abuild/commit/e125a764896d884c69cc409e614b65cb336c15e8 e125a764896d884c69cc409e614b65cb336c15e8].

===== set CARGO_HOME to cache dependencies of rust packages =====

CARGO_HOME is now set to '''$SRCDEST/cargo''' and will cache all dependencies downloaded.

Introduced in [https://gitlab.alpinelinux.org/alpine/abuild/commit/af0c88e6abbb1e49224759f5c51b3068e6eab28b af0c88e6abbb1e49224759f5c51b3068e6eab28b].

Release Notes for Alpine 3.12.0

2020-02-19T04:31:24Z

Leo: /* OpenRC now has a sane ordering of directories when configuring kernel parameters */

== aports ==

===== OpenRC now has a sane ordering of directories when configuring kernel parameters =====

Configuring kernel parameters is done by having files in specific locations like <code>/etc/sysctl.conf</code> and files ending with <code>.conf</code> in certain directories like <code>/etc/sysctl.d</code>. Before 3.12.0 the ordering had no logical explanation and
surprised users that expected a hierarchy.

Starting with 3.12.0 the ordering is as follows:

# /lib/sysctl.d/*.conf
# /usr/lib/sysctl.d/*.conf
# /etc/sysctl.d/*.conf
# /etc/sysctl.conf
# /run/sysctl.d/*.conf

<code>/lib/sysctl.d</code> and <code>/usr/lib/sysctl.d</code> are to be used by the distribution and packages. Alpine Linux installs its default configuration file in <code>/lib/sysctl.d/00-alpine.conf</code>. Software installed via our package manager will install to either of those places.

<code>/etc/sysctl.d</code> holds configuration that is created and maintained by the local administrator, neither Alpine nor its packaged software will touch it, and configuration in that has the same name as in the location reserved for the distribution and packages will cause the latter to not be read and applied by the <code>sysctl</code> service.

<code>/etc/sysctl.conf</code> is a historical location for this kind of configuration and is kept for the same reasons.

<code>/run/sysctl.d</code> holds configuration that is created at run-time by daemons/services or at very early-boot. Neither the distribution nor the packaged software will install files to it, primarily because /run is in temporary memory. Files in this location that matches names in the local administrator or the locations used by the distribution and packages will cause the latter not to be read and applied by the <code>sysctl</code> service.

===== OpenRC now has a sane ordering of directories when loading kernel modules =====

Loading kernel modules during boot is done with the modules OpenRC service, which reads configuration files in certain locations and loads kernel modules with the modprobe utility from either busybox or util-linux.

Before the changes the files were loading in the following order, files in modules-load.d directories were decided by how the shell picked it by globbing.

# /etc/modules
# /etc/modules-load.d/*.conf
# /run/modules-load.d/*.conf
# /usr/lib/modules-load.d/*.conf
# /lib/modules-load.d/*.conf

That means the changes that were done in /etc/modules or /etc/modules-load.d by the local administrator ended up being overridden by modules installed by packages in /usr/lib/modules-load.d and /lib/modules-load.d.

With the changes to the '''modules''' service the new ordering of directories is:

# /lib/modules-load.d/*.conf
# /usr/lib/modules-load.d/*.conf
# /etc/modules
# /etc/modules-load.d/*.conf
# /run/modules-load.d/*.conf

Now admins can override files installed by packages (/lib/modules-load.d and /usr/lib/modules-load.d) by having files with the same name in /etc/modules-load.d, and both can be overridden by files in /run/modules-load.d.

{{Note|/etc/modules cannot be overridden and only exists because of historical precedent.}}

===== Telegram Desktop is now available in the community repo =====

See [https://git.alpinelinux.org/aports/commit/?id=184355fdc44bc2e12976d65518fe029d8a6e459d commit] that moved the package to the community repo for explanation.

===== efitools and sbsigntool are now in main/ =====

Those packages have lived in testing/ for a long time and have been successfully used by one of our developers to implement secure-boot in his system. They have been moved to main/ and will be available for others.

== abuild ==

===== Add default functions for subpackages that hold Bash, Zsh and Fish completion =====

abuild now provides default functions for $pkgname-bash-completion, $pkgname-zsh-completion and $pkgname-fish-completion subpackages.

Expected location of the completion files per shell:

* Bash -> <code>/usr/share/bash-completion/completions</code>
* Zsh -> <code>/usr/share/zsh/site-functions</code>
* Fish -> <code>/usr/share/fish/completions</code>

Files must be installed in the expected location in relation to '''$pkgdir''' in '''pacakge()'''.

Introduced in [https://gitlab.alpinelinux.org/alpine/abuild/commit/d5826968b713123a4f51d3dec1adb1225d0e194f d5826968b713123a4f51d3dec1adb1225d0e194f].

===== newapkbuild when called with CMake (-C) does out-of-source builds by default =====

When packaging with newapkbuild and using the -C switch to pre-fill the apkbuild with skeleton functions for CMake now:

* Adds <code>-B build</code> to the <code>cmake</code> call in '''build()'''.
* Adds <code>-C build</code> the <code>make</code> calls.

Doing out-of-source builds are recommended upstream to the point where warnings are printed when calling CMake on a project.

Introduced in [https://gitlab.alpinelinux.org/alpine/abuild/commit/e125a764896d884c69cc409e614b65cb336c15e8 e125a764896d884c69cc409e614b65cb336c15e8].

===== set CARGO_HOME to cache dependencies of rust packages =====

CARGO_HOME is now set to '''$SRCDEST/cargo''' and will cache all dependencies downloaded.

Introduced in [https://gitlab.alpinelinux.org/alpine/abuild/commit/af0c88e6abbb1e49224759f5c51b3068e6eab28b af0c88e6abbb1e49224759f5c51b3068e6eab28b].

Release Notes for Alpine 3.12.0

2020-02-18T18:49:20Z

Leo: /* aports */

== aports ==

===== OpenRC now has a sane ordering of directories when configuring kernel parameters =====

Configuring kernel parameters is done by having files in specific locations like <code>/etc/sysctl.conf</code> and files ending with <code>.conf</code> in certain directories like <code>/etc/sysctl.d</code>. Before 3.12.0 the ordering had no logical explanation and
supervised users that expected a hierarchy.

Starting with 3.12.0 the ordering is as such:

# /lib/sysctl.d/*.conf
# /usr/lib/sysctl.d/*.conf
# /etc/sysctl.d/*.conf
# /etc/sysctl.conf
# /run/sysctl.d/*.conf

Packages and Alpine Linux will install to <code>/lib/sysctl.d</code> and <code>/usr/lib/sysctl.d</code>, those can be overridden by the local administrator by placing the files in <code>/etc/sysctl.d</code>, if a filename from <code>/etc/sysctl.d</code> matches a filename from <code>/lib/sysctl.d</code> or <code>/usr/lib/sysctl.d</code> then the file in the latter will not be run.

The same logic applies for <code>run/sysctl.d</code>, meant for runtime configuration, which will override all locations mentioned above.

{{Note|/etc/sysctl.conf cannot be overridden and exists because of historical precedent}}

===== OpenRC now has a sane ordering of directories when loading kernel modules =====

Loading kernel modules during boot is done with the modules OpenRC service, which reads configuration files in certain locations and loads kernel modules with the modprobe utility from either busybox or util-linux.

Before the changes the files were loading in the following order, files in modules-load.d directories were decided by how the shell picked it by globbing.

# /etc/modules
# /etc/modules-load.d/*.conf
# /run/modules-load.d/*.conf
# /usr/lib/modules-load.d/*.conf
# /lib/modules-load.d/*.conf

That means the changes that were done in /etc/modules or /etc/modules-load.d by the local administrator ended up being overridden by modules installed by packages in /usr/lib/modules-load.d and /lib/modules-load.d.

With the changes to the '''modules''' service the new ordering of directories is:

# /lib/modules-load.d/*.conf
# /usr/lib/modules-load.d/*.conf
# /etc/modules
# /etc/modules-load.d/*.conf
# /run/modules-load.d/*.conf

Now admins can override files installed by packages (/lib/modules-load.d and /usr/lib/modules-load.d) by having files with the same name in /etc/modules-load.d, and both can be overridden by files in /run/modules-load.d.

{{Note|/etc/modules cannot be overridden and only exists because of historical precedent.}}

===== Telegram Desktop is now available in the community repo =====

See [https://git.alpinelinux.org/aports/commit/?id=184355fdc44bc2e12976d65518fe029d8a6e459d commit] that moved the package to the community repo for explanation.

===== efitools and sbsigntool are now in main/ =====

Those packages have lived in testing/ for a long time and have been successfully used by one of our developers to implement secure-boot in his system. They have been moved to main/ and will be available for others.

== abuild ==

===== Add default functions for subpackages that hold Bash, Zsh and Fish completion =====

abuild now provides default functions for $pkgname-bash-completion, $pkgname-zsh-completion and $pkgname-fish-completion subpackages.

Expected location of the completion files per shell:

* Bash -> <code>/usr/share/bash-completion/completions</code>
* Zsh -> <code>/usr/share/zsh/site-functions</code>
* Fish -> <code>/usr/share/fish/completions</code>

Files must be installed in the expected location in relation to '''$pkgdir''' in '''pacakge()'''.

Introduced in [https://gitlab.alpinelinux.org/alpine/abuild/commit/d5826968b713123a4f51d3dec1adb1225d0e194f d5826968b713123a4f51d3dec1adb1225d0e194f].

===== newapkbuild when called with CMake (-C) does out-of-source builds by default =====

When packaging with newapkbuild and using the -C switch to pre-fill the apkbuild with skeleton functions for CMake now:

* Adds <code>-B build</code> to the <code>cmake</code> call in '''build()'''.
* Adds <code>-C build</code> the <code>make</code> calls.

Doing out-of-source builds are recommended upstream to the point where warnings are printed when calling CMake on a project.

Introduced in [https://gitlab.alpinelinux.org/alpine/abuild/commit/e125a764896d884c69cc409e614b65cb336c15e8 e125a764896d884c69cc409e614b65cb336c15e8].

===== set CARGO_HOME to cache dependencies of rust packages =====

CARGO_HOME is now set to '''$SRCDEST/cargo''' and will cache all dependencies downloaded.

Introduced in [https://gitlab.alpinelinux.org/alpine/abuild/commit/af0c88e6abbb1e49224759f5c51b3068e6eab28b af0c88e6abbb1e49224759f5c51b3068e6eab28b].

Release Notes for Alpine 3.12.0

2020-02-17T10:18:20Z

Leo: /* OpenRC now has a sane ordering of directories when loading kernel modules */

== aports ==

===== OpenRC now has a sane ordering of directories when loading kernel modules =====

Loading kernel modules during boot is done with the modules OpenRC service, which reads configuration files in certain locations and loads kernel modules with the modprobe utility from either busybox or util-linux.

Before the changes the files were loading in the following order, files in modules-load.d directories were decided by how the shell picked it by globbing.

# /etc/modules
# /etc/modules-load.d/*.conf
# /run/modules-load.d/*.conf
# /usr/lib/modules-load.d/*.conf
# /lib/modules-load.d/*.conf

That means the changes that were done in /etc/modules or /etc/modules-load.d by the local administrator ended up being overridden by modules installed by packages in /usr/lib/modules-load.d and /lib/modules-load.d.

With the changes to the '''modules''' service the new ordering of directories is:

# /lib/modules-load.d/*.conf
# /usr/lib/modules-load.d/*.conf
# /etc/modules
# /etc/modules-load.d/*.conf
# /run/modules-load.d/*.conf

Now admins can override files installed by packages (/lib/modules-load.d and /usr/lib/modules-load.d) by having files with the same name in /etc/modules-load.d, and both can be overridden by files in /run/modules-load.d.

{{Note|/etc/modules cannot be overridden and only exists because of historical precedent.}}

===== Telegram Desktop is now available in the community repo =====

See [https://git.alpinelinux.org/aports/commit/?id=184355fdc44bc2e12976d65518fe029d8a6e459d commit] that moved the package to the community repo for explanation.

===== efitools and sbsigntool are now in main/ =====

Those packages have lived in testing/ for a long time and have been successfully used by one of our developers to implement secure-boot in his system. They have been moved to main/ and will be available for others.

== abuild ==

===== Add default functions for subpackages that hold Bash, Zsh and Fish completion =====

abuild now provides default functions for $pkgname-bash-completion, $pkgname-zsh-completion and $pkgname-fish-completion subpackages.

Expected location of the completion files per shell:

* Bash -> <code>/usr/share/bash-completion/completions</code>
* Zsh -> <code>/usr/share/zsh/site-functions</code>
* Fish -> <code>/usr/share/fish/completions</code>

Files must be installed in the expected location in relation to '''$pkgdir''' in '''pacakge()'''.

Introduced in [https://gitlab.alpinelinux.org/alpine/abuild/commit/d5826968b713123a4f51d3dec1adb1225d0e194f d5826968b713123a4f51d3dec1adb1225d0e194f].

===== newapkbuild when called with CMake (-C) does out-of-source builds by default =====

When packaging with newapkbuild and using the -C switch to pre-fill the apkbuild with skeleton functions for CMake now:

* Adds <code>-B build</code> to the <code>cmake</code> call in '''build()'''.
* Adds <code>-C build</code> the <code>make</code> calls.

Doing out-of-source builds are recommended upstream to the point where warnings are printed when calling CMake on a project.

Introduced in [https://gitlab.alpinelinux.org/alpine/abuild/commit/e125a764896d884c69cc409e614b65cb336c15e8 e125a764896d884c69cc409e614b65cb336c15e8].

===== set CARGO_HOME to cache dependencies of rust packages =====

CARGO_HOME is now set to '''$SRCDEST/cargo''' and will cache all dependencies downloaded.

Introduced in [https://gitlab.alpinelinux.org/alpine/abuild/commit/af0c88e6abbb1e49224759f5c51b3068e6eab28b af0c88e6abbb1e49224759f5c51b3068e6eab28b].

Release Notes for Alpine 3.12.0

2020-02-17T04:55:49Z

Leo: /* abuild */

== aports ==

===== OpenRC now has a sane ordering of directories when loading kernel modules =====

Loading kernel modules during boot is done with the modules OpenRC service, which reads configuration files in certain locations and loads kernel modules with the modprobe utility from either busybox or util-linux.

Before the changes the files were loading in the following order, files in modules-load.d directories were decided by how the shell picked it by globbing.

# /etc/modules
# /etc/modules-load.d/*.conf
# /run/modules-load.d/*.conf
# /usr/lib/modules-load.d/*.conf
# /lib/modules-load.d/*.conf

That means the changes that were done in /etc/modules or /etc/modules-load.d by the local administrator ended up being overridden by modules installed by packages in /usr/lib/modules-load.d and /lib/modules-load.d.

With the changes to the '''modules''' service the new ordering of directories is:

# /lib/modules-load.d/*.conf
# /usr/lib/modules-load.d/*.conf
# /etc/modules
# /etc/modules-load.d/*.conf
# /run/modules-load.d/*.conf

Now admins can override files installed by packages (/lib/modules-load.d and /usr/lib/modules-load.d) by having files with the same name in /etc/modules-load.d, and both can be overridden by files in /run/modules-load.d.

Note that /etc/modules cannot be overridden and only exists because of historical precedent.

===== Telegram Desktop is now available in the community repo =====

See [https://git.alpinelinux.org/aports/commit/?id=184355fdc44bc2e12976d65518fe029d8a6e459d commit] that moved the package to the community repo for explanation.

===== efitools and sbsigntool are now in main/ =====

Those packages have lived in testing/ for a long time and have been successfully used by one of our developers to implement secure-boot in his system. They have been moved to main/ and will be available for others.

== abuild ==

===== Add default functions for subpackages that hold Bash, Zsh and Fish completion =====

abuild now provides default functions for $pkgname-bash-completion, $pkgname-zsh-completion and $pkgname-fish-completion subpackages.

Expected location of the completion files per shell:

* Bash -> <code>/usr/share/bash-completion/completions</code>
* Zsh -> <code>/usr/share/zsh/site-functions</code>
* Fish -> <code>/usr/share/fish/completions</code>

Files must be installed in the expected location in relation to '''$pkgdir''' in '''pacakge()'''.

Introduced in [https://gitlab.alpinelinux.org/alpine/abuild/commit/d5826968b713123a4f51d3dec1adb1225d0e194f d5826968b713123a4f51d3dec1adb1225d0e194f].

===== newapkbuild when called with CMake (-C) does out-of-source builds by default =====

When packaging with newapkbuild and using the -C switch to pre-fill the apkbuild with skeleton functions for CMake now:

* Adds <code>-B build</code> to the <code>cmake</code> call in '''build()'''.
* Adds <code>-C build</code> the <code>make</code> calls.

Doing out-of-source builds are recommended upstream to the point where warnings are printed when calling CMake on a project.

Introduced in [https://gitlab.alpinelinux.org/alpine/abuild/commit/e125a764896d884c69cc409e614b65cb336c15e8 e125a764896d884c69cc409e614b65cb336c15e8].

===== set CARGO_HOME to cache dependencies of rust packages =====

CARGO_HOME is now set to '''$SRCDEST/cargo''' and will cache all dependencies downloaded.

Introduced in [https://gitlab.alpinelinux.org/alpine/abuild/commit/af0c88e6abbb1e49224759f5c51b3068e6eab28b af0c88e6abbb1e49224759f5c51b3068e6eab28b].

Release Notes for Alpine 3.12.0

2020-02-17T04:52:02Z

Leo: /* abuild */

== aports ==

===== OpenRC now has a sane ordering of directories when loading kernel modules =====

Loading kernel modules during boot is done with the modules OpenRC service, which reads configuration files in certain locations and loads kernel modules with the modprobe utility from either busybox or util-linux.

Before the changes the files were loading in the following order, files in modules-load.d directories were decided by how the shell picked it by globbing.

# /etc/modules
# /etc/modules-load.d/*.conf
# /run/modules-load.d/*.conf
# /usr/lib/modules-load.d/*.conf
# /lib/modules-load.d/*.conf

That means the changes that were done in /etc/modules or /etc/modules-load.d by the local administrator ended up being overridden by modules installed by packages in /usr/lib/modules-load.d and /lib/modules-load.d.

With the changes to the '''modules''' service the new ordering of directories is:

# /lib/modules-load.d/*.conf
# /usr/lib/modules-load.d/*.conf
# /etc/modules
# /etc/modules-load.d/*.conf
# /run/modules-load.d/*.conf

Now admins can override files installed by packages (/lib/modules-load.d and /usr/lib/modules-load.d) by having files with the same name in /etc/modules-load.d, and both can be overridden by files in /run/modules-load.d.

Note that /etc/modules cannot be overridden and only exists because of historical precedent.

===== Telegram Desktop is now available in the community repo =====

See [https://git.alpinelinux.org/aports/commit/?id=184355fdc44bc2e12976d65518fe029d8a6e459d commit] that moved the package to the community repo for explanation.

===== efitools and sbsigntool are now in main/ =====

Those packages have lived in testing/ for a long time and have been successfully used by one of our developers to implement secure-boot in his system. They have been moved to main/ and will be available for others.

== abuild ==

===== Add default functions for subpackages that hold Bash, Zsh and Fish completion =====

abuild now provides default functions for $pkgname-bash-completion, $pkgname-zsh-completion and $pkgname-fish-completion subpackages.

Expected location of the completion files per shell:

* Bash -> <code>/usr/share/bash-completion/completions</code>
* Zsh -> <code>/usr/share/zsh/site-functions</code>
* Fish -> <code>/usr/share/fish/completions</code>

Files must be installed in the expected location in relation to '''$pkgdir''' in '''pacakge()'''.

Introduced in [https://gitlab.alpinelinux.org/alpine/abuild/commit/d5826968b713123a4f51d3dec1adb1225d0e194f d5826968b713123a4f51d3dec1adb1225d0e194f].

===== newapkbuild when called with CMake (-C) does out-of-source builds by default =====

When packaging with newapkbuild and using the -C switch to pre-fill the apkbuild with skeleton functions for CMake now:

* Adds <code>-B build</code> to the <code>cmake</code> call in '''build()'''.
* Adds <code>-C build</code> the <code>make</code> calls.

Doing out-of-source builds are recommended upstream to the point where warnings are printed when calling CMake on a project.

Introduced in [https://gitlab.alpinelinux.org/alpine/abuild/commit/e125a764896d884c69cc409e614b65cb336c15e8 e125a764896d884c69cc409e614b65cb336c15e8].

Release Notes for Alpine 3.12.0

2020-02-17T04:49:31Z

Leo: /* abuild */

== aports ==

===== OpenRC now has a sane ordering of directories when loading kernel modules =====

Loading kernel modules during boot is done with the modules OpenRC service, which reads configuration files in certain locations and loads kernel modules with the modprobe utility from either busybox or util-linux.

Before the changes the files were loading in the following order, files in modules-load.d directories were decided by how the shell picked it by globbing.

# /etc/modules
# /etc/modules-load.d/*.conf
# /run/modules-load.d/*.conf
# /usr/lib/modules-load.d/*.conf
# /lib/modules-load.d/*.conf

That means the changes that were done in /etc/modules or /etc/modules-load.d by the local administrator ended up being overridden by modules installed by packages in /usr/lib/modules-load.d and /lib/modules-load.d.

With the changes to the '''modules''' service the new ordering of directories is:

# /lib/modules-load.d/*.conf
# /usr/lib/modules-load.d/*.conf
# /etc/modules
# /etc/modules-load.d/*.conf
# /run/modules-load.d/*.conf

Now admins can override files installed by packages (/lib/modules-load.d and /usr/lib/modules-load.d) by having files with the same name in /etc/modules-load.d, and both can be overridden by files in /run/modules-load.d.

Note that /etc/modules cannot be overridden and only exists because of historical precedent.

===== Telegram Desktop is now available in the community repo =====

See [https://git.alpinelinux.org/aports/commit/?id=184355fdc44bc2e12976d65518fe029d8a6e459d commit] that moved the package to the community repo for explanation.

===== efitools and sbsigntool are now in main/ =====

Those packages have lived in testing/ for a long time and have been successfully used by one of our developers to implement secure-boot in his system. They have been moved to main/ and will be available for others.

== abuild ==

===== Add default functions for subpackages that hold Bash, Zsh and Fish completion =====

abuild now provides default functions for $pkgname-bash-completion, $pkgname-zsh-completion and $pkgname-fish-completion subpackages.

Expected location of the completion files per shell:

* Bash -> <code>/usr/share/bash-completion/completions</code>
* Zsh -> <code>/usr/share/zsh/site-functions</code>
* Fish -> <code>/usr/share/fish/completions</code>

Files must be installed in the expected location in relation to '''$pkgdir''' in '''pacakge()'''.

Introduced in [https://gitlab.alpinelinux.org/alpine/abuild/commit/d5826968b713123a4f51d3dec1adb1225d0e194f d5826968b713123a4f51d3dec1adb1225d0e194f].

===== newapkbuild when called with CMake (-C) does out-of-source builds by default =====

When packaging with newapkbuild and using the -C switch to pre-fill the apkbuild with skeleton functions for CMake now adds <code>-B build</code> to the <code>cmake</code> call in '''build()'''. It also adds <code>-C build</code> the <code>make</code> calls.

Introduced in [https://gitlab.alpinelinux.org/alpine/abuild/commit/e125a764896d884c69cc409e614b65cb336c15e8 e125a764896d884c69cc409e614b65cb336c15e8].

Release Notes for Alpine 3.12.0

2020-02-17T04:35:14Z

Leo: /* aports */

Release Notes for Alpine 3.12.0

2020-02-17T04:35:01Z

Leo:

== aports ==

Changes related to aports, where you will find most packages.

===== OpenRC now has a sane ordering of directories when loading kernel modules =====

Loading kernel modules during boot is done with the modules OpenRC service, which reads configuration files in certain locations and loads kernel modules with the modprobe utility from either busybox or util-linux.

Before the changes the files were loading in the following order, files in modules-load.d directories were decided by how the shell picked it by globbing.

# /etc/modules
# /etc/modules-load.d/*.conf
# /run/modules-load.d/*.conf
# /usr/lib/modules-load.d/*.conf
# /lib/modules-load.d/*.conf

That means the changes that were done in /etc/modules or /etc/modules-load.d by the local administrator ended up being overridden by modules installed by packages in /usr/lib/modules-load.d and /lib/modules-load.d.

With the changes to the '''modules''' service the new ordering of directories is:

# /lib/modules-load.d/*.conf
# /usr/lib/modules-load.d/*.conf
# /etc/modules
# /etc/modules-load.d/*.conf
# /run/modules-load.d/*.conf

Now admins can override files installed by packages (/lib/modules-load.d and /usr/lib/modules-load.d) by having files with the same name in /etc/modules-load.d, and both can be overridden by files in /run/modules-load.d.

Note that /etc/modules cannot be overridden and only exists because of historical precedent.

===== Telegram Desktop is now available in the community repo =====

See [https://git.alpinelinux.org/aports/commit/?id=184355fdc44bc2e12976d65518fe029d8a6e459d commit] that moved the package to the community repo for explanation.

===== efitools and sbsigntool are now in main/ =====

Those packages have lived in testing/ for a long time and have been successfully used by one of our developers to implement secure-boot in his system. They have been moved to main/ and will be available for others.

== abuild ==

Changes related to Alpine Linux's package builder.

Release Notes for Alpine 3.12.0

2020-02-17T04:34:38Z

Leo: /* Notable changes */

== Notable changes ==

=== aports ===

Changes related to aports, where you will find most packages.

===== OpenRC now has a sane ordering of directories when loading kernel modules =====

Loading kernel modules during boot is done with the modules OpenRC service, which reads configuration files in certain locations and loads kernel modules with the modprobe utility from either busybox or util-linux.

Before the changes the files were loading in the following order, files in modules-load.d directories were decided by how the shell picked it by globbing.

# /etc/modules
# /etc/modules-load.d/*.conf
# /run/modules-load.d/*.conf
# /usr/lib/modules-load.d/*.conf
# /lib/modules-load.d/*.conf

That means the changes that were done in /etc/modules or /etc/modules-load.d by the local administrator ended up being overridden by modules installed by packages in /usr/lib/modules-load.d and /lib/modules-load.d.

With the changes to the '''modules''' service the new ordering of directories is:

# /lib/modules-load.d/*.conf
# /usr/lib/modules-load.d/*.conf
# /etc/modules
# /etc/modules-load.d/*.conf
# /run/modules-load.d/*.conf

Now admins can override files installed by packages (/lib/modules-load.d and /usr/lib/modules-load.d) by having files with the same name in /etc/modules-load.d, and both can be overridden by files in /run/modules-load.d.

Note that /etc/modules cannot be overridden and only exists because of historical precedent.

===== Telegram Desktop is now available in the community repo =====

See [https://git.alpinelinux.org/aports/commit/?id=184355fdc44bc2e12976d65518fe029d8a6e459d commit] that moved the package to the community repo for explanation.

===== efitools and sbsigntool are now in main/ =====

Those packages have lived in testing/ for a long time and have been successfully used by one of our developers to implement secure-boot in his system. They have been moved to main/ and will be available for others.

=== abuild ===

Changes related to Alpine Linux's package builder.

Release Notes for Alpine 3.12.0

2020-02-17T04:34:03Z

Leo: /* Notable changes */

=== Notable changes ===

==== aports ====

Changes related to aports, where you will find most packages.

===== OpenRC now has a sane ordering of directories when loading kernel modules =====

Loading kernel modules during boot is done with the modules OpenRC service, which reads configuration files in certain locations and loads kernel modules with the modprobe utility from either busybox or util-linux.

Before the changes the files were loading in the following order, files in modules-load.d directories were decided by how the shell picked it by globbing.

# /etc/modules
# /etc/modules-load.d/*.conf
# /run/modules-load.d/*.conf
# /usr/lib/modules-load.d/*.conf
# /lib/modules-load.d/*.conf

That means the changes that were done in /etc/modules or /etc/modules-load.d by the local administrator ended up being overridden by modules installed by packages in /usr/lib/modules-load.d and /lib/modules-load.d.

With the changes to the '''modules''' service the new ordering of directories is:

# /lib/modules-load.d/*.conf
# /usr/lib/modules-load.d/*.conf
# /etc/modules
# /etc/modules-load.d/*.conf
# /run/modules-load.d/*.conf

Now admins can override files installed by packages (/lib/modules-load.d and /usr/lib/modules-load.d) by having files with the same name in /etc/modules-load.d, and both can be overridden by files in /run/modules-load.d.

Note that /etc/modules cannot be overridden and only exists because of historical precedent.

===== Telegram Desktop is now available in the community repo =====

See [https://git.alpinelinux.org/aports/commit/?id=184355fdc44bc2e12976d65518fe029d8a6e459d commit] that moved the package to the community repo for explanation.

===== efitools and sbsigntool are now in main/ =====

Those packages have lived in testing/ for a long time and have been successfully used by one of our developers to implement secure-boot in his system. They have been moved to main/ and will be available for others.

==== abuild ====

Changes related to Alpine Linux's package builder.

Release Notes for Alpine 3.12.0

2020-02-17T04:33:37Z

Leo: /* Notable changes */

Release Notes for Alpine 3.12.0

2020-02-16T20:06:47Z

Leo: /* Notable changes */

=== Notable changes ===

==== OpenRC now has a sane ordering of directories when loading kernel modules ====

Loading kernel modules during boot is done with the modules OpenRC service, which reads configuration files in certain locations and loads kernel modules with the modprobe utility from either busybox or util-linux.

Before the changes the files were loading in the following order, files in modules-load.d directories were decided by how the shell picked it by globbing.

# /etc/modules
# /etc/modules-load.d/*.conf
# /run/modules-load.d/*.conf
# /usr/lib/modules-load.d/*.conf
# /lib/modules-load.d/*.conf

That means the changes that were done in /etc/modules or /etc/modules-load.d by the local administrator ended up being overridden by modules installed by packages in /usr/lib/modules-load.d and /lib/modules-load.d.

With the changes to the '''modules''' service the new ordering of directories is:

# /lib/modules-load.d/*.conf
# /usr/lib/modules-load.d/*.conf
# /etc/modules
# /etc/modules-load.d/*.conf
# /run/modules-load.d/*.conf

Now admins can override files installed by packages (/lib/modules-load.d and /usr/lib/modules-load.d) by having files with the same name in /etc/modules-load.d, and both can be overridden by files in /run/modules-load.d.

Note that /etc/modules cannot be overridden and only exists because of historical precedent.

==== Telegram Desktop is now available in the community repo ====

See [https://git.alpinelinux.org/aports/commit/?id=184355fdc44bc2e12976d65518fe029d8a6e459d commit] that moved the package to the community repo for explanation.

==== efitools and sbsigntool are now in main/ ====

Those packages have lived in testing/ for a long time and have been successfully used by one of our developers to implement secure-boot in his system. They have been moved to main/ and will be available for others.

Release Notes for Alpine 3.12.0

2020-02-14T15:10:55Z

Leo: /* Telegram Desktop is now available in the community repo */

Release Notes for Alpine 3.12.0

2020-02-14T03:56:19Z

Leo: /* Notable changes */

=== Notable changes ===

==== OpenRC now has a sane ordering of directories when loading kernel modules ====

Loading kernel modules during boot is done with the modules OpenRC service, which reads configuration files in certain locations and loads kernel modules with the modprobe utility from either busybox or util-linux.

Before the changes the files were loading in the following order, files in modules-load.d directories were decided by how the shell picked it by globbing.

# /etc/modules
# /etc/modules-load.d/*.conf
# /run/modules-load.d/*.conf
# /usr/lib/modules-load.d/*.conf
# /lib/modules-load.d/*.conf

That means the changes that were done in /etc/modules or /etc/modules-load.d by the local administrator ended up being overridden by modules installed by packages in /usr/lib/modules-load.d and /lib/modules-load.d.

With the changes to the '''modules''' service the new ordering of directories is:

# /lib/modules-load.d/*.conf
# /usr/lib/modules-load.d/*.conf
# /etc/modules
# /etc/modules-load.d/*.conf
# /run/modules-load.d/*.conf

Now admins can override files installed by packages (/lib/modules-load.d and /usr/lib/modules-load.d) by having files with the same name in /etc/modules-load.d, and both can be overridden by files in /run/modules-load.d.

Note that /etc/modules cannot be overridden and only exists because of historical precedent.

==== Telegram Desktop is now available in the community repo ====

See the commit (TODO: add commit when merged) for explanation.

Release Notes for Alpine 3.12.0

2020-02-14T03:46:20Z

Leo: /* OpenRC now respect ordering of directories when loading modules */

Release Notes for Alpine 3.12.0

2020-02-14T03:45:07Z

Leo: Created page with "=== Notable changes === ==== OpenRC now respect ordering of directories when loading modules ==== Loading kernel modules during boot is done with the modules OpenRC service,..."

=== Notable changes ===

==== OpenRC now respect ordering of directories when loading modules ====

Loading kernel modules during boot is done with the modules OpenRC service, which reads configuration files in certain locations and loads kernel modules with the modprobe utility from either busybox or util-linux.

Before the changes the files were loading in the following order, files in modules-load.d directories were decided by how the shell picked it by globbing.

# /etc/modules
# /etc/modules-load.d/*.conf
# /run/modules-load.d/*.conf
# /usr/lib/modules-load.d/*.conf
# /lib/modules-load.d/*.conf

That means the changes that were done in /etc/modules or /etc/modules-load.d by the local administrator ended up being overridden by modules installed by packages in /usr/lib/modules-load.d and /lib/modules-load.d.

With the changes to the '''modules''' service the new ordering of directories is:

# /lib/modules-load.d/*.conf
# /usr/lib/modules-load.d/*.conf
# /etc/modules
# /etc/modules-load.d/*.conf
# /run/modules-load.d/*.conf

Now admins can override files installed by packages (/lib/modules-load.d and /usr/lib/modules-load.d) by having files with the same name in /etc/modules-load.d, and both can be overridden by files in /run/modules-load.d.

Note that /etc/modules cannot be overridden and only exists because of historical precedent.

Setting up a OpenVPN server

2020-02-12T11:10:39Z

Leo:

{{TOC right}}

This article describes how to set up an OpenVPN server with the Alpine Linux.
This is an ideal solution for allowing single users or devices to remotely connect to your network. To establish connectivity with a Remote Office or site, [http://wiki.alpinelinux.org/w/index.php?title=Using_Racoon_for_Remote_Sites Racoon/Opennhrp] would provide better functionality.

It is recommended that you have a publicly routable static IP address in order for this to work. This means that your IP address cannot be in the private IP address ranges described here: [http://en.wikipedia.org/wiki/IP_address#IPv4_private_addresses WikiPedia]

If your Internet-connected machine doesn't have a static IP address, [http://www.dyndns.com DynDNS] can be used for resolving DNS names to IP addresses.

= Setup Alpine =
== Initial Setup ==
Follow [[Installing_Alpine]] to setup Alpine Linux.

== Install programs ==
Install openvpn
{{Cmd|apk add openvpn}}

Prepare autostart of OpenVPN

{{Cmd|rc-update add openvpn default}}

{{Cmd|modprobe tun
echo "tun" >> /etc/modules-load.d/tun.conf}}

Enable IP Forwarding

''echo "net.ipv4.ip_forward = 1" >> /etc/sysctl.d/ipv4.conf''

{{Cmd|sysctl -p /etc/sysctl.d/ipv4.conf}}

= Certificates =
One of the first things that needs to be done is to make sure that you have secure keys to work with. Alpine makes this easy by having a web interface to manage the certificates. Documentation for it can be found here: [[Generating_SSL_certs_with_ACF]]. It is a best practice not to have your certificate server be on the same machine as the router being used for remote connectivity.

You will need to create a server (ssl_server_cert) certificate for the server and one client (ssl_client_cert) for each client. To use the certificates, you should download the .pfx file and extract it.

To extract the three parts of each .pfx file, use the following commands:

To get the ca cert out...
{{Cmd|openssl pkcs12 -in PFXFILE -cacerts -nokeys -out ca.pem}}

To get the cert file out...
{{Cmd|openssl pkcs12 -in PFXFILE -nokeys -clcerts -out cert.pem}}

To get the private key file out. Make sure this stays private.

{{Cmd|openssl pkcs12 -in PFXFILE -nocerts -nodes -out key.pem}}

On the VPN server, you can also install the '''acf-openvpn''' package, which contains a web page to automatically upload and extract the server certificate. There is also a button to automatically generate the Diffie Hellman parameters.

If you would prefer to generate your certificates using OpenVPN utilities, see [[#Alternative Certificate Method]]

= Configure OpenVPN server =
Example configuration file for server. Place the following content in /etc/openvpn/openvpn.conf:
local "Public Ip address"
port 1194
proto udp
dev tun
ca /etc/openvpn/easy-rsa/keys/ca.crt
cert /etc/openvpn/easy-rsa/keys/Server.crt # SWAP WITH YOUR CRT NAME
key /etc/openvpn/easy-rsa/keys/Server.key # SWAP WITH YOUR KEY NAME
dh /etc/openvpn/easy-rsa/keys/dh1024.pem # If you changed to 2048, change that here!
server 10.0.0.0 255.255.255.0
ifconfig-pool-persist ipp.txt
push "route 10.0.0.0 255.0.0.0"
push "dhcp-option DNS 10.0.0.1"
keepalive 10 120
comp-lzo
user nobody
group nobody
persist-key
persist-tun
status /var/log/openvpn-status.log
log-append /var/log/openvpn.log
verb 3

(''Instructions are based on [http://openvpn.net/howto.html#server openvpn.net/howto.html#server]'')

== Test your configuration ==
Test configuration and certificates

{{Cmd|openvpn --config /etc/openvpn/openvpn.conf}}

= Configure OpenVPN client =
Example client.conf:
client
dev tun
proto udp
remote "public IP" 1194
resolv-retry infinite
nobind
ns-cert-type server # This means that the certificate on the openvpn server needs to have this field. Prevents MitM attacks
persist-key
persist-tun
ca client-ca.pem
cert client-cert.pem
key client-key.pem
comp-lzo
verb 3

(''Instructions are based on [http://openvpn.net/howto.html#client openvpn.net/howto.html#client]'')

= Save settings =
Don't forget to save all your settings if you are running a RAM-based system.
{{Cmd|lbu commit}}

= More than one server or client =

If you want more than one server or client running on the same alpine box, use the standard [[Multiple Instances of Services]] process.

For example, to create a config named "AlphaBravo":

* Create an approriate /etc/openvpn/openvpn.conf file, but name it "/etc/openvpn/AlphaBravo.conf"
* create a new symlink of the init.d script:
{{Cmd|ln -s /etc/init.d/openvpn /etc/init.d/openvpn.AlphaBravo}}
* Have the new service start automatically
{{Cmd|rc-update add openvpn.AlphaBravo}}

= Alternative Certificate Method =
== Manual Certificate Commands ==
(''Instructions are based on [http://openvpn.net/howto.html#pki openvpn.net/howto.html#pki]'')

=== Initial setup for administrating certificates ===
The following instructions assume that you want to save your configs, certs and keys in '''/etc/openvpn/keys'''. 
Start by moving to the '''/usr/share/openvpn/easy-rsa''' folder to execute commands
{{Cmd|apk add easy-rsa # from the community repo
cd /usr/share/easy-rsa}}
If not already done then create a folder where you will save your certificates and save a copy of your '''/usr/share/easy-rsa/vars''' for later use. 
{{Cmd|mkdir /etc/openvpn/keys
cp ./vars.example ./vars #easy-rsa v3
cp ./vars /etc/openvpn/keys #easy-rsa v2}}

For EasyRSA v3 see: https://community.openvpn.net/openvpn/wiki/EasyRSA

The instructions below are for EasyRSA v2:

If not already done then edit '''/etc/openvpn/keys/vars''' 
(''This file is used for defining paths and other standard settings'')
{{Cmd|vim /etc/openvpn/keys/vars}}
* Change '''KEY_DIR=''' from "'''$EASY_RSA/keys'''" to "'''/etc/openvpn/keys'''"
* Change '''KEY_SIZE, CA_EXPIRE, KEY_EXPIRE, KEY_COUNTRY, KEY_PROVINCE, KEY_CITY, KEY_ORG, KEY_EMAIL''' to match your system.
source the '''vars''' to set properties
{{Cmd|source /etc/openvpn/keys/vars}}
{{Cmd|touch /etc/openvpn/keys/index.txt
echo 00 > /etc/openvpn/keys/serial}}

=== Set up a 'Certificate Authority' (CA) ===
Clean up the '''keys''' folder.

{{Cmd|./clean-all}}

Generate Diffie Hellman parameters

{{Cmd|./build-dh}}

Now lets make the CA certificates and keys

{{Cmd|./build-ca}}

=== Set up a 'OpenVPN Server' ===
Create server certificates

{{Cmd|./build-key-server <commonname>}}

=== Set up a 'OpenVPN Client' ===
Create client certificates
{{Cmd|./build-key <commonname>}}

=== Revoke a certificate ===
To revoke a certificate

{{Cmd|./revoke-full <commonname>}}

The revoke-full script will generate a CRL (certificate revocation list) file called '''crl.pem''' in the '''keys''' subdirectory. The file should be copied to a directory where the OpenVPN server can access it, then CRL verification should be enabled in the server configuration:

{{Cmd|crl-verify crl.pem}}

= OpenVPN and LXC =

Let's call this LXC "mylxc"...

On the host <pre>
modprobe tun
mkdir /var/lib/lxc/mylxc/rootfs/dev/net
mknod /var/lib/lxc/mylxc/rootfs/dev/net/tun c 10 200
chmod 666 /var/lib/lxc/mylxc/rootfs/dev/net/tun
</pre>

In /var/lib/lxc/mylxc/config <pre>
lxc.cgroup.devices.allow = c 10:200 rwm
</pre>

In the guest <pre>
apk add openvpn
</pre> Then config as usual...

This should work both as server and as client.

== persistent devices ==
lxc guest have their dev recreated on each restart in a tmpfs. This means all devices are reset and are not read from rootfs dev directory.
To make it persistent you can use an autodev script by adding the following to your lxc guest config

<pre>
# tun (openvpn)
lxc.cgroup.devices.allow = c 10:200 rwm
# audodev script to add devices
lxc.hook.autodev=/var/lib/lxc/CONTAINER/autodev
</pre>

The autodev script would be as following:

<pre>
#!/bin/sh
# dev is populated on earch container start.
# to make devices persistence we need to recreate them on each start.

cd ${LXC_ROOTFS_MOUNT}/dev
mkdir net
mknod net/tun c 10 200
chmod 0666 net/tun
</pre>

[[category: VPN]]

Setting up a OpenVPN server

2020-02-12T11:07:42Z

Leo: /* Install programs */

{{TOC right}}

This article describes how to set up an OpenVPN server with the Alpine Linux.
This is an ideal solution for allowing single users or devices to remotely connect to your network. To establish connectivity with a Remote Office or site, [http://wiki.alpinelinux.org/w/index.php?title=Using_Racoon_for_Remote_Sites Racoon/Opennhrp] would provide better functionality.

It is recommended that you have a publicly routable static IP address in order for this to work. This means that your IP address cannot be in the private IP address ranges described here: [http://en.wikipedia.org/wiki/IP_address#IPv4_private_addresses WikiPedia]

If your Internet-connected machine doesn't have a static IP address, [http://www.dyndns.com DynDNS] can be used for resolving DNS names to IP addresses.

= Setup Alpine =
== Initial Setup ==
Follow [[Installing_Alpine]] to setup Alpine Linux.

== Install programs ==
Install openvpn
{{Cmd|apk add openvpn}}

Prepare autostart of OpenVPN

{{Cmd|rc-update add openvpn default}}

{{Cmd|modprobe tun
echo "tun" >> /etc/modules-load.d/tun.conf}}

Enable IP Forwarding

{{Cmd|echo "net.ipv4.ip_forward = 1" >> /etc/sysctl.d/ipv4.conf
sysctl -p /etc/sysctl.d/ipv4.conf}}

= Certificates =
One of the first things that needs to be done is to make sure that you have secure keys to work with. Alpine makes this easy by having a web interface to manage the certificates. Documentation for it can be found here: [[Generating_SSL_certs_with_ACF]]. It is a best practice not to have your certificate server be on the same machine as the router being used for remote connectivity.

You will need to create a server (ssl_server_cert) certificate for the server and one client (ssl_client_cert) for each client. To use the certificates, you should download the .pfx file and extract it.

To extract the three parts of each .pfx file, use the following commands:

To get the ca cert out...
{{Cmd|openssl pkcs12 -in PFXFILE -cacerts -nokeys -out ca.pem}}

To get the cert file out...
{{Cmd|openssl pkcs12 -in PFXFILE -nokeys -clcerts -out cert.pem}}

To get the private key file out. Make sure this stays private.

{{Cmd|openssl pkcs12 -in PFXFILE -nocerts -nodes -out key.pem}}

On the VPN server, you can also install the '''acf-openvpn''' package, which contains a web page to automatically upload and extract the server certificate. There is also a button to automatically generate the Diffie Hellman parameters.

If you would prefer to generate your certificates using OpenVPN utilities, see [[#Alternative Certificate Method]]

= Configure OpenVPN server =
Example configuration file for server. Place the following content in /etc/openvpn/openvpn.conf:
local "Public Ip address"
port 1194
proto udp
dev tun
ca /etc/openvpn/easy-rsa/keys/ca.crt
cert /etc/openvpn/easy-rsa/keys/Server.crt # SWAP WITH YOUR CRT NAME
key /etc/openvpn/easy-rsa/keys/Server.key # SWAP WITH YOUR KEY NAME
dh /etc/openvpn/easy-rsa/keys/dh1024.pem # If you changed to 2048, change that here!
server 10.0.0.0 255.255.255.0
ifconfig-pool-persist ipp.txt
push "route 10.0.0.0 255.0.0.0"
push "dhcp-option DNS 10.0.0.1"
keepalive 10 120
comp-lzo
user nobody
group nobody
persist-key
persist-tun
status /var/log/openvpn-status.log
log-append /var/log/openvpn.log
verb 3

(''Instructions are based on [http://openvpn.net/howto.html#server openvpn.net/howto.html#server]'')

== Test your configuration ==
Test configuration and certificates

{{Cmd|openvpn --config /etc/openvpn/openvpn.conf}}

= Configure OpenVPN client =
Example client.conf:
client
dev tun
proto udp
remote "public IP" 1194
resolv-retry infinite
nobind
ns-cert-type server # This means that the certificate on the openvpn server needs to have this field. Prevents MitM attacks
persist-key
persist-tun
ca client-ca.pem
cert client-cert.pem
key client-key.pem
comp-lzo
verb 3

(''Instructions are based on [http://openvpn.net/howto.html#client openvpn.net/howto.html#client]'')

= Save settings =
Don't forget to save all your settings if you are running a RAM-based system.
{{Cmd|lbu commit}}

= More than one server or client =

If you want more than one server or client running on the same alpine box, use the standard [[Multiple Instances of Services]] process.

For example, to create a config named "AlphaBravo":

* Create an approriate /etc/openvpn/openvpn.conf file, but name it "/etc/openvpn/AlphaBravo.conf"
* create a new symlink of the init.d script:
{{Cmd|ln -s /etc/init.d/openvpn /etc/init.d/openvpn.AlphaBravo}}
* Have the new service start automatically
{{Cmd|rc-update add openvpn.AlphaBravo}}

= Alternative Certificate Method =
== Manual Certificate Commands ==
(''Instructions are based on [http://openvpn.net/howto.html#pki openvpn.net/howto.html#pki]'')

=== Initial setup for administrating certificates ===
The following instructions assume that you want to save your configs, certs and keys in '''/etc/openvpn/keys'''. 
Start by moving to the '''/usr/share/openvpn/easy-rsa''' folder to execute commands
{{Cmd|apk add easy-rsa # from the community repo
cd /usr/share/easy-rsa}}
If not already done then create a folder where you will save your certificates and save a copy of your '''/usr/share/easy-rsa/vars''' for later use. 
{{Cmd|mkdir /etc/openvpn/keys
cp ./vars.example ./vars #easy-rsa v3
cp ./vars /etc/openvpn/keys #easy-rsa v2}}

For EasyRSA v3 see: https://community.openvpn.net/openvpn/wiki/EasyRSA

The instructions below are for EasyRSA v2:

If not already done then edit '''/etc/openvpn/keys/vars''' 
(''This file is used for defining paths and other standard settings'')
{{Cmd|vim /etc/openvpn/keys/vars}}
* Change '''KEY_DIR=''' from "'''$EASY_RSA/keys'''" to "'''/etc/openvpn/keys'''"
* Change '''KEY_SIZE, CA_EXPIRE, KEY_EXPIRE, KEY_COUNTRY, KEY_PROVINCE, KEY_CITY, KEY_ORG, KEY_EMAIL''' to match your system.
source the '''vars''' to set properties
{{Cmd|source /etc/openvpn/keys/vars}}
{{Cmd|touch /etc/openvpn/keys/index.txt
echo 00 > /etc/openvpn/keys/serial}}

=== Set up a 'Certificate Authority' (CA) ===
Clean up the '''keys''' folder.

{{Cmd|./clean-all}}

Generate Diffie Hellman parameters

{{Cmd|./build-dh}}

Now lets make the CA certificates and keys

{{Cmd|./build-ca}}

=== Set up a 'OpenVPN Server' ===
Create server certificates

{{Cmd|./build-key-server <commonname>}}

=== Set up a 'OpenVPN Client' ===
Create client certificates
{{Cmd|./build-key <commonname>}}

=== Revoke a certificate ===
To revoke a certificate

{{Cmd|./revoke-full <commonname>}}

The revoke-full script will generate a CRL (certificate revocation list) file called '''crl.pem''' in the '''keys''' subdirectory. The file should be copied to a directory where the OpenVPN server can access it, then CRL verification should be enabled in the server configuration:

{{Cmd|crl-verify crl.pem}}

= OpenVPN and LXC =

Let's call this LXC "mylxc"...

On the host <pre>
modprobe tun
mkdir /var/lib/lxc/mylxc/rootfs/dev/net
mknod /var/lib/lxc/mylxc/rootfs/dev/net/tun c 10 200
chmod 666 /var/lib/lxc/mylxc/rootfs/dev/net/tun
</pre>

In /var/lib/lxc/mylxc/config <pre>
lxc.cgroup.devices.allow = c 10:200 rwm
</pre>

In the guest <pre>
apk add openvpn
</pre> Then config as usual...

This should work both as server and as client.

== persistent devices ==
lxc guest have their dev recreated on each restart in a tmpfs. This means all devices are reset and are not read from rootfs dev directory.
To make it persistent you can use an autodev script by adding the following to your lxc guest config

<pre>
# tun (openvpn)
lxc.cgroup.devices.allow = c 10:200 rwm
# audodev script to add devices
lxc.hook.autodev=/var/lib/lxc/CONTAINER/autodev
</pre>

The autodev script would be as following:

<pre>
#!/bin/sh
# dev is populated on earch container start.
# to make devices persistence we need to recreate them on each start.

cd ${LXC_ROOTFS_MOUNT}/dev
mkdir net
mknod net/tun c 10 200
chmod 0666 net/tun
</pre>

[[category: VPN]]

Setting up a OpenVPN server

2020-02-12T11:07:19Z

Leo: /* Install programs */

{{TOC right}}

This article describes how to set up an OpenVPN server with the Alpine Linux.
This is an ideal solution for allowing single users or devices to remotely connect to your network. To establish connectivity with a Remote Office or site, [http://wiki.alpinelinux.org/w/index.php?title=Using_Racoon_for_Remote_Sites Racoon/Opennhrp] would provide better functionality.

It is recommended that you have a publicly routable static IP address in order for this to work. This means that your IP address cannot be in the private IP address ranges described here: [http://en.wikipedia.org/wiki/IP_address#IPv4_private_addresses WikiPedia]

If your Internet-connected machine doesn't have a static IP address, [http://www.dyndns.com DynDNS] can be used for resolving DNS names to IP addresses.

= Setup Alpine =
== Initial Setup ==
Follow [[Installing_Alpine]] to setup Alpine Linux.

== Install programs ==
Install openvpn
{{Cmd|apk add openvpn}}

Prepare autostart of OpenVPN

{{Cmd|rc-update add openvpn default}}

{{Cmd|modprobe tun
echo "tun" >> /etc/modules-load.d/tun.conf}}

Enable IP Forwarding

{{Cmd|echo "net.ipv4.ip_forward = 1" >> /etc/sysctl.d/ipv4.conf}}

{{Cmd|sysctl -p /etc/sysctl.d/ipv4.conf}}

= Certificates =
One of the first things that needs to be done is to make sure that you have secure keys to work with. Alpine makes this easy by having a web interface to manage the certificates. Documentation for it can be found here: [[Generating_SSL_certs_with_ACF]]. It is a best practice not to have your certificate server be on the same machine as the router being used for remote connectivity.

You will need to create a server (ssl_server_cert) certificate for the server and one client (ssl_client_cert) for each client. To use the certificates, you should download the .pfx file and extract it.

To extract the three parts of each .pfx file, use the following commands:

To get the ca cert out...
{{Cmd|openssl pkcs12 -in PFXFILE -cacerts -nokeys -out ca.pem}}

To get the cert file out...
{{Cmd|openssl pkcs12 -in PFXFILE -nokeys -clcerts -out cert.pem}}

To get the private key file out. Make sure this stays private.

{{Cmd|openssl pkcs12 -in PFXFILE -nocerts -nodes -out key.pem}}

On the VPN server, you can also install the '''acf-openvpn''' package, which contains a web page to automatically upload and extract the server certificate. There is also a button to automatically generate the Diffie Hellman parameters.

If you would prefer to generate your certificates using OpenVPN utilities, see [[#Alternative Certificate Method]]

= Configure OpenVPN server =
Example configuration file for server. Place the following content in /etc/openvpn/openvpn.conf:
local "Public Ip address"
port 1194
proto udp
dev tun
ca /etc/openvpn/easy-rsa/keys/ca.crt
cert /etc/openvpn/easy-rsa/keys/Server.crt # SWAP WITH YOUR CRT NAME
key /etc/openvpn/easy-rsa/keys/Server.key # SWAP WITH YOUR KEY NAME
dh /etc/openvpn/easy-rsa/keys/dh1024.pem # If you changed to 2048, change that here!
server 10.0.0.0 255.255.255.0
ifconfig-pool-persist ipp.txt
push "route 10.0.0.0 255.0.0.0"
push "dhcp-option DNS 10.0.0.1"
keepalive 10 120
comp-lzo
user nobody
group nobody
persist-key
persist-tun
status /var/log/openvpn-status.log
log-append /var/log/openvpn.log
verb 3

(''Instructions are based on [http://openvpn.net/howto.html#server openvpn.net/howto.html#server]'')

== Test your configuration ==
Test configuration and certificates

{{Cmd|openvpn --config /etc/openvpn/openvpn.conf}}

= Configure OpenVPN client =
Example client.conf:
client
dev tun
proto udp
remote "public IP" 1194
resolv-retry infinite
nobind
ns-cert-type server # This means that the certificate on the openvpn server needs to have this field. Prevents MitM attacks
persist-key
persist-tun
ca client-ca.pem
cert client-cert.pem
key client-key.pem
comp-lzo
verb 3

(''Instructions are based on [http://openvpn.net/howto.html#client openvpn.net/howto.html#client]'')

= Save settings =
Don't forget to save all your settings if you are running a RAM-based system.
{{Cmd|lbu commit}}

= More than one server or client =

If you want more than one server or client running on the same alpine box, use the standard [[Multiple Instances of Services]] process.

For example, to create a config named "AlphaBravo":

* Create an approriate /etc/openvpn/openvpn.conf file, but name it "/etc/openvpn/AlphaBravo.conf"
* create a new symlink of the init.d script:
{{Cmd|ln -s /etc/init.d/openvpn /etc/init.d/openvpn.AlphaBravo}}
* Have the new service start automatically
{{Cmd|rc-update add openvpn.AlphaBravo}}

= Alternative Certificate Method =
== Manual Certificate Commands ==
(''Instructions are based on [http://openvpn.net/howto.html#pki openvpn.net/howto.html#pki]'')

=== Initial setup for administrating certificates ===
The following instructions assume that you want to save your configs, certs and keys in '''/etc/openvpn/keys'''. 
Start by moving to the '''/usr/share/openvpn/easy-rsa''' folder to execute commands
{{Cmd|apk add easy-rsa # from the community repo
cd /usr/share/easy-rsa}}
If not already done then create a folder where you will save your certificates and save a copy of your '''/usr/share/easy-rsa/vars''' for later use. 
{{Cmd|mkdir /etc/openvpn/keys
cp ./vars.example ./vars #easy-rsa v3
cp ./vars /etc/openvpn/keys #easy-rsa v2}}

For EasyRSA v3 see: https://community.openvpn.net/openvpn/wiki/EasyRSA

The instructions below are for EasyRSA v2:

If not already done then edit '''/etc/openvpn/keys/vars''' 
(''This file is used for defining paths and other standard settings'')
{{Cmd|vim /etc/openvpn/keys/vars}}
* Change '''KEY_DIR=''' from "'''$EASY_RSA/keys'''" to "'''/etc/openvpn/keys'''"
* Change '''KEY_SIZE, CA_EXPIRE, KEY_EXPIRE, KEY_COUNTRY, KEY_PROVINCE, KEY_CITY, KEY_ORG, KEY_EMAIL''' to match your system.
source the '''vars''' to set properties
{{Cmd|source /etc/openvpn/keys/vars}}
{{Cmd|touch /etc/openvpn/keys/index.txt
echo 00 > /etc/openvpn/keys/serial}}

=== Set up a 'Certificate Authority' (CA) ===
Clean up the '''keys''' folder.

{{Cmd|./clean-all}}

Generate Diffie Hellman parameters

{{Cmd|./build-dh}}

Now lets make the CA certificates and keys

{{Cmd|./build-ca}}

=== Set up a 'OpenVPN Server' ===
Create server certificates

{{Cmd|./build-key-server <commonname>}}

=== Set up a 'OpenVPN Client' ===
Create client certificates
{{Cmd|./build-key <commonname>}}

=== Revoke a certificate ===
To revoke a certificate

{{Cmd|./revoke-full <commonname>}}

The revoke-full script will generate a CRL (certificate revocation list) file called '''crl.pem''' in the '''keys''' subdirectory. The file should be copied to a directory where the OpenVPN server can access it, then CRL verification should be enabled in the server configuration:

{{Cmd|crl-verify crl.pem}}

= OpenVPN and LXC =

Let's call this LXC "mylxc"...

On the host <pre>
modprobe tun
mkdir /var/lib/lxc/mylxc/rootfs/dev/net
mknod /var/lib/lxc/mylxc/rootfs/dev/net/tun c 10 200
chmod 666 /var/lib/lxc/mylxc/rootfs/dev/net/tun
</pre>

In /var/lib/lxc/mylxc/config <pre>
lxc.cgroup.devices.allow = c 10:200 rwm
</pre>

In the guest <pre>
apk add openvpn
</pre> Then config as usual...

This should work both as server and as client.

== persistent devices ==
lxc guest have their dev recreated on each restart in a tmpfs. This means all devices are reset and are not read from rootfs dev directory.
To make it persistent you can use an autodev script by adding the following to your lxc guest config

<pre>
# tun (openvpn)
lxc.cgroup.devices.allow = c 10:200 rwm
# audodev script to add devices
lxc.hook.autodev=/var/lib/lxc/CONTAINER/autodev
</pre>

The autodev script would be as following:

<pre>
#!/bin/sh
# dev is populated on earch container start.
# to make devices persistence we need to recreate them on each start.

cd ${LXC_ROOTFS_MOUNT}/dev
mkdir net
mknod net/tun c 10 200
chmod 0666 net/tun
</pre>

[[category: VPN]]

Setting up a OpenVPN server

2020-02-12T11:07:09Z

Leo: /* Install programs */

{{TOC right}}

This article describes how to set up an OpenVPN server with the Alpine Linux.
This is an ideal solution for allowing single users or devices to remotely connect to your network. To establish connectivity with a Remote Office or site, [http://wiki.alpinelinux.org/w/index.php?title=Using_Racoon_for_Remote_Sites Racoon/Opennhrp] would provide better functionality.

It is recommended that you have a publicly routable static IP address in order for this to work. This means that your IP address cannot be in the private IP address ranges described here: [http://en.wikipedia.org/wiki/IP_address#IPv4_private_addresses WikiPedia]

If your Internet-connected machine doesn't have a static IP address, [http://www.dyndns.com DynDNS] can be used for resolving DNS names to IP addresses.

= Setup Alpine =
== Initial Setup ==
Follow [[Installing_Alpine]] to setup Alpine Linux.

== Install programs ==
Install openvpn
{{Cmd|apk add openvpn}}

Prepare autostart of OpenVPN

{{Cmd|rc-update add openvpn default}}

{{Cmd|modprobe tun
echo "tun" >> /etc/modules-load.d/tun.conf}}

Enable IP Forwarding

{{cmd|echo "net.ipv4.ip_forward = 1" >> /etc/sysctl.d/ipv4.conf}}

{{Cmd|sysctl -p /etc/sysctl.d/ipv4.conf}}

= Certificates =
One of the first things that needs to be done is to make sure that you have secure keys to work with. Alpine makes this easy by having a web interface to manage the certificates. Documentation for it can be found here: [[Generating_SSL_certs_with_ACF]]. It is a best practice not to have your certificate server be on the same machine as the router being used for remote connectivity.

You will need to create a server (ssl_server_cert) certificate for the server and one client (ssl_client_cert) for each client. To use the certificates, you should download the .pfx file and extract it.

To extract the three parts of each .pfx file, use the following commands:

To get the ca cert out...
{{Cmd|openssl pkcs12 -in PFXFILE -cacerts -nokeys -out ca.pem}}

To get the cert file out...
{{Cmd|openssl pkcs12 -in PFXFILE -nokeys -clcerts -out cert.pem}}

To get the private key file out. Make sure this stays private.

{{Cmd|openssl pkcs12 -in PFXFILE -nocerts -nodes -out key.pem}}

On the VPN server, you can also install the '''acf-openvpn''' package, which contains a web page to automatically upload and extract the server certificate. There is also a button to automatically generate the Diffie Hellman parameters.

If you would prefer to generate your certificates using OpenVPN utilities, see [[#Alternative Certificate Method]]

= Configure OpenVPN server =
Example configuration file for server. Place the following content in /etc/openvpn/openvpn.conf:
local "Public Ip address"
port 1194
proto udp
dev tun
ca /etc/openvpn/easy-rsa/keys/ca.crt
cert /etc/openvpn/easy-rsa/keys/Server.crt # SWAP WITH YOUR CRT NAME
key /etc/openvpn/easy-rsa/keys/Server.key # SWAP WITH YOUR KEY NAME
dh /etc/openvpn/easy-rsa/keys/dh1024.pem # If you changed to 2048, change that here!
server 10.0.0.0 255.255.255.0
ifconfig-pool-persist ipp.txt
push "route 10.0.0.0 255.0.0.0"
push "dhcp-option DNS 10.0.0.1"
keepalive 10 120
comp-lzo
user nobody
group nobody
persist-key
persist-tun
status /var/log/openvpn-status.log
log-append /var/log/openvpn.log
verb 3

(''Instructions are based on [http://openvpn.net/howto.html#server openvpn.net/howto.html#server]'')

== Test your configuration ==
Test configuration and certificates

{{Cmd|openvpn --config /etc/openvpn/openvpn.conf}}

= Configure OpenVPN client =
Example client.conf:
client
dev tun
proto udp
remote "public IP" 1194
resolv-retry infinite
nobind
ns-cert-type server # This means that the certificate on the openvpn server needs to have this field. Prevents MitM attacks
persist-key
persist-tun
ca client-ca.pem
cert client-cert.pem
key client-key.pem
comp-lzo
verb 3

(''Instructions are based on [http://openvpn.net/howto.html#client openvpn.net/howto.html#client]'')

= Save settings =
Don't forget to save all your settings if you are running a RAM-based system.
{{Cmd|lbu commit}}

= More than one server or client =

If you want more than one server or client running on the same alpine box, use the standard [[Multiple Instances of Services]] process.

For example, to create a config named "AlphaBravo":

* Create an approriate /etc/openvpn/openvpn.conf file, but name it "/etc/openvpn/AlphaBravo.conf"
* create a new symlink of the init.d script:
{{Cmd|ln -s /etc/init.d/openvpn /etc/init.d/openvpn.AlphaBravo}}
* Have the new service start automatically
{{Cmd|rc-update add openvpn.AlphaBravo}}

= Alternative Certificate Method =
== Manual Certificate Commands ==
(''Instructions are based on [http://openvpn.net/howto.html#pki openvpn.net/howto.html#pki]'')

=== Initial setup for administrating certificates ===
The following instructions assume that you want to save your configs, certs and keys in '''/etc/openvpn/keys'''. 
Start by moving to the '''/usr/share/openvpn/easy-rsa''' folder to execute commands
{{Cmd|apk add easy-rsa # from the community repo
cd /usr/share/easy-rsa}}
If not already done then create a folder where you will save your certificates and save a copy of your '''/usr/share/easy-rsa/vars''' for later use. 
{{Cmd|mkdir /etc/openvpn/keys
cp ./vars.example ./vars #easy-rsa v3
cp ./vars /etc/openvpn/keys #easy-rsa v2}}

For EasyRSA v3 see: https://community.openvpn.net/openvpn/wiki/EasyRSA

The instructions below are for EasyRSA v2:

If not already done then edit '''/etc/openvpn/keys/vars''' 
(''This file is used for defining paths and other standard settings'')
{{Cmd|vim /etc/openvpn/keys/vars}}
* Change '''KEY_DIR=''' from "'''$EASY_RSA/keys'''" to "'''/etc/openvpn/keys'''"
* Change '''KEY_SIZE, CA_EXPIRE, KEY_EXPIRE, KEY_COUNTRY, KEY_PROVINCE, KEY_CITY, KEY_ORG, KEY_EMAIL''' to match your system.
source the '''vars''' to set properties
{{Cmd|source /etc/openvpn/keys/vars}}
{{Cmd|touch /etc/openvpn/keys/index.txt
echo 00 > /etc/openvpn/keys/serial}}

=== Set up a 'Certificate Authority' (CA) ===
Clean up the '''keys''' folder.

{{Cmd|./clean-all}}

Generate Diffie Hellman parameters

{{Cmd|./build-dh}}

Now lets make the CA certificates and keys

{{Cmd|./build-ca}}

=== Set up a 'OpenVPN Server' ===
Create server certificates

{{Cmd|./build-key-server <commonname>}}

=== Set up a 'OpenVPN Client' ===
Create client certificates
{{Cmd|./build-key <commonname>}}

=== Revoke a certificate ===
To revoke a certificate

{{Cmd|./revoke-full <commonname>}}

The revoke-full script will generate a CRL (certificate revocation list) file called '''crl.pem''' in the '''keys''' subdirectory. The file should be copied to a directory where the OpenVPN server can access it, then CRL verification should be enabled in the server configuration:

{{Cmd|crl-verify crl.pem}}

= OpenVPN and LXC =

Let's call this LXC "mylxc"...

On the host <pre>
modprobe tun
mkdir /var/lib/lxc/mylxc/rootfs/dev/net
mknod /var/lib/lxc/mylxc/rootfs/dev/net/tun c 10 200
chmod 666 /var/lib/lxc/mylxc/rootfs/dev/net/tun
</pre>

In /var/lib/lxc/mylxc/config <pre>
lxc.cgroup.devices.allow = c 10:200 rwm
</pre>

In the guest <pre>
apk add openvpn
</pre> Then config as usual...

This should work both as server and as client.

== persistent devices ==
lxc guest have their dev recreated on each restart in a tmpfs. This means all devices are reset and are not read from rootfs dev directory.
To make it persistent you can use an autodev script by adding the following to your lxc guest config

<pre>
# tun (openvpn)
lxc.cgroup.devices.allow = c 10:200 rwm
# audodev script to add devices
lxc.hook.autodev=/var/lib/lxc/CONTAINER/autodev
</pre>

The autodev script would be as following:

<pre>
#!/bin/sh
# dev is populated on earch container start.
# to make devices persistence we need to recreate them on each start.

cd ${LXC_ROOTFS_MOUNT}/dev
mkdir net
mknod net/tun c 10 200
chmod 0666 net/tun
</pre>

[[category: VPN]]

Using HSDPA modem

2020-02-12T09:37:28Z

Leo: /* Load modules */

[[Category:Networking]]

== Requirements ==
This doc is tested on alpine-2.1.3.

You will need a [http://en.wikipedia.org/wiki/High-Speed_Downlink_Packet_Access HSDPA] USB-modem. 
Use 'dmesg | less' to figure out which /dev/ttyUSB? it uses ''(you will need to edit below config to reflect this)''.

== Install packages ==
Install required packages
{{cmd|apk add ppp}}

== Load modules ==
Now let's load the driver ''(using the values you just found out)'' and prepare it to get automatically loaded at next reboot.
{{cmd|modprobe ppp_generic
echo "ppp_generic" >> /etc/modules-load.d/ppp.conf}}

== Configfiles ==

=== /etc/ppp/peers/E220 ===
''(The filename 'E220' can be changed to whatever is appropreate for you, but you will need to remember it when running pon/poff command)''
<pre>debug
/dev/ttyUSB0
460800
crtscts
modem
noauth
usepeerdns
defaultroute
noipdefault
noccp
nobsdcomp
novj
connect '/usr/sbin/chat -v -f /etc/ppp/chat-E220-pin || /usr/sbin/chat -f /etc/ppp/chat-E220-nopin'
</pre>

=== /etc/ppp/chat-E220-pin ===
''(The filename 'chat-E220-pin' can be changed to whatever is appropreate for you, but you will need modify above configfile to reflect your decition)''
<pre>ABORT "BUSY"
ABORT "ERROR"
ABORT "NO CARRIER"
REPORT "CONNECT"
TIMEOUT "10"
"" "ATZ"
OK "AT+CPIN={PIN}"
OK AT+CGDCONT=1,"ip","{APN}"
OK "ATE1V1&D2&C1S0=0+IFC=2,2"
OK "AT+IPR=115200"
OK "ATE1"
TIMEOUT "60"
"" "ATD*99***1#"
CONNECT \c
</pre>

=== /etc/ppp/chat-E220-nopin ===
''(The filename 'chat-E220-nopin' can be changed to whatever is appropreate for you, but you will need modify above configfile to reflect your decition)''
<pre>ABORT "BUSY"
ABORT "ERROR"
ABORT "NO CARRIER"
REPORT "CONNECT"
TIMEOUT "10"
"" "ATZ"
OK AT+CGDCONT=1,"ip","{APN}"
OK "ATE1V1&D2&C1S0=0+IFC=2,2"
OK "AT+IPR=115200"
OK "ATE1"
TIMEOUT "60"
"" "ATD*99***1#"
CONNECT \c
</pre>
{{Note|Replace above word '''{PIN}''' with the "PIN" of your card ''(typically a 4 digit code)''}}
{{Note|Replace above word '''{APN}''' with the "Access Point Name" of the service you use ''(for instance mine is "web.omnitel.it")''. If you don't know the Internet APN, ask your service provider}}

== Routes ==
Create a default gw route to your 'ppp0' device.
{{cmd|ip route add default dev ppp0}}

== DNS ==
Figure out what DNS-servers your provider has.
{{cmd|egrep -i 'pppd.*dns' /var/log/messages}}
This might give you some useful information. 
Search for a IP-address that might be your providers DNS-server and add this IP-address into '/etc/resolv.conf'.
{{cmd|echo "nameserver {DNS-server-IP-address}" > /etc/resolv.conf}}

= Start/Stop=
== Start connection ==
{{cmd|pon E220}}
== Stop connection ==
{{cmd|poff E220}}

= If something goes wrong... =
Check if process is running
{{cmd|pidof pppd}}
Logfile might give you a clue on what went wrong
{{cmd|egrep "pppd{{!}}chat" /var/log/messages}}
Check nic information
{{cmd|ifconfig ppp0}}
pppd has a statusinformation function that could come in handy
{{cmd|pppstats}}

= Huawei E378 =
Tested on Alpine 2.3.3.

Add usb-modeswitch (currently only in testing repo):
{{cmd|apk add usb-modeswitch}}

/etc/modules:
<pre>
usbserial vendor=0x12d1 product=0x1446
</pre>
/etc/usb_modeswitch.conf:
<pre>
# Configuration for the usb_modeswitch package, a mode switching tool for
# USB devices providing multiple states or modes
#
# This file is evaluated by the wrapper script "usb_modeswitch_dispatcher"
# in /usr/sbin
# To enable an option, set it to "1", "yes" or "true" (case doesn't matter)
# Everything else counts as "disable"

# Disable automatic mode switching globally (e.g. to access the original
# install storage)
DisableSwitching=0

# Enable logging (results in a extensive report file in /var/log, named
# "usb_modeswitch_<interface-name>" (and probably others)
EnableLogging=1

DefaultVendor=0x12d1
DefaultProduct=0x1446

TargetVendor=0x12d1
TargetProduct=0x14ac

MessageContent="55534243000000000000000000000011060000000000000000000000000000"

CheckSuccess=5
</pre>
/etc/network/interfaces
<pre>
auto ppp0
iface ppp0 inet ppp
provider E378
pre-up usb_modeswitch -c /etc/usb_modeswitch.conf
</pre>
/etc/ppp/peers/E378:
<pre>
debug
/dev/ttyUSB0
460800
crtscts
modem
noauth
usepeerdns
defaultroute
noipdefault
noccp
nobsdcomp
novj
connect '/usr/sbin/chat -v -f /etc/ppp/peers/chat-E378-nopin'
</pre>
/etc/ppp/peers/chat-E378-nopin:
<pre>
ABORT "BUSY"
ABORT "ERROR"
ABORT "NO CARRIER"
REPORT "CONNECT"
TIMEOUT "10"
"" "ATZ"
OK AT+CGDCONT=1,"ip","isp.telus.com"
OK AT+CGQREQ=1,2,4,3,6,31
OK AT+CGQMIN=1,2,4,3,6,31
OK AT+CGATT=1
OK ATD*99#
CONNECT \c
</pre>

= Novatel MC679 =

Tested on Alpine 2.4.5.

Add usb-modeswitch (currently only in testing repo):
{{cmd|apk add usb-modeswitch}}

/etc/modules:
<pre>
usbserial vendor=0x1410 product=0x7042
</pre>
/etc/usb_modeswitch.conf:
<pre>
# Configuration for the usb_modeswitch package, a mode switching tool for
# USB devices providing multiple states or modes
#
# This file is evaluated by the wrapper script "usb_modeswitch_dispatcher"
# in /usr/sbin
# To enable an option, set it to "1", "yes" or "true" (case doesn't matter)
# Everything else counts as "disable"

# Disable automatic mode switching globally (e.g. to access the original
# install storage)
DisableSwitching=0

# Enable logging (results in a extensive report file in /var/log, named
# "usb_modeswitch_<interface-name>" (and probably others)
EnableLogging=1

DefaultVendor= 0x1410
DefaultProduct=0x5059

TargetVendor= 0x1410
TargetProduct= 0x7042

MessageContent="5553424312345678000000000000061b000000020000000000000000000000"
NeedResponse=1
</pre>
/etc/network/interfaces
<pre>
auto ppp0
iface ppp0 inet ppp
provider MC679
pre-up usb_modeswitch -c /etc/usb_modeswitch.conf || true
</pre>
/etc/ppp/peers/MC679:
<pre>
debug
/dev/ttyUSB0
460800
crtscts
modem
noauth
usepeerdns
defaultroute
noipdefault
noccp
nobsdcomp
novj
connect '/usr/sbin/chat -v -f /etc/ppp/peers/chat-MC679-nopin'
</pre>
/etc/ppp/peers/chat-MC679-nopin:
<pre>
ABORT "BUSY"
ABORT "ERROR"
ABORT "NO CARRIER"
REPORT "CONNECT"
TIMEOUT "10"
"" "ATZ"
OK ATD*99#
CONNECT \c
</pre>