Alpine Linux - User contributions [en]

Upgrading Alpine Linux to a new release branch

2014-08-07T12:34:45Z

Blinkkin: /* Upgrading an Alpine Linux Hard-disk installation */

{{Warning|Make sure that you have a backup of your important data before continuing to update your system.}}

== Upgrading an Alpine Linux Hard-disk installation ==

=== Upgrading Alpine v2.x to v3.x ===

{{Warning|Alpine Linux 3.x is using a different libc implementation compared to previous versions. Musl libc is not ABI compatible with uClibc. Additional steps are required for an upgrade.}}

==== Installing statically linked tools ====

Statically linked version of apk-tools is needed, otherwise it will stop working after libc upgrade (possibly in the middle of upgrade). Static version of busybox can be handy in case of the recovery from a failure.

{{Cmd|apk add busybox-static apk-tools-static}}

==== Changing repositories to v3.x ====

To begin, you need to update your {{Path|/etc/apk/repositories}} file. Here are some shortcuts for doing so:
:* Launch {{Cmd|setup-apkrepos}} Enter {{Key|e}} to edit {{Path|/etc/apk/repositories}}. Change the version number by hand.
:* Or, edit the file in place. This is how you'd change <var>v2.7</var> to <var>v3.0</var>: {{Cmd|sed -i -e 's/<var>v2\.7</var>/<var>v3.0</var>/g' /etc/apk/repositories}}

==== Upgrading system ====

Use statically linked version of apk to update content of repository:

{{Cmd|apk.static update}}

Simulating upgrade is recommended in order to detect issues beforehand:

{{Cmd|apk.static upgrade --no-self-upgrade --simulate}}

With no problems encountered or after resolving them, start proper upgrade:

{{Cmd|apk.static upgrade --no-self-upgrade}}

=== Upgrading to latest release ===
{{:Include:Upgrading to latest release}}

=== Upgrading to Edge ===
{{:Include:Upgrading to Edge}}

=== Upgrading from older versions ===

See [[Upgrading from older versions]].

== Upgrading Alpine Linux on CD ==

You may have an installation where the boot media being used (such as a CD, for example) is separate from the media used to store the configuration information. In this case, simply download the latest ISO, and replace the boot media contents with the contents of the latest ISO. If you are booting from a CD, this would simply mean replacing the CD with a CD made from the new image and rebooting the Alpine Linux box.

=== Update remaining packages from Web repository ===

If you are using [[How_to_enable_APK_caching|APK caching]] you should also perform the following steps.
{{:Include:Using_Internet_Repositories_for_apk-tools}}

If you're upgrading from a version of Alpine before 2.3.0_rc1, ensure you have the latest available version of the Alpine Linux Package Manager first before upgrading anything else:
{{Cmd|apk add --upgrade apk-tools}}

Next, upgrade all your packages:

{{Cmd|apk upgrade --available
sync}}

The <code>--available</code> switch is used to force all packages to be upgraded, even if they have the same version numbers. Sometimes changes in uClibc require doing this.

After upgrading packages, save any configuration changes (you should have backed up your earlier configuration prior to upgrading).
{{Cmd|lbu ci}}

== Upgrading Alpine Linux on other removable media (such as CF/USB) ==

The following instructions are for run-from-RAM Alpine installations running on Compact Flash or USB media. Updating your repositories using [[#Upgrading_an_Alpine_Linux_Hard-disk_installation|the procedures detailed above]], then running:
{{Cmd|apk upgrade --update-cache --available}}
will suffice for some purposes. (If you want the new packages to be used after a reboot, you should [[How_to_enable_APK_caching|enable APK caching]].)

However, this is not an adequate general solution because it won't honor any kernel upgrades and the like. For the general solution, you'll need to upgrade your boot medium (Compact Flash or USB). That is what the following steps describe how to do.

{{:Include:Upgrading_Alpine_environmentvars}}

=== Upgrade Operating System ===

Start by checking that you have enough space on your media. For a '''standard''' Alpine image, you need at least 400MB available space.
{{Cmd|df -h {{!}} grep "Filesystem\{{!}}$LBU_MEDIA"}}

==== Download and verify new release ====

Make sure the media that holds your Alpine system is mounted readwrite.
{{Cmd|mount -oremount,rw /media/$LBU_MEDIA}}

'''If using Alpine Linux 2.2.3 or newer''': use the following command to download, mount and copy files as needed for you: {{Cmd|setup-bootable -u {{#latestalp:alpine|url}} /media/$LBU_MEDIA}} Once the command completes, proceed to the [[#Save changes|Save changes]] section.

==== For older versions of Alpine ====
Start downloading a new '.iso' and a '.sha1' file
{{Cmd|cd /media/$LBU_MEDIA
wget -c {{#latestalp:alpine|url}}
wget {{#latestalp:alpine|url}}.sha1}}

Check integrity of the downloaded files ''(it might take some time)'':
{{Cmd|sha1sum -c {{#latestalp:alpine|file}}.sha1}}
''The output of the above command should say 'OK'.<BR>''
''If says 'FAILED', delete the iso file and download it again.''

'''If using Alpine Linux 1.10.4 or newer''': there is a tool ''setup-bootable'' that will mount and copy the image you just downloaded to your boot medium. With this tool simply do: {{Cmd|setup-bootable -u {{#latestalp:alpine|file}} /media/$LBU_MEDIA}}

[[Upgrading from older versions#Upgrading_a_removable_medium_from_Alpine_before_1.10.4|Instructions for older versions of Alpine]] are located elsewhere.

=== Save changes ===
Now that all upgrades are done, we should save our settings to our media (which you hopefully have backed up prior to doing this upgrade).
{{Cmd|lbu ci}}

=== Load new kernel ===
In most cases you will need to reboot Alpine Linux (especially if there are changes in the kernel):
{{Cmd|sync
reboot}}

{{Note|If you know what you are doing, you might not need to reboot. But make sure that all services affected by the upgrade are restarted.}}

=== Update remaining packages from Web repository ===
If you are using [[How_to_enable_APK_caching|APK caching]] you should follow the instructions to [[#Update_remaining_packages_from_Web_repository|Update remaining packages from Web repository]], above.

[[Category:Installation]]
[[Category:Package Manager]]

Sandbox

2014-08-07T11:59:00Z

Blinkkin:

This is a test area.

{{#ifeq:one|one|yes|no}}

{{Warning|Alpine Linux 3.x is using a different libc implementation compared to previous versions. Musl libc is not ABI compatible with uClibc. Additional steps are required for an upgrade.}}

== Installing statically linked tools ==

Statically linked versions of busybox and apk are needed, otherwise they will stop working after libc upgrade.

{{Cmd|apk add busybox-static apk-tools-static}}

== Changing repositories to v3.x ==

To begin, you need to update your {{Path|/etc/apk/repositories}} file. Here are some shortcuts for doing so:
:* Launch {{Cmd|setup-apkrepos}} Enter {{Key|e}} to edit {{Path|/etc/apk/repositories}}. Change the version number by hand.
:* Or, edit the file in place. This is how you'd change <var>v2.7</var> to <var>v3.0</var>: {{Cmd|sed -i -e 's/<var>v2\.7</var>/<var>v3.0</var>/g' /etc/apk/repositories}}

== Upgrading system ==

Use statically linked version of apk to update content of repository:

{{Cmd|apk.static update}}

Simulating upgrade is recommended in order to detect issues beforehand:

{{Cmd|apk.static upgrade --no-selfupgrade --simulate}}

With no problems encountered or after resolving them, start proper upgrade:

{{Cmd|apk.static upgrade --no-selfupgrade}}

Alpine Linux in a chroot

2012-02-16T11:05:46Z

Blinkkin:

This document explains how to set up an Alpine build environment in a chroot under a "normal" Linux distro, such as Arch, Debian, Fedora, Gentoo, or Ubuntu. Once inside the chroot environment, you can build, debug, and run alpine packages.

== Requirements ==
You will need a few gigabytes of free disk space to have enough space for kernel compiling and storing all the binary packages.

== Creating the installation ==
This example installation of Alpine Linux in a chroot will work with the lastest release. But it's also possible to make a chroot with '''[[Edge|edge]]''' or older releases of Alpine Linux to test backports.

'''Note:''' The variables below:

*'''${build_dir}''' = You can name it whatever you like.
*'''${mirror}''' = Should be replaced with one of the available Alpine Linux mirrors.

Choose a mirror from the [http://dl-2.alpinelinux.org/alpine/MIRRORS.txt mirror list].

Let's start by getting the latest apk static package:

{{Tip|In the command below, replace x86_64 with x86 if running on a 32bit installation}}

{{Warning|You will need Kernel version 2.6.22 or later to use apk-tools-static}}

{{Cmd|wget http://dl-3.alpinelinux.org/alpine/v2.3/main/x86_64/apk-tools-static-2.2.1-r0.apk}}

Unpack the tarball
{{Cmd|tar -xzf apk-tools-static-2.2.1-r0.apk}}

We are setting up a basic chroot:

{{Cmd|mkdir ${build_dir}
sudo ./sbin/apk.static -X ${mirror}/v2.2/main -U --allow-untrusted --root ${build_dir} --initdb add alpine-base alpine-sdk
mkdir -p ./${build_dir}/proc
sudo mount --bind /proc ./${build_dir}/proc}}

Lets setup our needed devices:

{{Cmd|sudo mknod -m 666 ./${build_dir}/dev/full c 1 7
sudo mknod -m 666 ./${build_dir}/dev/ptmx c 5 2
sudo mknod -m 644 ./${build_dir}/dev/random c 1 8
sudo mknod -m 644 ./${build_dir}/dev/urandom c 1 9
sudo mknod -m 666 ./${build_dir}/dev/zero c 1 5
sudo mknod -m 666 ./${build_dir}/dev/tty c 5 0}}

seems as /dev/null is wrong

{{Cmd|sudo rm -f ./${build_dir}/dev/null && sudo mknod -m 666 ./${build_dir}/dev/null c 1 3}}

We need a resolv.conf is needed for the DNS servers and the /root directory:

{{Cmd|sudo cp /etc/resolv.conf ./${build_dir}/etc/
mkdir -p ./${build_dir}/root}}

If you don't want to copy the resolv.conf from the local machine, create this file with your DNS server entry.
{{Cmd|echo 'nameserver 8.8.8.8' >/etc/resolv.conf}}

We are setting up APK mirrors:

{{Cmd|sudo mkdir -p ./${build_dir}/etc/apk
echo "${mirror}/v2.2/main" > ./${build_dir}/etc/apk/repositories}}

== Entering your chroot ==
After the installation you should be able to enter your chroot:

{{Cmd|sudo chroot ./${build_dir} /bin/sh -l}}

If you are using Alpine as a Native build system you will have to make sure that chroot can run chmod. Add following to /etc/sysctl.conf

kernel.grsecurity.chroot_deny_chmod = 0

Then run the following command

{{Cmd|sysctl -p}}

== Alpine Linux in a chroot on Fedora ==

If you want to generate a chroot on a Fedora based system, you can use this [http://git.alpinelinux.org/cgit/fab/scripts/tree/alpine-chroot.sh script].

{{Note|Maybe you are able to use this script on other distribution but this is not tested.}}

Creating an Alpine package

2011-07-27T06:27:17Z

Blinkkin: add info about checking exit status with return 1

== General ==

This document assumes that you have a working [[Setting up the build environment|build environment]], or use a diskbased alpine installation.

=== The APKBUILDs ===

The ''[http://git.alpinelinux.org/cgit/abuild/ abuild]'' script reads the ''[http://git.alpinelinux.org/cgit/abuild/tree/sample.APKBUILD APKBUILD]'' and executes the steps needed to create a package.

=== The aports tree ===

The [http://git.alpinelinux.org/cgit/aports aports] tree is a [http://git.alpinelinux.org/cgit/aports/tree directory tree] with many APKBUILDs. Those files are used when building alpine from source.

== Installing and configuring the alpine-sdk ==

The alpine-sdk is a metapackage that pulls in the most essential packages used to build new packages.<BR>
Install those packages now:

{{Cmd|apk add alpine-sdk}}

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 /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 is in git so before we clone the aports tree we should configure git.

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

Now we can clone the aports tree.

{{Cmd|git clone git://dev.alpinelinux.org/aports}}

Before we start creating or modifying APKBUILD files we need to setup abuild to our system/user. Edit the file abuild.conf to your requirements. 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.

{{Cmd|sudo vi /etc/abuild.conf}}

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

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

The last step in preparation is to configure the security keys for abuild with the command:

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

== Getting some help ==

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

{{Cmd|abuild -h}}

== Creating an APKBUILD file ==

=== Use a template APKBUILD ===

To create the actual APKBUILD file <tt>newapkbuild</tt> 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.

{{Cmd|newapkbuild ''packagename''}}

'''newapkbuild options'''

* '''-a''' Create autotools (use ./configure ...)
* '''-c''' Copy a sample init.d, conf.d and install script to new directory
* '''-d''' Set package description (pkgdesc) to DESC
* '''-f''' Force even if directory already exist
* '''-h''' Show this help
* '''-l''' Set package license to LICENSE
* '''-p''' Create perl package (Assume Makefile.PL is there)
* '''-u''' Set package URL
* '''-s''' Use sourceforge source url

{{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. }}

If you are create 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.<BR>
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 'saveas-' to the protocol and append '/software-1.0.tar.gz' (for instance) to the end of the URI, like so:
: <pre>saveas-http://oss.example.org/?get=software&ver=1.0/software-1.0.tar.gz</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.

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

: {{Note|If the you want to download from https, you need GNU wget installed on your system.}}

* abuild currently supports the following archive types/archive file extensions:
** .tar.gz / .tgz
** .tar.bz2
** .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 it the package INSTALL and README file (or the likes). Another good way is the run ./configure --help from the source directory to see which options are needed for configure to finish without errors. If you do not yet have a src directory you can create one with the command:

{{Cmd|abuild unpack}}

Running configure will also show you how you can disable a specific option for this package. A good example is for instance "--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 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).

* [http://www.gentoo-portage.com Search ebuilds]
* [http://sources.gentoo.org/viewcvs.py/gentoo-x86/ Gentoo CVS]
* [http://www.archlinux.org/packages/search/ Arch Linux packages]

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 $depends variable. We do this by using scanelf. If scanelf is not yet installed on your system you can do that by installing pax-utils.

{{Cmd|scanelf -nR pkg}}

An example output of 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 ====

If a package has a special/custom license 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.

==== 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 usefully 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.

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 if you change something to your APKBUILD file without changing the actual $pkgver you can higer 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 add the missing dependency.

==== 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:

===== $pkgname.pre-install =====
This script is executed before package is installed. Typical use is when package needs a user/group to be created. For example:
<pre>
#!/bin/sh
adduser -H -s /bin/false -D 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 apk add will exit with failure.

===== $pkgname.post-install =====
This script is executed after package is installed. Can be used to generate font cache and similar.

===== $pkgname.pre-upgrade =====
Same as pre-install but is executed before upgrading an already installed package.

===== $pkgname.post-upgrade =====
Same as post-install but is executed after upgrading an already installed package.

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

===== $pkgname.post-deinstall =====
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>

If the package have an pre-install and post-install script the APKBUILD should have the ''install'' variable defined and the scripts should also be added to the source variable:
<pre>
...
install="$pkgname.pre-install $pkgname.post-install"
source="http://....
$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.

<br> 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 applications will have except doc and dev files other non needed at run time files which we want to separate away from the base package. 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. Way's to create them are:

directory compare:

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

file compare:

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

If you are going to use multiple patches for a single package, the preferred way to handle those is a loop and numbering the patches.

for i in "$srcdir"/*.patch; do
msg "Applying ${i}"
patch -p0 -i $i || return 1
done

Because multiple patches can patch the same file, we could create offset for the next patch. To make sure we always patch in a specified way we should number the patches as followed:

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

This way we are always sure patch 1 is first and if we want to add additional patches between them we can use 11,12,21,22...

==== 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.

{{Tip|Common steps for building package contain ''./configure'', ''make'' and ''make install''. Everyone of them should be enclosed by ''|| return 1'' to check exit status. Otherwise even if previous step fails e.g. ''./configure'', next will be launched e.g. ''make''. This complicates tracing the point, where package brakes. The same applies to installing additional files.}}

==== 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 || return 1

To disable parallel we use:

make -j1 || return 1

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 dependency's 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}}

== Commit your work ==

After you successfully build your package you can submit your APKBUILD to alpine 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 you local git repo. When you think you are ready you can add your files to git:

{{Cmd|cd $apkbuilddir
git add APKBUILD (include any other files needed for the build; $pkgname.install...)
git commit}}

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 diff (patch) of the changes you made and send this patch to the [http://lists.alpinelinux.org/alpine-devel/ alpine-devel mailinglist].

== Send a patch ==

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

== See Also ==
* [[APKBUILD Reference]]
* [[Development using git]]

Alpine security

2011-07-21T06:09:49Z

Blinkkin: add info about valgrind

Alpine Security provides a toolset to work on security auditing, forensics, system rescue, and teaching security testing methodologies.

== Basics ==

{| cellpadding="5" border="1" class="wikitable"
|-
! Name
! Description
! URL
|-
| alpine-base
| Alpine base package
| http://alpinelinux.org
|-
| bkeymaps
| Binary keymaps for busybox
| http://dev.alpinelinux.org/alpine/bkeymaps
|}

== Code Analysis ==

{| cellpadding="5" border="1" class="wikitable"
|-
! Name
! Description
! URL
|-
| rpmlint
| A tool for checking common errors in RPM packages
| http://rpmlint.zarb.org
|-
| splint
| An implementation of the lint program
| http://www.splint.org/
|-
| pylint
| Analyzes Python code looking for bugs and signs of poor quality
| http://pypi.python.org/pypi/pylint
|-
| flawfinder
| Examines C/C++ source code for security flaws
| http://www.dwheeler.com/flawfinder/
|-
| rats
| A tool to find security related programming errors
| https://www.fortify.com/ssa-elements/threat-intelligence/rats.html
|-
| valgrind
| A tool for finding memory-management problems
| http://valgrind.org/
|}

* pscan - Limited problem scanner for C source files

== Forensics / Data recovery tools ==

{| cellpadding="5" border="1" class="wikitable"
|-
! Name
! Description
! URL
|-
| dc3dd
| Patched version of GNU dd for use in computer forensics
| http://dc3dd.sourceforge.net/
|-
| testdisk
| A powerful free data recovery software
| http://www.cgsecurity.org/wiki/TestDisk
|-
| scrub
| Disk scrubbing program
| http://code.google.com/p/diskscrub/
|-
| ncdu
| A curses-based version of the well-known "du"
| http://dev.yorhel.nl/ncdu
|-
| htop
| An interactive process viewer for Linux
| http://htop.sourceforge.net/
|-
| mac-robber
| A tool that collects data from allocated files in a mounted file system
| http://www.sleuthkit.org/mac-robber/desc.php
|}

* diskrescue GNU data recovery tool http://www.gnu.org/software/ddrescue/ddrescue.html
* extcarve
* safecopy A data recovery tool http://safecopy.sourceforge.net/
* scalpel Fast file carver working on disk images http://www.digitalforensicssolutions.com/Scalpel/
* afftools - Utilities for afflib http://afflib.org/
* examiner - Utility to disassemble and comment foreign executable binaries
* firstaidkit - System Rescue Tool
* foremost - Recover files by "carving" them from a raw disk
* hexedit - A hexadecimal file viewer and editor
* ntfs-3g - Linux NTFS userspace driver
* ntfsprogs - NTFS filesystem libraries and utilities
* scanmem - Simple interactive debugging utility
* sleuthkit - The Sleuth Kit (TSK)
* srm - Secure file deletion
* unhide - Tool to find hidden processes and TCP/UDP ports from rootkits

== Reconnaissance ==

{| cellpadding="5" border="1" class="wikitable"
|-
! Name
! Description
! URL
|-
| arpon
| ARP handler inspection
| http://arpon.sourceforge.net/
|-
| dnsenum
| A tool to enumerate DNS info about domains
| http://code.google.com/p/dnsenum/
|-
| halberd
| A tool to discover HTTP load balancers
| http://halberd.superadditive.com/
|-
| scanssh
| Fast SSH server and open proxy scanner
| http://monkey.org/~provos/scanssh/
|-
| ngrep
| Network layer grep tool
| http://ngrep.sourceforge.net/
|-
| netsniff-ng
| A performant Linux network analyzer and networking toolkit
| http://netsniff-ng.org/
|-
| scapy
| Interactive packet manipulation tool and network scanner
| http://www.secdev.org/projects/scapy/
|-
| socat
| Bidirectional data relay between two data channels ('netcat++')
| http://www.dest-unreach.org/socat/
|-
| tcpdump
| A network traffic monitoring tool
| http://www.tcpdump.org/
|-
| tcptrack
| Displays information about tcp connections on a network interface
| http://www.rhythm.cx/~steve/devel/tcptrack/
|-
| tcpflow
| A tool for monitoring, capturing and storing TCP connections flows
| http://www.circlemud.org/~jelson/software/tcpflow/
|-
| tcpproxy
| Transparent TCP Proxy
| http://www.quietsche-entchen.de/cgi-bin/wiki.cgi/proxies/TcpProxy
|-
| etherdump
| An extremely small packet sniffer
| http://freshmeat.net/projects/etherdump/
|-
| netdiscover
| A network address discovering tool
| http://sourceforge.net/projects/netdiscover/
|-
| arpwatch
| An ethernet monitoring program
| http://www-nrg.ee.lbl.gov/
|}

* nuttcp http://www.nuttcp.net
* argus http://qosient.com/argus/
* tcpick http://tcpick.sourceforge.net/
* tcpreen -- A TCP/IP re-engineering and monitoring program
* tcpdump -- A network traffic monitoring tool
* tcpflow -- Network traffic recorder
* tcpick -- A tcp stream sniffer, tracker and capturer
* tcping -- Check of TCP connection to a given IP/Port
* tcpjunk -- TCP protocols testing tool
* tcpreplay -- Replay captured network traffic
* tcptraceroute -- A traceroute implementation using TCP packets
* tcptrack -- Displays information about tcp connections on a network interface
* tcputils -- Utilities for TCP programming in shell-scripts
* tcp_wrappers -- A security tool which acts as a wrapper for TCP daemons
* tcpxtract -- Tool for extracting files from network traffic
* ttcp A tool for testing TCP connections http://www.pcausa.com/Utilities/pcattcp.htm
* unicornscan http://www.unicornscan.org/
* dsniff - Tools for network auditing and penetration testing
* httpry
* justniffer
* dietsniff
* Nast http://nast.berlios.de/
* brutessh http://www.edge-security.com/brutessh.php
* ettercap http://ettercap.sourceforge.net/ A network traffic sniffer/analyser
* icmpshell A tool that only uses ICMP for connections http://icmpshell.sourceforge.net/

==Web Application Testing==

* proxystrike http://www.edge-security.com/proxystrike.php
* sqlmap http://sqlmap.sourceforge.net/
* ratproxy - A passive web application security assessment tool
* sqlninja
* burpproxy

== Misc tools ==

{| cellpadding="5" border="1" class="wikitable"
|-
! Name
! Description
! URL
|-
| iptraf
| A console-based network monitoring utility
| http://iptraf.seul.org/
|-
| iptop
| Command line tool that displays bandwidth usage on an interface
| http://www.ex-parrot.com/~pdw/iftop/
|-
| clamav
| An anti-virus toolkit for UNIX
| http://www.clamav.net
|-
| p7zip
| A command-line port of the 7zip compression utility
| http://p7zip.sourceforge.net/
|-
| nano
| A simple ncurses text editor
| http://www.nano-editor.org/
|-
| ethtool
| ...
| ...
|-
| fping
| A utility to ping multiple hosts at once
| http://fping.sourceforge.net/
|-
| rsync
| A file transfer program to keep remote files in sync
| http://rsync.samba.org/
|-
| screen
| A window manager that multiplexes a physical terminal
| http://www.gnu.org/software/screen/
|-
| multitail
| A tool to view one or multiple files
| http://www.vanheusden.com/multitail
|-
| shed
| A simple hex editor
| http://shed.sourceforge.net/
|-
| mtr
| Full screen ncurses traceroute tool
| http://www.bitwizard.nl/mtr/
|-
| e2fsprogs
| Standard Ext2/3/4 filesystem utilities
| http://e2fsprogs.sourceforge.net/
|-
| openssh
| An open source implementation of SSH protocol versions 1 and 2
| http://www.openssh.org/
|}

* macchanger An utility for viewing/manipulating the MAC address of network interfaces http://www.alobbs.com/macchanger

== Wireless ==

{| cellpadding="5" border="1" class="wikitable"
|-
! Name
! Description
! URL
|-
| weplab
| Analyzing WEP encryption security on wireless networks
| http://weplab.sourceforge.net/
|-
| kismet
| A WLAN detector, sniffer, and IDS
| http://www.kismetwireless.org/
|}

|-
| wavemon
| 0
| An ncurses-based monitoring application for wireless network devices.
| http://eden-feed.erg.abdn.ac.uk/wavemon/

|-
| aircrack-ng
| 802.11 (wireless) sniffer and WEP/WPA-PSK key cracker
| http://www.aircrack-ng.org/

* pgpry PGP private key recovery http://pgpry.sourceforge.net/
* airsnarf A rogue AP setup utility http://airsnarf.shmoo.com/
* lorcon http://802.11ninja.net/lorcon/ A library for injecting 802.11 (WLAN) frames

== Intrusion detection ==

{| cellpadding="5" border="1" class="wikitable"
|-
! Name
! Description
! URL
|-
| nebula
| An Intrusion Signature Generator
| http://nebula.carnivore.it/
|-
| snort
| A network intrusion prevention and detection system
| http://www.snort.org/
|}

* aide - Intrusion detection environment
* chkrootkit - Tool to locally check for signs of a rootkit
* honeyd - Honeypot daemon
* labrea - Tarpit (slow to a crawl) worms and port scanners
* pads - Passive Asset Detection System
* rkhunter - A host-based tool to scan for rootkits, backdoors and local exploits
* tiger Security auditing on UNIX systems http://www.nongnu.org/tiger/
* prelude-lml - The prelude log analyzer
* prewikka - Graphical front-end analysis console for the Prelude Hybrid IDS * Framework
* prelude-manager - Prelude-Manager

Upgrading to Edge

2011-06-20T15:49:52Z

Blinkkin: fix repository url

An upgrade of Alpine Linux from a stable version to the rolling development version, ''edge'' can be done in a few simple steps.

{{Warning|Edge is under constant development so be careful using it in production. It can break your system.}}

# Add the edge repository to ''/etc/apk/repositories'': {{Cmd|echo http://dl-3.alpinelinux.org/alpine/edge/main >> /etc/apk/repositories}} or just edit the file in-place (replace '''v2.2''' with your release) {{Cmd|sed -i -e 's/v2.2/edge/g' /etc/apk/repositories}}
# Upgrade all packages in one shot {{Cmd|apk upgrade -a -U}}
# Check your current release {{Cmd|cat /etc/alpine-release}} You will see the build date attached to the release.

Tutorials and Howtos

2011-06-18T06:09:31Z

Blinkkin: change link to more modern version of colinux guide

[[Image:package_edutainment.svg|left|link=]]
{{TOC right}}'''Welcome to Tutorials and Howtos, a place of basic and advanced configuration tasks for your Alpine Linux.'''
The tutorials are hands-on and the reader is expected to try and achieve the goals described in each step, possibly with the help of a good examples. The output in one step is the starting point for the following step.<br/>
Howtos are smaller articles explaining how to perform a particular task with Alpine Linux. We encourage people to send in both complete articles as well as requesting topics to be covered. If you think you have the skills and knowledge to write an Alpine Linux related article please do so on this Wiki. If you want to request a topic, please add your request in this page [[Talk:Tutorials_and_Howtos|Discussion]].

== Installation ==

* [[Setting up a basic vserver]]
* [[Setting up Logical Volumes with LVM]]
* [[Replacing non-Alpine Linux with Alpine remotely]]
* [[XFCE Setup]]
* [[Gnome Setup]]
* [[Enable Serial Console on Boot]]
* [[Alpine Linux package management#Local_Cache | How to enable APK caching]]
* [[Install Alpine on VirtualBox]]
* [[Setting up Alpine in a chroot]]
* [[Upgrading to Edge]]
* [[Setting up a software raid1 array]]
* [[Running Alpine Linux As a QEMU networked Guest ]]
* [[Manually editing a existing apkovl]]

== Networking ==
* [[Configure Networking]]
* [[Howto Configure a Network Bridge]]
* [[Howto Configure static routes]]
* [[Using serial modem]]
* [[Using HSDPA modem]]
* [[Using Alpine on Windows domain with IPSEC isolation]]
* [[Setting up Satellite Internet Connection]]
* [[Connecting to a wireless accesspoint]]

== iSCSI ==
* [[iSCSI Target and Initiator Configuration]]
* [[iSCSI Raid and Clustered File Systems]]
* [[High performance SCST iSCSI Target on Linux software Raid]]

== Network Services ==
* [[Setting Up Lighttpd With FastCGI]]
* [[Setting up a OpenVPN-server with Alpine]]
* [[Setting up Zaptel/Asterisk on Alpine]]
* [[Setting up Transmission (bittorrent) with Clutch WebUI]]
* [[Hosting services on Alpine]] ''(This applies to hosting mail, webservices and other services)''
** [[Setting up postfix with virtual domains]]
** [[Protecting your email server with Alpine]]
** [[Hosting Web/Email services on Alpine]]
* [[Setting up a ssh-server]]
* [[Multiple Instances of Services]]
* [[ISP Mail Server HowTo]] ''(Postfix+PostfixAdmin+DoveCot+Roundcube+ClamAV+Spamd - A full-serivce ISP mail server)''
** [[ISP Mail Server Upgrade 2.x]]
** [[ISP Mail Server 2.x HowTo]] ''(Beta, please test)''
* [[Freepbx on Alpine Linux]]
* [[Apache authentication: NTLM Single Signon]]
* [[Generating SSL certs with ACF]]
* [[Changing passwords for ACF]]
* [[Freeradius Active Directory Integration]]
* [[High Availability High Performance Web Cache]] ''uCarp + HAProxy for High Availability Services such as Squid web proxy''

== Web Applications ==
* [[2600hz]] ''FreeSWITCH, Asterisk GUI web acces tool.''
* [[Awstats]] ''Free log file analyzer.''
* [[Drupal]] ''Content Management System (CMS) written in PHP.''
* [[EyeOS]] ''Cloud Computing Desktop.''
* [[FreePBX_V3]] ''FreeSWITCH, Asterisk GUI web acces tool.''
* [[Glpi]] ''Information Resource-Manager.''
* [[MediaWiki]] ''Free web-based wiki software application''
* [[Phpizabi]] ''Social Networking Platform.''
* [[PhpPgAdmin]] ''Web-based administration tool for PostgreSQL.''
* [[Phpmyadmin]] ''Web-based administration tool for MYSQL.''
* [[Redmine]] ''Project management system ''
* [[Request-Tracker]] ''Ticket system''
* [[Roundcube]] ''Webmail system''
* [[Statusnet]] ''Microblogging Platform.''
* [[Sqstat]] ''Script to look active squid users connections.''
* [[Webmin]] ''A web-based interface for Linux system.''
* [[WordPress]] ''Web software to create website or blog. ''

== Monitoring ==
* [[Traffic monitoring]] ''(For Alpine Linux firewalls)''
* [[Setting up traffic monitoring using rrdtool (and snmp)]]
* [[Setting up Smokeping]] ''(Smokeping network latency monitoring)''
* [[Setting up Cacti]]
* [[Setting up NRPE daemon]] ''(Performs remote Nagios checks)''
* [[Setting up Zabbix]]
* [[Setting Up Fprobe And Ntop]] ''NetFlow collection and analysis''

== Misc ==
* [[Setting up lm_sensors]]
* [[Formatting HD/Floppy/Other]]
* [[Screen on console]]
* [[Using espeak on Alpine Linux]]
* [[IPTV How To]]
* [[Pllua]]
* [[Error message on boot: Address space collision: host bridge window conflicts with Adaptor ROM]]

== Drafts ==
Those are not finished yet.
* [[Install Alpine on coLinux]]
* [[Using Racoon for Remote Sites]]
* [[High Performance and Fault Tolerant Routing with Alpine Linux]]
* [[Setting up Transparent Squid Proxy]] ''(Covers Squid proxy and URL Filtering system)''
** [[Obtaining user information via SNMP]] ''(Using the Squark Squid authentication helper)''
* [[Setting up Streaming an Asterisk Channel]]
* [[Setting up A Network Monitoring and Inventory System]] ''((Nagios + OpenAudit and related components)''
* [[Intrusion Detection using Snort]] ''Installing and configuring Snort and related applications on Alpine 2.0.x''
* [[IP Accounting]] ''Installing and configuring pmacct for IP Accounting, Netflow/sFlow collector''
* [[Howto Setup a Wireless Access Point]] ''Setting up Secure Wireless AP w/ WPA encryption with bridge to wired network''

== Obsolete Docs ==
Those are candidates for rewriting/removal.
* [[Bootstrapping Alpine on Soekris net4xxx]]
* [[Bootstrapping Alpine on PC Engines ALIX.3]]
* [[Setting up a /var partition on software IDE raid1]]
* [[Native Harddisk Install]]
* [[Installing XUbuntu using Alpine boot floppy]]
* [[Setting up trac wiki]]

Talk:Install Alpine on coLinux

2011-06-15T15:36:08Z

Blinkkin: Created page with "English isn't even my second language, so any fixes regarding grammar and so on are more than welcomed. Also formatting is far from perfect, but hopefully I'll fix that sooner th..."

English isn't even my second language, so any fixes regarding grammar and so on are more than welcomed. Also formatting is far from perfect, but hopefully I'll fix that sooner than later. -- [[User:Blinkkin|Blinkkin]] 15:36, 15 June 2011 (UTC)

Installation

2011-06-07T14:31:58Z

Blinkkin: update download url

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

= Installation Quick-Start in 3 Easy Steps =
<div style="float:left; font-size:30px; font-weight:bold;">
1st
</div>
<div style="margin-left:65px; background-color:#EDF2F2; border-style:solid; border-color:#6F7C91; border-width:0px; border-left-width:5px; min-height:55px; padding:5px;">
[http://alpinelinux.org/downloads Download] the latest stable-release ISO.
</div>

<div style="float:left; font-size:30px; font-weight:bold;">
2nd
</div>
<div style="margin-left:65px; background-color:#E0E9E9; border-style:solid; border-color:#606A82; border-width:0px; border-left-width:5px; min-height:55px; padding:5px;">
Burn the ISO onto a blank CD using your favorite CD burning software.
</div>

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

<br />
{{Tip|One of the first commands you might want to use is `setup-alpine`}}
{{Tip|For RAM-based installs, continue by reading about [[Alpine local backup|Alpine Local Backup]]. Otherwise, for HDD-based installs, etc., continue reading one of the documents below.}}
<br />

= Installation Handbook =

* [[Installing Alpine on USB]]
* [[Installing Alpine on Compact Flash]]
* [[Installing Alpine on HDD overwriting everything ]] ''(Quick and dirty install on a new machine)''
* [[Installing Alpine on HDD dualbooting]]
* [[Upgrading Alpine]]
* [[Booting ISO in VMWare]]
* [[Booting Alpine on an HP ML350 G6|Booting old Alpine on HP ML350 G6]]