https://wiki.alpinelinux.org/w/api.php?action=feedcontributions&feedformat=atom&user=RickyrockratAlpine Linux - User contributions [en]2026-04-25T15:41:11ZUser contributionsMediaWiki 1.40.0https://wiki.alpinelinux.org/w/index.php?title=How_to_set_up_Alpine_as_a_wireless_router&diff=26380How to set up Alpine as a wireless router2024-02-11T23:51:48Z<p>Rickyrockrat: /* Permissive iptables */</p>
<hr />
<div>{{Style}}<br />
<br />
=== Pi Zero W Wireless Router ===<br />
<br />
This page describes building a Wireless Access Point with two wired ethernet ports for building a home router that connects to the internet with one wired port, and an internal LAN with the second wired port and the on-board WiFi.<br><br />
<br />
The intent is to provide this:<br><br />
<pre><br />
|<-->eth1 <-->| <br />
Internet <--> eth0 <-->FireWall<-->br0 Internal<--> ssh,bind,dhcp, with ssh reverse ssh connections.<br />
|<-->wlan0<-->|<br />
</pre><br />
<br />
=== Overview ===<br />
I generally run Debian and when forced by Red Hot Irons, Red Hat. This is my first foray into Alpine. So far I am very impressed. I mirrored the 3.12 armhf repos so I had things local when I needed them. Word to the wise, it comprises 13 GB of apk files.<br><br />
One *really* nice feature of Alpine is apk, the yum/apt replacement:<br><br />
* It is simple and to the point.<br />
* The same tool provides *repo* level dependency reporting!<br />
* Install of single packages without repo signing (I never did get the signing correct, but I can install).<br />
<br />
=== Prepare ===<br />
* Obtain a microSD card (or HDD) you can wipe the data from. We will assume it is /dev/sdc.<br />
* Make a 256M FAT16 partition (sudo mkfs.vfat -n ALPBOOT /dev/sdc1)<br />
* The rest of the device can be ext2 (ext3/4 on HDD) (sudo mke2fs -m1 -L alext3 /dev/sdc2).<br />
* Untar the alpine-rpi-3.12.3-armhf.tar.gz and copy all of the files to the fat16 partition which can be as large as 2G. <br />
* Make sure you have all the packages from the package list below installed on the SD card. This will save you lots of time.<br />
* Add this to usercfg.txt at the root of the FAT16 partition:<br />
enable_uart=1<br />
gpu_mem=16<br />
dtparam=audio=off<br />
* This is the contents of cmdline.txt:<br />
modules=loop,squashfs,sd-mod,usb-storage console=tty1 console=ttyAMA0,115200<br />
<br />
=== First Boot ===<br />
* Put the SD into the pi zero<br />
* Connect the serial port<br />
* Run minicom with the parameters set to 115200,n,8,1, no flow control.<br />
* Power up the Pi.<br />
<br />
=== Copy Root ===<br />
* mkdir /stage<br />
* mount /dev/sda2 /stage<br />
* for d in $(ls -1 /|grep -v 'media\|stage\|dev\|proc\|sys'); do cp -a /$d /stage; done<br />
* modules are loop mounted to /.modloop, and lib/modules is symlinked to that, so<br />
* rm /stage/lib/modules<br />
* cp -a /.modloop /stage/lib/modules<br />
* Fix cmdline.txt<br />
mount -o remount,rw /media/mmcblk0p1<br />
echo 'root=/dev/mmcblk0p2' >> /media/mmcblk0p1/cmdline.txt<br />
* reboot<br />
<br />
=== Install ===<br />
* verify you are now operating from the ext2 filesystem where you copied the rootfs.<br />
* install openssh, openssh-server, openssh-client, openssh-server-common,<br />
* install dnsmasq, ethtool, hostapd*, busybox extras, iptables*, iw,net-tools, tree, wireless-tools.<br />
* edit all the configurations supplied here.<br />
<br />
===== ssh config =====<br />
The allowed users are not normal names since I want the names to be a little obfuscated. Not that it really matters, since this is a key driven setup<br><br />
AddressFamily inet<br><br />
ListenAddress 0.0.0.0<br><br />
HostKey /etc/ssh/ssh_host_rsa_key<br><br />
LogLevel INFO<br><br />
LoginGraceTime 30<br><br />
PermitRootLogin no<br><br />
StrictModes yes<br><br />
AllowUsers Som123X Extern4524User<br><br />
PubkeyAuthentication yes<br><br />
AuthorizedKeysFile /etc/ssh/authorized_keys<br><br />
HostbasedAuthentication yes<br><br />
IgnoreUserKnownHosts yes<br><br />
IgnoreRhosts yes<br><br />
PasswordAuthentication no<br><br />
ChallengeResponseAuthentication no<br><br />
AllowTcpForwarding yes<br><br />
GatewayPorts yes<br><br />
X11Forwarding no<br><br />
<br />
<br />
===== dnsmasq.conf =====<br />
/etc/dnsmasq.conf<br><br />
This has two subnets. One for normal dhcp, the other for pseudo static - dhcp provided by MAC. One example here.<br><br />
<pre><br />
interface=br0<br />
except-interface=eth0<br />
dhcp-range=subnet0,192.168.0.10,192.168.0.100,255.255.255.0,24h<br />
dhcp-range=subnet1,192.168.0.4,192.168.0.6,255.255.255.0,24h<br />
bind-interfaces<br />
#log-queries<br />
#log-dhcp<br />
dhcp-host=70:85:66:c4:48:55,192.168.0.4,nas<br />
</pre><br />
<br />
===== /etc/hosts =====<br />
dnsmasq provides DNS answers from the hosts file. Nice. <br><br />
<pre><br />
127.0.0.1 localhost localhost.localdomain<br />
::1 localhost localhost.localdomain<br />
192.168.0.3 wireless<br />
192.168.0.4 nas<br />
192.168.0.5 mpd<br />
</pre><br />
<br />
===== hostapd.conf =====<br />
/etc/hostapd/hostapd.conf<br><br />
<pre><br />
interface=wlan0<br />
bridge=br0<br />
hw_mode=g<br />
channel=7<br />
wmm_enabled=0<br />
macaddr_acl=0<br />
auth_algs=1<br />
ignore_broadcast_ssid=0<br />
wpa=2<br />
wpa_key_mgmt=WPA-PSK<br />
wpa_pairwise=TKIP<br />
rsn_pairwise=CCMP<br />
ssid=Whatever<br />
wpa_passphrase=YouMakeItUp<br />
</pre><br />
<br />
===== interfaces =====<br />
/etc/network/interfaces<br><br />
<pre><br />
auto lo<br />
iface lo inet loopback<br />
<br />
auto eth0<br />
iface eth0 inet dhcp<br />
hostname ANYNAME<br />
hwaddress ether FE:ED:BE:EF:33:DD<br />
<br />
iface eth1 inet manual<br />
iface wlan0 inet manual<br />
<br />
auto br0<br />
iface br0 inet static<br />
pre-up ifconfig eth1 up<br />
bridge-ports eth1 wlan0<br />
bridge-stp off<br />
address 192.168.0.3<br />
broadcaset 192.168.1.255<br />
netmask 255.255.255.0<br />
</pre><br />
<br />
===== Permissive iptables =====<br />
Do NOT use this connected to the internet! There is NO protection.<br><br />
This is my stopopen in my replacement iptables<br><br />
iptables -P INPUT ACCEPT<br><br />
iptables -F INPUT<br><br />
iptables -P OUTPUT ACCEPT<br><br />
iptables -F OUTPUT<br><br />
iptables -P FORWARD ACCEPT<br><br />
iptables -F FORWARD<br><br />
iptables -F -t nat<br><br />
iptables -F<br><br />
<br />
=== References ===<br />
apk notes:<br />
<br />
* Create, index and check dependencies on a list of apk files: apk index -o APKINDEX.unsigned.tar.gz *.apk<br />
* Install a package: apk add iw OR apk add /path/to/iw-5.4-r0.apk<br />
* remove a package: apk del iw<br />
* repository lists are in: /etc/apk/repositories<br />
* Local URL: /media/mmcblk0p1/apks<br />
* Remote URL: http://dl-cdn.alpinelinux.org/alpine/v3.12/main<br />
<br />
[https://en.wikipedia.org/wiki/File_Allocation_Table FAT16/32 limits]<br><br />
[https://udhcp.busybox.net/README.udhcpc udhcpc]<br><br />
[https://linux.die.net/man/8/ez-ipupdate ez-ipupdate]<br><br />
[[Alpine_Linux:FAQ#Dynamic_DNS|Dynamic_DNS]]<br><br />
[[Bridge|Alpine Linux Bridge]]<br><br />
[[Connecting_to_a_wireless_access_point|Connect to wireless AP]]<br><br />
[https://unix.stackexchange.com/questions/222264/how-do-i-limit-dnsmasq-listening-to-only-one-interface dnsmasq listen restrictions]<br><br />
[https://wiki.archlinux.org/index.php/IPv6#Disable_IPv6 Disable IPV6]<br><br />
[https://github.com/imp/dnsmasq/blob/master/dnsmasq.conf.example dnsmasq Docs]<br><br />
[https://man.openbsd.org/hostapd.conf.5 HostApd Docs]<br><br />
[rsync://rsync.alpinelinux.org/alpine Alpine Repos]<br><br />
[https://stevessmarthomeguide.com/home-network-dns-dnsmasq Set Static DNS names]<br><br />
[https://unix.stackexchange.com/questions/504100/how-to-create-ssh-reverse-tunnel-with-iptables-forwarding Reverse SSH tunnel]<br><br />
===== Pi Related =====<br />
[https://github.com/rickyrockrat/nanopi-alpine NanoPi NEO build script]<br><br />
===== Pi Specific =====<br />
[https://raspberrypi.stackexchange.com/questions/89803/access-point-as-wifi-router-repeater-optional-with-bridge/89804 Pi Wifi Repeater]<br><br />
[https://raspberrypi.stackexchange.com/questions/81486/raspberry-pi-wifi-to-ethernet-bridge-for-a-server/81518 WiFi Bridge]<br><br />
[[Raspberry_Pi|Alpine Install]]<br><br />
[[Classic_install_or_sys_mode_on_Raspberry_Pi|Classic Sys Install on Pi]]<br><br />
<br />
==== Not Related, but Interesting ====<br />
[https://blog.thewalr.us/2017/09/26/raspberry-pi-zero-w-simultaneous-ap-and-managed-mode-wifi AP and Managed Mode]<br><br />
[https://www.instructables.com/Using-a-Raspberry-PI-Zero-W-As-an-Access-Point-and AP and MQTT]<br><br />
<br />
==== Package List ====<br />
Put these in the apks/armhf directory on the 256M Fat partition:<br><br />
<br />
iptables-1.8.4-r2.apk openssh-8.3_p1-r1.apk<br />
iptables-openrc-1.8.4-r2.apk openssh-client-8.3_p1-r1.apk<br />
abuild-3.6.0-r1.apk iw-5.4-r0.apk openssh-keygen-8.3_p1-r1.apk<br />
alpine-base-3.12.3-r0.apk kbd-bkeymaps-2.2.0-r2.apk openssh-server-8.3_p1-r1.apk<br />
alpine-baselayout-3.2.0-r7.apk libacl-2.2.53-r0.apk openssh-server-common-8.3_p1-r1.apk<br />
alpine-conf-3.9.0-r1.apk libattr-2.4.48-r0.apk openssh-sftp-server-8.3_p1-r1.apk<br />
alpine-keys-2.2-r0.apk libblkid-2.35.2-r0.apk openssl-1.1.1i-r0.apk<br />
alpine-mirrors-3.5.10-r0.apk libc-utils-0.7.2-r3.apk patch-2.7.6-r6.apk<br />
apk-tools-2.10.5-r1.apk libcap-2.27-r0.apk pcsc-lite-libs-1.8.26-r0.apk<br />
attr-2.4.48-r0.apk libcom_err-1.45.6-r0.apk pkgconf-1.7.2-r0.apk<br />
bash-5.0.17-r0.apk libcrypto1.1-1.1.1i-r0.apk ppp-atm-2.4.8-r2.apk<br />
bash-completion-2.10-r0.apk libcurl-7.69.1-r3.apk ppp-chat-2.4.8-r2.apk<br />
bonding-2.6-r4.apk libedit-20191231.3.1-r0.apk ppp-daemon-2.4.8-r2.apk<br />
bridge-1.5-r4.apk libev-4.33-r0.apk ppp-l2tp-2.4.8-r2.apk<br />
bridge-utils-1.6-r0.apk libgcc-9.3.0-r2.apk ppp-minconn-2.4.8-r2.apk<br />
busybox-1.31.1-r19.apk libmnl-1.0.4-r0.apk ppp-passprompt-2.4.8-r2.apk<br />
busybox-extras-1.31.1-r19.apk libnftnl-1.1.6-r0.apk ppp-passwordfd-2.4.8-r2.apk<br />
busybox-initscripts-3.2-r2.apk libnftnl-libs-1.1.6-r0.apk ppp-pppoe-2.4.8-r2.apk<br />
busybox-suid-1.31.1-r19.apk libnl3-3.5.0-r0.apk ppp-radius-2.4.8-r2.apk<br />
c-ares-1.16.1-r0.apk libpcap-1.9.1-r2.apk ppp-winbind-2.4.8-r2.apk<br />
ca-certificates-20191127-r4.apk libssl1.1-1.1.1i-r0.apk readline-8.0.4-r0.apk<br />
ca-certificates-bundle-20191127-r4.apk libstdc++-9.3.0-r2.apk scanelf-1.2.6-r0.apk<br />
chrony-3.5.1-r0.apk libtls-standalone-2.9.1-r1.apk signature.tar.gz<br />
chrony-openrc-3.5.1-r0.apk libusb-1.0.23-r0.apk ssl_client-1.31.1-r19.apk<br />
curl-7.69.1-r3.apk libuuid-2.35.2-r0.apk tar-1.32-r1.apk<br />
dbus-libs-1.12.18-r0.apk lzip-1.21-r0.apk tcpdump-4.9.3-r2.apk<br />
dnsmasq-2.81-r0.apk mii-tool-1.60_git20140218-r2.apk tree-1.8.0-r0.apk<br />
e2fsprogs-1.45.6-r0.apk musl-1.1.24-r10.apk tzdata-2020c-r1.apk<br />
e2fsprogs-libs-1.45.6-r0.apk musl-utils-1.1.24-r10.apk usb-modeswitch-2.6.0-r1.apk<br />
ethtool-5.6-r0.apk ncurses-libs-6.2_p20200523-r0.apk vlan-2.2-r0.apk<br />
ez-ipupdate-3.0.10-r9.apk ncurses-terminfo-base-6.2_p20200523-r0.apk wireless-tools-30_pre9-r1.apk<br />
fakeroot-1.24-r0.apk net-tools-1.60_git20140218-r2.apk wpa_supplicant-2.9-r5.apk<br />
haveged-1.9.8-r1.apk network-extras-1.2-r0.apk wpa_supplicant-openrc-2.9-r5.apk<br />
haveged-openrc-1.9.8-r1.apk nghttp2-1.41.0-r0.apk zlib-1.2.11-r3.apk<br />
hostapd-2.9-r2.apk nghttp2-libs-1.41.0-r0.apk<br />
hostapd-openrc-2.9-r2.apk openrc-0.42.1-r11.apk</div>Rickyrockrathttps://wiki.alpinelinux.org/w/index.php?title=Creating_an_Alpine_package&diff=26379Creating an Alpine package2024-02-11T23:45:10Z<p>Rickyrockrat: /* Overview */</p>
<hr />
<div>{{TOC right}}<br />
== Overview ==<br />
<br />
This is a brief list of the steps to add a new package. Details are below, but a NB can miss a few steps.<br />
<ol><br />
<li>Create an account on github.alpine<br />
<li>Setup the build environment for aports.<br />
<li>Fork the aports repository. <br />
<li>Clone your new fork.<br />
<li>Set git pull.rebase=true, set your username and email.<br />
<li>Create and switch to a new branch (don't use master).<br />
<li>Add a new directory under testing that is your new package name.<br />
<li>Add your APKBUILD file.<br />
<li>Run abuild checksum<br />
<li>Make sure you run the apkbuild-lint and aport -r and there are no warnings.<br />
<li>Commit your APKBUILD with the commit message: 'testing/packagename: new aport'<br />
<li>Push your changes to your fork on github.alpine.<br />
<li>Create a merge request.<br />
</ol><br />
<br />
Please see the rest of this wiki for details on the steps above.<br />
<br />
== Requirements ==<br />
<br />
To build a package for Alpine Linux you need an Alpine Linux installation. Check the [[Installation]] page to see all available installation options.<br />
<br />
== Setup your system and account ==<br />
{{:Setup_your_system_and_account_for_building_packages}}<br />
<br />
== Getting some help ==<br />
<br />
It might be wise to start by checking what the [[Abuild and Helpers|abuild]] program can/cannot do.<br />
<br />
{{Cmd|abuild -h}}<br />
<br />
For real help, you can also go on #alpine-devel on [[IRC]].<br />
<br />
A reference for APKBUILD files is available as [[APKBUILD Reference]] wiki page or a man page in the 'abuild-doc' package:<br />
<br />
{{Cmd|man APKBUILD}}<br />
<br />
<br />
== Creating an APKBUILD file ==<br />
<br />
=== Use a template APKBUILD ===<br />
<br />
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.<br />
<br />
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.<br />
<br />
{{:Abuild and Helpers}}<br />
<br />
{{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. }}<br />
<br />
[[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. <br />
<br />
If you are creating a daemon package which needs initd scripts you can add the -c making it: <br />
<br />
{{Cmd|newapkbuild -c ''packagename''}}<br />
<br />
This will copy the sample initd and confd files to the build directory.<BR><br />
A third file sample.install file will be copied as well (we will discuss this later on).<br />
<br />
=== Modify your APKBUILD ===<br />
Edit APKBUILD and fill in the needed info (especially pkgname, pkgver, pkgdesc, url, license, depends and source). <br />
<br />
If you are going to use any of the variables for directories like $pkgdir, always make sure they are double quoted like: <br />
<br />
"$pkgdir"/somedir<br />
<br />
This will prevent issues with spaces/special characters in the future. <br />
<br />
{{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.}}<br />
<br />
=== APKBUILD variables/functions ===<br />
<br />
==== source ====<br />
<br />
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.<br />
<br />
Here are few things to note:<br />
<br />
* 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:<br />
: {{cmd|abuild checksum}}<br />
: {{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.}}<br />
<br />
* When the remote file is hosted at SourceForge, it's best to specify the special mirrors link used by SourceForge:<br />
: <pre>http://downloads.sourceforge.net/$pkgname/$pkgname-$pkgver.tar.gz</pre><br />
: (or similar depending on the package).<br />
<br />
* When the remote filename is not specified in the URI (ie, does not end in '/software-1.0.tar.gz'), such as:<br />
: <pre>http://oss.example.org/?get=software&ver=1.0</pre><br />
: You must prepend '${pkgname}-${pkgver}.tar.gz::' to the protocol, like so:<br />
: <pre>source="${pkgname}-${pkgver}.tar.gz::http://oss.example.org/?get=software&ver=1.0"</pre><br />
: 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.<br />
<br />
* 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>https://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.<br />
<br />
* abuild currently supports the following protocols for remote file retrieval:<br />
** http<br />
** https<br />
** ftp<br />
<br />
<!--: {{Note|If the you want to download from https, you need GNU wget installed on your system.}}--><br />
<br />
* abuild currently supports the following archive types/archive file extensions:<br />
** .tar<br />
** .tar.gz / .tgz<br />
** .tar.bz2<br />
** .tar.lz (only in Alpine >=3.7)<br />
** .tar.lzma<br />
** .tar.xz<br />
** .zip<br />
<br />
==== depends &amp; makedepends ====<br />
<br />
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 [https://en.wikipedia.org/wiki/Rtfm RTFM]. <br />
<br />
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: <br />
<br />
{{Cmd|abuild unpack}}<br />
<br />
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, ...). <br />
<br />
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.<br />
<br />
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).<br />
<br />
* [https://gitweb.gentoo.org/repo/gentoo.git/tree/ Gentoo Ebuilds] <br />
* [https://archlinux.org/packages/?q=search Arch Linux packages] [https://aur.archlinux.org/ Arch Linux User Repository]<br />
<br />
==== license ====<br />
<br />
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.<br />
<br />
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.<br />
<br />
Note that some licenses have additional requirements that should be adhered to. The <code>MIT</code> license for example has the requirement:<br />
<br />
<blockquote><br />
The above copyright notice and this permission notice (including the next paragraph) shall be included in all copies or substantial portions of the Software.<br />
</blockquote><br />
<br />
This means that we need to include the license as shipped with the project.<br />
<br />
If a package has a special/custom license or is not listed as [https://opensource.org/licenses/alphabetical OSI approved], use the identifier "custom". In that case we need to provide the license file with the package as well.<br />
<br />
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: <br />
<br />
subpackages="$pkgname-doc"<br />
<br />
Add a similar line to the following to your package() function, depending on the license description file: <br />
<br />
{{Cmd|install -Dm644 COPYING "$pkgdir"/usr/share/licenses/$pkgname/COPYING}}<br />
<br />
If you follow these steps then abuild will automatically add the license to the package-doc apk for you.<br />
<br />
{{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. }}<br />
<br />
==== arch ====<br />
<br />
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 (e.g., a pure-python package).<br />
{{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.}}<br />
<br />
==== url ====<br />
<br />
Website address for the program. This is useful later on when either finding documentation or other information about the package.<br />
<br />
==== pkgdesc ====<br />
<br />
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.<br />
<br />
Here is an example from apk_info for the OpenSSH client package:<br />
<br />
pkgdesc="Port of OpenBSD's free SSH release - client"<br />
<br />
==== pkgver ====<br />
<br />
Provide the release number of the package you are building.<br />
<br />
==== pkgrel ====<br />
<br />
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.<br />
<br />
==== pkgname ====<br />
<br />
The base name of the package you are creating. For Freeswitch 1.0.6, you would use "freeswitch"<br />
<br />
==== install ====<br />
<br />
There are 6 different kinds of install scripts. Each script is called with the $pkgname.''<action>'' where ''<action>'' is one of the following:<br />
<br />
<dl><br />
<dt>$pkgname.pre-install<br />
<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:<br />
<pre><br />
#!/bin/sh<br />
<br />
addgroup -S clamav 2>/dev/null<br />
adduser -S -D -H -s /bin/false -G clamav -g clamav clamav 2>/dev/null<br />
<br />
exit 0<br />
</pre><br />
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.<br />
<br />
<dt>$pkgname.post-install<br />
<dd>This script is executed after the package is installed.<br />
<br />
<dt>$pkgname.pre-upgrade<br />
<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.<br />
<br />
<dt>$pkgname.post-upgrade<br />
<dd>Same as post-install but is executed after upgrading/downgrading/reinstalling an already installed package. <br />
<br />
<dt>$pkgname.pre-deinstall<br />
<dd>This script is executed before uninstalling a package. If script exits with failure apk will not uninstall the package.<br />
<br />
<dt>$pkgname.post-deinstall<br />
<dd>This script is executed after a package have been uninstalled. For example, can be used to restore busybox links:<br />
<pre><br />
#!/bin/sh<br />
busybox --install -s<br />
</pre><br />
<br />
</dl><br />
<br />
If the package has a pre-install and post-install script the APKBUILD should have the ''install'' variable defined:<br />
<pre><br />
...<br />
install="$pkgname.pre-install $pkgname.post-install"<br />
<br />
...<br />
</pre><br />
<br />
==== subpackages ====<br />
<br />
$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. <br />
<br />
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. <br />
<br />
To see if you need the -dev package you can run the following cmd: <br />
<br />
{{Cmd|find pkg/usr/ -name '*.[acho]' -o -name '*.la'}}<br />
<br />
If this returns any files you need to include the -dev package. <br />
<br />
<br> To see if you need the -doc package you can run the following cmd: <br />
<br />
{{Cmd|find pkg/usr/share -name doc -o -name man -o -name info -o -name html -o -name sgml -o -name licenses}}<br />
<br />
If this returns any directories you need to include the -doc package. <br />
<br />
===== Custom subpackages =====<br />
<br />
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: <br />
<br />
test() {<br />
mkdir -p "$subpkgdir"/usr<br />
mv "$pkgdir"/usr/package-test "$subpkgdir"/usr/<br />
# or amove usr/package-test<br />
}<br />
<br />
<br />
We also need to add the package info to $subpackages variable: <br />
<br />
subpackages="$pkgname-doc $pkgname-dev $pkgname-test"<br />
<br />
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. <br />
<br />
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: <br />
<br />
depends="perl"<br />
makedepends="perl-dev"<br />
<br />
If we would install the base package it would not install perl, but if we install the package-test package it would.<br />
<br />
==== Patches ====<br />
<br />
Please make sure you always submit human readable patches. Ways to create them are: <br />
<br />
directory compare: <br />
<br />
{{Cmd|diff -Nurp original_directory new_directory &gt; filename.patch}}<br />
<br />
file compare: <br />
<br />
{{Cmd|diff -up original.file new.file &gt; filename.patch}}<br />
<br />
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.<br />
<br />
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: <br />
<br />
10-patch1.patch 20-patch2.patch 30-patch3.patch<br />
<br />
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).<br />
<br />
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:<br />
<br />
prepare() {<br />
default_prepare<br />
<br />
# do your stuff<br />
}<br />
<br />
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''.<br />
<br />
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.<br />
<br />
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.<br />
<br />
{{Cat|example.patch|<nowiki><br />
Author: John Doe <johndoe@mail.com><br />
URL: http://.....<br />
Summary: Fixes musl compatibility<br />
----<br />
--- a/src/3rdparty/chromium/third_party/WebKit/Source/wtf/Assertions.cpp.orig<br />
+++ b/src/3rdparty/chromium/third_party/WebKit/Source/wtf/Assertions.cpp<br />
@@ -142,7 +142,7 @@<br />
};<br />
<br />
FrameToNameScope::FrameToNameScope(void* addr) : m_name(0), m_cxaDemangled(0) {<br />
-#if OS(MACOSX) || (OS(LINUX) && !defined(__UCLIBC__))<br />
+#if OS(MACOSX) || (OS(LINUX) && defined(__GLIBC__))<br />
Dl_info info;<br />
if (!dladdr(addr, &info) || !info.dli_sname)<br />
return;<br />
</nowiki>}}<br />
<br />
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.<br />
<br />
It is good etiquette to give credit at the top and the location of where you originally found them with notes.<br />
<br />
Excluding patches with global variable resembling patch_opts is not available on Alpine. To exclude patches you need to create your own custom prepare().<br />
<br />
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.<br />
<br />
Just do something like:<br />
<br />
<pre><br />
makedepends="patchutils"<br />
<br />
prepare() {<br />
...<br />
cd "$builddir"<br />
filterdiff -x '*drivers/video/logo*' "$srcdir"/original.patch > "$builddir"/modified.patch<br />
patch -p1 -i "$builddir"/modified.patch<br />
}<br />
</pre><br />
<br />
You need to put the wildcard pattern in single quotes for it to work.<br />
<br />
==== Configure options ====<br />
<br />
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. <br />
<br />
We are not covering the depend switches here we have discussed this already in the depend section.<br />
<br />
<br />
==== Make options ====<br />
<br />
If you notice weird problems when compiling or installing the package with make/make install you could try to disable [https://www.gnu.org/software/make/manual/make.html#Parallel parallel] building/installing. A normal make line would be: <br />
<br />
{{Cmd|make}}<br />
<br />
To disable parallel we use: <br />
<br />
{{Cmd|make -j1}}<br />
<br />
We can use the same for make install. <br />
<br />
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: <br />
<br />
{{Cmd|make DESTDIR{{=}}"$pkgdir" install}}<br />
<br />
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 doas when needed. If by accident the Makefile does not support DESTDIR variable it will fail to install in our build system system directories.<br />
<br />
==== builddir ====<br />
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.<br />
<br />
<pre><br />
builddir="$srcdir"/$pkgname-$pkgver<br />
</pre><br />
<br />
==== Additional files ====<br />
<br />
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): <br />
<br />
{{Cmd|install -Dm644 doc/$pkgname.conf "$pkgdir"/etc/$pkgname.conf}}<br />
<br />
== Build the package ==<br />
<br />
If you did not already create the checksums as mentioned above you can do so now: <br />
<br />
{{Cmd|cd $pkgname<br />
abuild checksum}}<br />
<br />
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.<br />
<br />
{{Cmd|abuild -r}}<br />
<br />
See also [[Abuild_and_Helpers|Abuild and Helpers]].<br />
<br />
== Testing the package locally ==<br />
<br />
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.<br />
<br />
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.<br />
<br />
{{Cat|/etc/apk/repositories|/home/USER/packages/testing/<br />
/home/USER/packages/main/<br />
/home/USER/packages/community/<br />
https://dl-cdn.alpinelinux.org/alpine/edge/main<br />
https://dl-cdn.alpinelinux.org/alpine/edge/community<br />
https://dl-cdn.alpinelinux.org/alpine/edge/testing<br />
}}<br />
<br />
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>:<br />
<br />
{{Cmd|doas apk add --repository /home/USER/packages/testing $pkgname}}<br />
<br />
== Code review ==<br />
<br />
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:<br />
<br />
# Custom global variables should be prefixed with underscore (_).<br />
# Compact code as in merged commands, removed unused variables, removal of functions that do the same thing that are automatically handled by abuild.<br />
# Versioning is done properly. For details see [[APKBUILD_Reference#pkgver]].<br />
# Licensing is done properly. Remove unnecessary copying of licensing that is already OSI approved.<br />
# Naming conventions rules for unofficial variables as in _gitrev is preferred over commit.<br />
# Indent with tabs not spaces.<br />
# Removal of explicit return 1. (They are still found the old APKBUILD files if you are learning but are now strongly discouraged.)<br />
# 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.<br />
# Explicit call to subpackages="$pkgname-doc" must be used instead of explicit gzip man page compression.<br />
# Ideally, lines should be no more than 80 columns wide<br />
<br />
Additionally, make sure to run the linter on your package:<br />
{{Cmd|doas apk add atools<br />
apkbuild-lint APKBUILD}}<br />
<br />
For more information see [[Development using git:Quality assurance]] and [[Package_policies]].<br />
Also check out [https://gitlab.alpinelinux.org/alpine/aports/-/blob/master/COMMITSTYLE.md?ref_type=heads aports/COMMITSTYLE.md] and [https://gitlab.alpinelinux.org/alpine/aports/-/blob/master/CODINGSTYLE.md?ref_type=heads aports/CODINGSTYLE.md]<br />
<br />
== Commit your work ==<br />
<br />
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. <br />
<br />
Update your git repo, before adding new files: <br />
<br />
{{Cmd|cd $aportsdir<br />
git pull}}<br />
<br />
This should pull all the changes made by others into your local git repo.<br />
<br />
When you think you are ready you can add your files to git: <br />
<br />
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.<br />
<br />
{{Cmd|cd $aportsdir<br />
git add testing/$pkgdir (include any other files needed for the build; $pkgname.install...)<br />
git commit}}<br />
<br />
Use the following commit message template for new aports (without the comments):<br />
<br />
{{Cat|template|testing/$pkgname: new aport # this will be the subject line<br />
# a blank line<br />
$url # project homepage<br />
$pkgdesc # one line description}}<br />
<br />
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:<br />
<br />
{{Cat|aports/.git/hooks/prepare-commit-msg|<nowiki>#!/bin/sh<br />
case "$2,$3" in<br />
,|template,)<br />
if git diff-index --diff-filter=A --name-only --cached HEAD \<br />
| grep -q '/APKBUILD$'; then<br />
meta() { git diff --staged | grep "^+$1" | sed 's/.*="\?//;s/"$//';}<br />
printf 'testing/%s: new aport\n\n%s\n%s\n' "$(meta pkgname)" \<br />
"$(meta url)" "$(meta pkgdesc)" "$(cat $1)" > "$1"<br />
else<br />
printf '%s\n\n%s' `git diff-index --name-only --cached HEAD \<br />
| sed -n 's/\/APKBUILD$//p;q'` "$(cat $1)" > "$1"<br />
fi;;<br />
esac</nowiki>}}<br />
<br />
Now your changes are only available locally in your repository.<br />
<br />
Because you do not have push rights to the Alpine aports repository you need to create a merge request to [https://gitlab.alpinelinux.org/alpine/aports Alpine's GitLab instance].<br />
<br />
Alternatively you can also create a diff (patch) of the changes you made and send this patch to the <br />
[https://lists.alpinelinux.org/~alpine/aports alpine-aports mailinglist].<br />
<br />
To create a diff patch:<br />
<br />
{{Cmd|git format-patch HEAD^}}<br />
<br />
or if you have sprunge, you can create a link to your patch for convenience<br />
<br />
{{Cmd|git format-patch HEAD^ --stdout <nowiki>|</nowiki> sprunge}}<br />
<br />
== Automated flagging of outdated ports ==<br />
Consider adding your port to [https://release-monitoring.org/ Anitya], so it will be flagged as outdated<br />
as soon as a new stable version is released by upstream.<br />
<br />
== See Also ==<br />
* [[APKBUILD Reference]]<br />
* [[APKBUILD examples]]<br />
* [[Development using git]]<br />
* [[Development using git:Quality assurance]]<br />
<br />
[[category: Package Manager]]</div>Rickyrockrathttps://wiki.alpinelinux.org/w/index.php?title=Creating_an_Alpine_package&diff=26378Creating an Alpine package2024-02-11T23:44:38Z<p>Rickyrockrat: /* Overview */</p>
<hr />
<div>{{TOC right}}<br />
== Overview ==<br />
<br />
This is a brief list of the steps to add a new package. Details are below, but a NB can miss a few steps.<br />
<ol><br />
<li>Create an account on github.alpine<br />
<li>Setup the build environment for aports.<br />
<li>Fork the aports repository. <br />
<li>Clone your new fork.<br />
<li>Set git pull.rebase=true, set your username and email.<br />
<li>Create a new branch (don't use master).<br />
<li>Add a new directory under testing that is your new package name.<br />
<li>Add your APKBUILD file.<br />
<li>Run abuild checksum<br />
<li>Make sure you run the apkbuild-lint and aport -r and there are no warnings.<br />
<li>Commit your APKBUILD with the commit message: 'testing/packagename: new aport'<br />
<li>Push your changes to your fork on github.alpine.<br />
<li>Create a merge request.<br />
</ol><br />
<br />
Please see the rest of this wiki for details on the steps above.<br />
<br />
== Requirements ==<br />
<br />
To build a package for Alpine Linux you need an Alpine Linux installation. Check the [[Installation]] page to see all available installation options.<br />
<br />
== Setup your system and account ==<br />
{{:Setup_your_system_and_account_for_building_packages}}<br />
<br />
== Getting some help ==<br />
<br />
It might be wise to start by checking what the [[Abuild and Helpers|abuild]] program can/cannot do.<br />
<br />
{{Cmd|abuild -h}}<br />
<br />
For real help, you can also go on #alpine-devel on [[IRC]].<br />
<br />
A reference for APKBUILD files is available as [[APKBUILD Reference]] wiki page or a man page in the 'abuild-doc' package:<br />
<br />
{{Cmd|man APKBUILD}}<br />
<br />
<br />
== Creating an APKBUILD file ==<br />
<br />
=== Use a template APKBUILD ===<br />
<br />
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.<br />
<br />
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.<br />
<br />
{{:Abuild and Helpers}}<br />
<br />
{{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. }}<br />
<br />
[[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. <br />
<br />
If you are creating a daemon package which needs initd scripts you can add the -c making it: <br />
<br />
{{Cmd|newapkbuild -c ''packagename''}}<br />
<br />
This will copy the sample initd and confd files to the build directory.<BR><br />
A third file sample.install file will be copied as well (we will discuss this later on).<br />
<br />
=== Modify your APKBUILD ===<br />
Edit APKBUILD and fill in the needed info (especially pkgname, pkgver, pkgdesc, url, license, depends and source). <br />
<br />
If you are going to use any of the variables for directories like $pkgdir, always make sure they are double quoted like: <br />
<br />
"$pkgdir"/somedir<br />
<br />
This will prevent issues with spaces/special characters in the future. <br />
<br />
{{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.}}<br />
<br />
=== APKBUILD variables/functions ===<br />
<br />
==== source ====<br />
<br />
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.<br />
<br />
Here are few things to note:<br />
<br />
* 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:<br />
: {{cmd|abuild checksum}}<br />
: {{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.}}<br />
<br />
* When the remote file is hosted at SourceForge, it's best to specify the special mirrors link used by SourceForge:<br />
: <pre>http://downloads.sourceforge.net/$pkgname/$pkgname-$pkgver.tar.gz</pre><br />
: (or similar depending on the package).<br />
<br />
* When the remote filename is not specified in the URI (ie, does not end in '/software-1.0.tar.gz'), such as:<br />
: <pre>http://oss.example.org/?get=software&ver=1.0</pre><br />
: You must prepend '${pkgname}-${pkgver}.tar.gz::' to the protocol, like so:<br />
: <pre>source="${pkgname}-${pkgver}.tar.gz::http://oss.example.org/?get=software&ver=1.0"</pre><br />
: 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.<br />
<br />
* 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>https://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.<br />
<br />
* abuild currently supports the following protocols for remote file retrieval:<br />
** http<br />
** https<br />
** ftp<br />
<br />
<!--: {{Note|If the you want to download from https, you need GNU wget installed on your system.}}--><br />
<br />
* abuild currently supports the following archive types/archive file extensions:<br />
** .tar<br />
** .tar.gz / .tgz<br />
** .tar.bz2<br />
** .tar.lz (only in Alpine >=3.7)<br />
** .tar.lzma<br />
** .tar.xz<br />
** .zip<br />
<br />
==== depends &amp; makedepends ====<br />
<br />
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 [https://en.wikipedia.org/wiki/Rtfm RTFM]. <br />
<br />
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: <br />
<br />
{{Cmd|abuild unpack}}<br />
<br />
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, ...). <br />
<br />
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.<br />
<br />
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).<br />
<br />
* [https://gitweb.gentoo.org/repo/gentoo.git/tree/ Gentoo Ebuilds] <br />
* [https://archlinux.org/packages/?q=search Arch Linux packages] [https://aur.archlinux.org/ Arch Linux User Repository]<br />
<br />
==== license ====<br />
<br />
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.<br />
<br />
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.<br />
<br />
Note that some licenses have additional requirements that should be adhered to. The <code>MIT</code> license for example has the requirement:<br />
<br />
<blockquote><br />
The above copyright notice and this permission notice (including the next paragraph) shall be included in all copies or substantial portions of the Software.<br />
</blockquote><br />
<br />
This means that we need to include the license as shipped with the project.<br />
<br />
If a package has a special/custom license or is not listed as [https://opensource.org/licenses/alphabetical OSI approved], use the identifier "custom". In that case we need to provide the license file with the package as well.<br />
<br />
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: <br />
<br />
subpackages="$pkgname-doc"<br />
<br />
Add a similar line to the following to your package() function, depending on the license description file: <br />
<br />
{{Cmd|install -Dm644 COPYING "$pkgdir"/usr/share/licenses/$pkgname/COPYING}}<br />
<br />
If you follow these steps then abuild will automatically add the license to the package-doc apk for you.<br />
<br />
{{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. }}<br />
<br />
==== arch ====<br />
<br />
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 (e.g., a pure-python package).<br />
{{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.}}<br />
<br />
==== url ====<br />
<br />
Website address for the program. This is useful later on when either finding documentation or other information about the package.<br />
<br />
==== pkgdesc ====<br />
<br />
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.<br />
<br />
Here is an example from apk_info for the OpenSSH client package:<br />
<br />
pkgdesc="Port of OpenBSD's free SSH release - client"<br />
<br />
==== pkgver ====<br />
<br />
Provide the release number of the package you are building.<br />
<br />
==== pkgrel ====<br />
<br />
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.<br />
<br />
==== pkgname ====<br />
<br />
The base name of the package you are creating. For Freeswitch 1.0.6, you would use "freeswitch"<br />
<br />
==== install ====<br />
<br />
There are 6 different kinds of install scripts. Each script is called with the $pkgname.''<action>'' where ''<action>'' is one of the following:<br />
<br />
<dl><br />
<dt>$pkgname.pre-install<br />
<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:<br />
<pre><br />
#!/bin/sh<br />
<br />
addgroup -S clamav 2>/dev/null<br />
adduser -S -D -H -s /bin/false -G clamav -g clamav clamav 2>/dev/null<br />
<br />
exit 0<br />
</pre><br />
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.<br />
<br />
<dt>$pkgname.post-install<br />
<dd>This script is executed after the package is installed.<br />
<br />
<dt>$pkgname.pre-upgrade<br />
<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.<br />
<br />
<dt>$pkgname.post-upgrade<br />
<dd>Same as post-install but is executed after upgrading/downgrading/reinstalling an already installed package. <br />
<br />
<dt>$pkgname.pre-deinstall<br />
<dd>This script is executed before uninstalling a package. If script exits with failure apk will not uninstall the package.<br />
<br />
<dt>$pkgname.post-deinstall<br />
<dd>This script is executed after a package have been uninstalled. For example, can be used to restore busybox links:<br />
<pre><br />
#!/bin/sh<br />
busybox --install -s<br />
</pre><br />
<br />
</dl><br />
<br />
If the package has a pre-install and post-install script the APKBUILD should have the ''install'' variable defined:<br />
<pre><br />
...<br />
install="$pkgname.pre-install $pkgname.post-install"<br />
<br />
...<br />
</pre><br />
<br />
==== subpackages ====<br />
<br />
$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. <br />
<br />
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. <br />
<br />
To see if you need the -dev package you can run the following cmd: <br />
<br />
{{Cmd|find pkg/usr/ -name '*.[acho]' -o -name '*.la'}}<br />
<br />
If this returns any files you need to include the -dev package. <br />
<br />
<br> To see if you need the -doc package you can run the following cmd: <br />
<br />
{{Cmd|find pkg/usr/share -name doc -o -name man -o -name info -o -name html -o -name sgml -o -name licenses}}<br />
<br />
If this returns any directories you need to include the -doc package. <br />
<br />
===== Custom subpackages =====<br />
<br />
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: <br />
<br />
test() {<br />
mkdir -p "$subpkgdir"/usr<br />
mv "$pkgdir"/usr/package-test "$subpkgdir"/usr/<br />
# or amove usr/package-test<br />
}<br />
<br />
<br />
We also need to add the package info to $subpackages variable: <br />
<br />
subpackages="$pkgname-doc $pkgname-dev $pkgname-test"<br />
<br />
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. <br />
<br />
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: <br />
<br />
depends="perl"<br />
makedepends="perl-dev"<br />
<br />
If we would install the base package it would not install perl, but if we install the package-test package it would.<br />
<br />
==== Patches ====<br />
<br />
Please make sure you always submit human readable patches. Ways to create them are: <br />
<br />
directory compare: <br />
<br />
{{Cmd|diff -Nurp original_directory new_directory &gt; filename.patch}}<br />
<br />
file compare: <br />
<br />
{{Cmd|diff -up original.file new.file &gt; filename.patch}}<br />
<br />
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.<br />
<br />
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: <br />
<br />
10-patch1.patch 20-patch2.patch 30-patch3.patch<br />
<br />
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).<br />
<br />
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:<br />
<br />
prepare() {<br />
default_prepare<br />
<br />
# do your stuff<br />
}<br />
<br />
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''.<br />
<br />
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.<br />
<br />
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.<br />
<br />
{{Cat|example.patch|<nowiki><br />
Author: John Doe <johndoe@mail.com><br />
URL: http://.....<br />
Summary: Fixes musl compatibility<br />
----<br />
--- a/src/3rdparty/chromium/third_party/WebKit/Source/wtf/Assertions.cpp.orig<br />
+++ b/src/3rdparty/chromium/third_party/WebKit/Source/wtf/Assertions.cpp<br />
@@ -142,7 +142,7 @@<br />
};<br />
<br />
FrameToNameScope::FrameToNameScope(void* addr) : m_name(0), m_cxaDemangled(0) {<br />
-#if OS(MACOSX) || (OS(LINUX) && !defined(__UCLIBC__))<br />
+#if OS(MACOSX) || (OS(LINUX) && defined(__GLIBC__))<br />
Dl_info info;<br />
if (!dladdr(addr, &info) || !info.dli_sname)<br />
return;<br />
</nowiki>}}<br />
<br />
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.<br />
<br />
It is good etiquette to give credit at the top and the location of where you originally found them with notes.<br />
<br />
Excluding patches with global variable resembling patch_opts is not available on Alpine. To exclude patches you need to create your own custom prepare().<br />
<br />
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.<br />
<br />
Just do something like:<br />
<br />
<pre><br />
makedepends="patchutils"<br />
<br />
prepare() {<br />
...<br />
cd "$builddir"<br />
filterdiff -x '*drivers/video/logo*' "$srcdir"/original.patch > "$builddir"/modified.patch<br />
patch -p1 -i "$builddir"/modified.patch<br />
}<br />
</pre><br />
<br />
You need to put the wildcard pattern in single quotes for it to work.<br />
<br />
==== Configure options ====<br />
<br />
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. <br />
<br />
We are not covering the depend switches here we have discussed this already in the depend section.<br />
<br />
<br />
==== Make options ====<br />
<br />
If you notice weird problems when compiling or installing the package with make/make install you could try to disable [https://www.gnu.org/software/make/manual/make.html#Parallel parallel] building/installing. A normal make line would be: <br />
<br />
{{Cmd|make}}<br />
<br />
To disable parallel we use: <br />
<br />
{{Cmd|make -j1}}<br />
<br />
We can use the same for make install. <br />
<br />
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: <br />
<br />
{{Cmd|make DESTDIR{{=}}"$pkgdir" install}}<br />
<br />
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 doas when needed. If by accident the Makefile does not support DESTDIR variable it will fail to install in our build system system directories.<br />
<br />
==== builddir ====<br />
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.<br />
<br />
<pre><br />
builddir="$srcdir"/$pkgname-$pkgver<br />
</pre><br />
<br />
==== Additional files ====<br />
<br />
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): <br />
<br />
{{Cmd|install -Dm644 doc/$pkgname.conf "$pkgdir"/etc/$pkgname.conf}}<br />
<br />
== Build the package ==<br />
<br />
If you did not already create the checksums as mentioned above you can do so now: <br />
<br />
{{Cmd|cd $pkgname<br />
abuild checksum}}<br />
<br />
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.<br />
<br />
{{Cmd|abuild -r}}<br />
<br />
See also [[Abuild_and_Helpers|Abuild and Helpers]].<br />
<br />
== Testing the package locally ==<br />
<br />
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.<br />
<br />
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.<br />
<br />
{{Cat|/etc/apk/repositories|/home/USER/packages/testing/<br />
/home/USER/packages/main/<br />
/home/USER/packages/community/<br />
https://dl-cdn.alpinelinux.org/alpine/edge/main<br />
https://dl-cdn.alpinelinux.org/alpine/edge/community<br />
https://dl-cdn.alpinelinux.org/alpine/edge/testing<br />
}}<br />
<br />
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>:<br />
<br />
{{Cmd|doas apk add --repository /home/USER/packages/testing $pkgname}}<br />
<br />
== Code review ==<br />
<br />
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:<br />
<br />
# Custom global variables should be prefixed with underscore (_).<br />
# Compact code as in merged commands, removed unused variables, removal of functions that do the same thing that are automatically handled by abuild.<br />
# Versioning is done properly. For details see [[APKBUILD_Reference#pkgver]].<br />
# Licensing is done properly. Remove unnecessary copying of licensing that is already OSI approved.<br />
# Naming conventions rules for unofficial variables as in _gitrev is preferred over commit.<br />
# Indent with tabs not spaces.<br />
# Removal of explicit return 1. (They are still found the old APKBUILD files if you are learning but are now strongly discouraged.)<br />
# 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.<br />
# Explicit call to subpackages="$pkgname-doc" must be used instead of explicit gzip man page compression.<br />
# Ideally, lines should be no more than 80 columns wide<br />
<br />
Additionally, make sure to run the linter on your package:<br />
{{Cmd|doas apk add atools<br />
apkbuild-lint APKBUILD}}<br />
<br />
For more information see [[Development using git:Quality assurance]] and [[Package_policies]].<br />
Also check out [https://gitlab.alpinelinux.org/alpine/aports/-/blob/master/COMMITSTYLE.md?ref_type=heads aports/COMMITSTYLE.md] and [https://gitlab.alpinelinux.org/alpine/aports/-/blob/master/CODINGSTYLE.md?ref_type=heads aports/CODINGSTYLE.md]<br />
<br />
== Commit your work ==<br />
<br />
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. <br />
<br />
Update your git repo, before adding new files: <br />
<br />
{{Cmd|cd $aportsdir<br />
git pull}}<br />
<br />
This should pull all the changes made by others into your local git repo.<br />
<br />
When you think you are ready you can add your files to git: <br />
<br />
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.<br />
<br />
{{Cmd|cd $aportsdir<br />
git add testing/$pkgdir (include any other files needed for the build; $pkgname.install...)<br />
git commit}}<br />
<br />
Use the following commit message template for new aports (without the comments):<br />
<br />
{{Cat|template|testing/$pkgname: new aport # this will be the subject line<br />
# a blank line<br />
$url # project homepage<br />
$pkgdesc # one line description}}<br />
<br />
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:<br />
<br />
{{Cat|aports/.git/hooks/prepare-commit-msg|<nowiki>#!/bin/sh<br />
case "$2,$3" in<br />
,|template,)<br />
if git diff-index --diff-filter=A --name-only --cached HEAD \<br />
| grep -q '/APKBUILD$'; then<br />
meta() { git diff --staged | grep "^+$1" | sed 's/.*="\?//;s/"$//';}<br />
printf 'testing/%s: new aport\n\n%s\n%s\n' "$(meta pkgname)" \<br />
"$(meta url)" "$(meta pkgdesc)" "$(cat $1)" > "$1"<br />
else<br />
printf '%s\n\n%s' `git diff-index --name-only --cached HEAD \<br />
| sed -n 's/\/APKBUILD$//p;q'` "$(cat $1)" > "$1"<br />
fi;;<br />
esac</nowiki>}}<br />
<br />
Now your changes are only available locally in your repository.<br />
<br />
Because you do not have push rights to the Alpine aports repository you need to create a merge request to [https://gitlab.alpinelinux.org/alpine/aports Alpine's GitLab instance].<br />
<br />
Alternatively you can also create a diff (patch) of the changes you made and send this patch to the <br />
[https://lists.alpinelinux.org/~alpine/aports alpine-aports mailinglist].<br />
<br />
To create a diff patch:<br />
<br />
{{Cmd|git format-patch HEAD^}}<br />
<br />
or if you have sprunge, you can create a link to your patch for convenience<br />
<br />
{{Cmd|git format-patch HEAD^ --stdout <nowiki>|</nowiki> sprunge}}<br />
<br />
== Automated flagging of outdated ports ==<br />
Consider adding your port to [https://release-monitoring.org/ Anitya], so it will be flagged as outdated<br />
as soon as a new stable version is released by upstream.<br />
<br />
== See Also ==<br />
* [[APKBUILD Reference]]<br />
* [[APKBUILD examples]]<br />
* [[Development using git]]<br />
* [[Development using git:Quality assurance]]<br />
<br />
[[category: Package Manager]]</div>Rickyrockrathttps://wiki.alpinelinux.org/w/index.php?title=Creating_an_Alpine_package&diff=26377Creating an Alpine package2024-02-11T23:43:32Z<p>Rickyrockrat: /* Overview */</p>
<hr />
<div>{{TOC right}}<br />
== Overview ==<br />
<br />
This is a brief list of the steps to add a new package. Details are below, but a NB can miss a few steps.<br />
<ol><br />
<li>Create an account on github.alpine<br />
<li>Fork the aports repository. <br />
<li>Clone your new fork.<br />
<li>Set git pull.rebase=true, set your username and email.<br />
<li>Create a new branch (don't use master).<br />
<li>Add a new directory under testing that is your new package name.<br />
<li>Add your APKBUILD file.<br />
<li>Run abuild checksum<br />
<li>Make sure you run the apkbuild-lint and aport -r and there are no warnings.<br />
<li>Commit your APKBUILD with the commit message: 'testing/packagename: new aport'<br />
<li>Push your changes to your fork on github.alpine.<br />
<li>Create a merge request.<br />
</ol><br />
<br />
Please see the rest of this wiki for details on the steps above.<br />
<br />
== Requirements ==<br />
<br />
To build a package for Alpine Linux you need an Alpine Linux installation. Check the [[Installation]] page to see all available installation options.<br />
<br />
== Setup your system and account ==<br />
{{:Setup_your_system_and_account_for_building_packages}}<br />
<br />
== Getting some help ==<br />
<br />
It might be wise to start by checking what the [[Abuild and Helpers|abuild]] program can/cannot do.<br />
<br />
{{Cmd|abuild -h}}<br />
<br />
For real help, you can also go on #alpine-devel on [[IRC]].<br />
<br />
A reference for APKBUILD files is available as [[APKBUILD Reference]] wiki page or a man page in the 'abuild-doc' package:<br />
<br />
{{Cmd|man APKBUILD}}<br />
<br />
<br />
== Creating an APKBUILD file ==<br />
<br />
=== Use a template APKBUILD ===<br />
<br />
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.<br />
<br />
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.<br />
<br />
{{:Abuild and Helpers}}<br />
<br />
{{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. }}<br />
<br />
[[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. <br />
<br />
If you are creating a daemon package which needs initd scripts you can add the -c making it: <br />
<br />
{{Cmd|newapkbuild -c ''packagename''}}<br />
<br />
This will copy the sample initd and confd files to the build directory.<BR><br />
A third file sample.install file will be copied as well (we will discuss this later on).<br />
<br />
=== Modify your APKBUILD ===<br />
Edit APKBUILD and fill in the needed info (especially pkgname, pkgver, pkgdesc, url, license, depends and source). <br />
<br />
If you are going to use any of the variables for directories like $pkgdir, always make sure they are double quoted like: <br />
<br />
"$pkgdir"/somedir<br />
<br />
This will prevent issues with spaces/special characters in the future. <br />
<br />
{{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.}}<br />
<br />
=== APKBUILD variables/functions ===<br />
<br />
==== source ====<br />
<br />
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.<br />
<br />
Here are few things to note:<br />
<br />
* 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:<br />
: {{cmd|abuild checksum}}<br />
: {{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.}}<br />
<br />
* When the remote file is hosted at SourceForge, it's best to specify the special mirrors link used by SourceForge:<br />
: <pre>http://downloads.sourceforge.net/$pkgname/$pkgname-$pkgver.tar.gz</pre><br />
: (or similar depending on the package).<br />
<br />
* When the remote filename is not specified in the URI (ie, does not end in '/software-1.0.tar.gz'), such as:<br />
: <pre>http://oss.example.org/?get=software&ver=1.0</pre><br />
: You must prepend '${pkgname}-${pkgver}.tar.gz::' to the protocol, like so:<br />
: <pre>source="${pkgname}-${pkgver}.tar.gz::http://oss.example.org/?get=software&ver=1.0"</pre><br />
: 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.<br />
<br />
* 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>https://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.<br />
<br />
* abuild currently supports the following protocols for remote file retrieval:<br />
** http<br />
** https<br />
** ftp<br />
<br />
<!--: {{Note|If the you want to download from https, you need GNU wget installed on your system.}}--><br />
<br />
* abuild currently supports the following archive types/archive file extensions:<br />
** .tar<br />
** .tar.gz / .tgz<br />
** .tar.bz2<br />
** .tar.lz (only in Alpine >=3.7)<br />
** .tar.lzma<br />
** .tar.xz<br />
** .zip<br />
<br />
==== depends &amp; makedepends ====<br />
<br />
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 [https://en.wikipedia.org/wiki/Rtfm RTFM]. <br />
<br />
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: <br />
<br />
{{Cmd|abuild unpack}}<br />
<br />
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, ...). <br />
<br />
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.<br />
<br />
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).<br />
<br />
* [https://gitweb.gentoo.org/repo/gentoo.git/tree/ Gentoo Ebuilds] <br />
* [https://archlinux.org/packages/?q=search Arch Linux packages] [https://aur.archlinux.org/ Arch Linux User Repository]<br />
<br />
==== license ====<br />
<br />
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.<br />
<br />
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.<br />
<br />
Note that some licenses have additional requirements that should be adhered to. The <code>MIT</code> license for example has the requirement:<br />
<br />
<blockquote><br />
The above copyright notice and this permission notice (including the next paragraph) shall be included in all copies or substantial portions of the Software.<br />
</blockquote><br />
<br />
This means that we need to include the license as shipped with the project.<br />
<br />
If a package has a special/custom license or is not listed as [https://opensource.org/licenses/alphabetical OSI approved], use the identifier "custom". In that case we need to provide the license file with the package as well.<br />
<br />
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: <br />
<br />
subpackages="$pkgname-doc"<br />
<br />
Add a similar line to the following to your package() function, depending on the license description file: <br />
<br />
{{Cmd|install -Dm644 COPYING "$pkgdir"/usr/share/licenses/$pkgname/COPYING}}<br />
<br />
If you follow these steps then abuild will automatically add the license to the package-doc apk for you.<br />
<br />
{{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. }}<br />
<br />
==== arch ====<br />
<br />
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 (e.g., a pure-python package).<br />
{{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.}}<br />
<br />
==== url ====<br />
<br />
Website address for the program. This is useful later on when either finding documentation or other information about the package.<br />
<br />
==== pkgdesc ====<br />
<br />
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.<br />
<br />
Here is an example from apk_info for the OpenSSH client package:<br />
<br />
pkgdesc="Port of OpenBSD's free SSH release - client"<br />
<br />
==== pkgver ====<br />
<br />
Provide the release number of the package you are building.<br />
<br />
==== pkgrel ====<br />
<br />
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.<br />
<br />
==== pkgname ====<br />
<br />
The base name of the package you are creating. For Freeswitch 1.0.6, you would use "freeswitch"<br />
<br />
==== install ====<br />
<br />
There are 6 different kinds of install scripts. Each script is called with the $pkgname.''<action>'' where ''<action>'' is one of the following:<br />
<br />
<dl><br />
<dt>$pkgname.pre-install<br />
<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:<br />
<pre><br />
#!/bin/sh<br />
<br />
addgroup -S clamav 2>/dev/null<br />
adduser -S -D -H -s /bin/false -G clamav -g clamav clamav 2>/dev/null<br />
<br />
exit 0<br />
</pre><br />
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.<br />
<br />
<dt>$pkgname.post-install<br />
<dd>This script is executed after the package is installed.<br />
<br />
<dt>$pkgname.pre-upgrade<br />
<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.<br />
<br />
<dt>$pkgname.post-upgrade<br />
<dd>Same as post-install but is executed after upgrading/downgrading/reinstalling an already installed package. <br />
<br />
<dt>$pkgname.pre-deinstall<br />
<dd>This script is executed before uninstalling a package. If script exits with failure apk will not uninstall the package.<br />
<br />
<dt>$pkgname.post-deinstall<br />
<dd>This script is executed after a package have been uninstalled. For example, can be used to restore busybox links:<br />
<pre><br />
#!/bin/sh<br />
busybox --install -s<br />
</pre><br />
<br />
</dl><br />
<br />
If the package has a pre-install and post-install script the APKBUILD should have the ''install'' variable defined:<br />
<pre><br />
...<br />
install="$pkgname.pre-install $pkgname.post-install"<br />
<br />
...<br />
</pre><br />
<br />
==== subpackages ====<br />
<br />
$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. <br />
<br />
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. <br />
<br />
To see if you need the -dev package you can run the following cmd: <br />
<br />
{{Cmd|find pkg/usr/ -name '*.[acho]' -o -name '*.la'}}<br />
<br />
If this returns any files you need to include the -dev package. <br />
<br />
<br> To see if you need the -doc package you can run the following cmd: <br />
<br />
{{Cmd|find pkg/usr/share -name doc -o -name man -o -name info -o -name html -o -name sgml -o -name licenses}}<br />
<br />
If this returns any directories you need to include the -doc package. <br />
<br />
===== Custom subpackages =====<br />
<br />
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: <br />
<br />
test() {<br />
mkdir -p "$subpkgdir"/usr<br />
mv "$pkgdir"/usr/package-test "$subpkgdir"/usr/<br />
# or amove usr/package-test<br />
}<br />
<br />
<br />
We also need to add the package info to $subpackages variable: <br />
<br />
subpackages="$pkgname-doc $pkgname-dev $pkgname-test"<br />
<br />
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. <br />
<br />
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: <br />
<br />
depends="perl"<br />
makedepends="perl-dev"<br />
<br />
If we would install the base package it would not install perl, but if we install the package-test package it would.<br />
<br />
==== Patches ====<br />
<br />
Please make sure you always submit human readable patches. Ways to create them are: <br />
<br />
directory compare: <br />
<br />
{{Cmd|diff -Nurp original_directory new_directory &gt; filename.patch}}<br />
<br />
file compare: <br />
<br />
{{Cmd|diff -up original.file new.file &gt; filename.patch}}<br />
<br />
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.<br />
<br />
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: <br />
<br />
10-patch1.patch 20-patch2.patch 30-patch3.patch<br />
<br />
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).<br />
<br />
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:<br />
<br />
prepare() {<br />
default_prepare<br />
<br />
# do your stuff<br />
}<br />
<br />
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''.<br />
<br />
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.<br />
<br />
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.<br />
<br />
{{Cat|example.patch|<nowiki><br />
Author: John Doe <johndoe@mail.com><br />
URL: http://.....<br />
Summary: Fixes musl compatibility<br />
----<br />
--- a/src/3rdparty/chromium/third_party/WebKit/Source/wtf/Assertions.cpp.orig<br />
+++ b/src/3rdparty/chromium/third_party/WebKit/Source/wtf/Assertions.cpp<br />
@@ -142,7 +142,7 @@<br />
};<br />
<br />
FrameToNameScope::FrameToNameScope(void* addr) : m_name(0), m_cxaDemangled(0) {<br />
-#if OS(MACOSX) || (OS(LINUX) && !defined(__UCLIBC__))<br />
+#if OS(MACOSX) || (OS(LINUX) && defined(__GLIBC__))<br />
Dl_info info;<br />
if (!dladdr(addr, &info) || !info.dli_sname)<br />
return;<br />
</nowiki>}}<br />
<br />
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.<br />
<br />
It is good etiquette to give credit at the top and the location of where you originally found them with notes.<br />
<br />
Excluding patches with global variable resembling patch_opts is not available on Alpine. To exclude patches you need to create your own custom prepare().<br />
<br />
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.<br />
<br />
Just do something like:<br />
<br />
<pre><br />
makedepends="patchutils"<br />
<br />
prepare() {<br />
...<br />
cd "$builddir"<br />
filterdiff -x '*drivers/video/logo*' "$srcdir"/original.patch > "$builddir"/modified.patch<br />
patch -p1 -i "$builddir"/modified.patch<br />
}<br />
</pre><br />
<br />
You need to put the wildcard pattern in single quotes for it to work.<br />
<br />
==== Configure options ====<br />
<br />
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. <br />
<br />
We are not covering the depend switches here we have discussed this already in the depend section.<br />
<br />
<br />
==== Make options ====<br />
<br />
If you notice weird problems when compiling or installing the package with make/make install you could try to disable [https://www.gnu.org/software/make/manual/make.html#Parallel parallel] building/installing. A normal make line would be: <br />
<br />
{{Cmd|make}}<br />
<br />
To disable parallel we use: <br />
<br />
{{Cmd|make -j1}}<br />
<br />
We can use the same for make install. <br />
<br />
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: <br />
<br />
{{Cmd|make DESTDIR{{=}}"$pkgdir" install}}<br />
<br />
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 doas when needed. If by accident the Makefile does not support DESTDIR variable it will fail to install in our build system system directories.<br />
<br />
==== builddir ====<br />
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.<br />
<br />
<pre><br />
builddir="$srcdir"/$pkgname-$pkgver<br />
</pre><br />
<br />
==== Additional files ====<br />
<br />
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): <br />
<br />
{{Cmd|install -Dm644 doc/$pkgname.conf "$pkgdir"/etc/$pkgname.conf}}<br />
<br />
== Build the package ==<br />
<br />
If you did not already create the checksums as mentioned above you can do so now: <br />
<br />
{{Cmd|cd $pkgname<br />
abuild checksum}}<br />
<br />
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.<br />
<br />
{{Cmd|abuild -r}}<br />
<br />
See also [[Abuild_and_Helpers|Abuild and Helpers]].<br />
<br />
== Testing the package locally ==<br />
<br />
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.<br />
<br />
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.<br />
<br />
{{Cat|/etc/apk/repositories|/home/USER/packages/testing/<br />
/home/USER/packages/main/<br />
/home/USER/packages/community/<br />
https://dl-cdn.alpinelinux.org/alpine/edge/main<br />
https://dl-cdn.alpinelinux.org/alpine/edge/community<br />
https://dl-cdn.alpinelinux.org/alpine/edge/testing<br />
}}<br />
<br />
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>:<br />
<br />
{{Cmd|doas apk add --repository /home/USER/packages/testing $pkgname}}<br />
<br />
== Code review ==<br />
<br />
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:<br />
<br />
# Custom global variables should be prefixed with underscore (_).<br />
# Compact code as in merged commands, removed unused variables, removal of functions that do the same thing that are automatically handled by abuild.<br />
# Versioning is done properly. For details see [[APKBUILD_Reference#pkgver]].<br />
# Licensing is done properly. Remove unnecessary copying of licensing that is already OSI approved.<br />
# Naming conventions rules for unofficial variables as in _gitrev is preferred over commit.<br />
# Indent with tabs not spaces.<br />
# Removal of explicit return 1. (They are still found the old APKBUILD files if you are learning but are now strongly discouraged.)<br />
# 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.<br />
# Explicit call to subpackages="$pkgname-doc" must be used instead of explicit gzip man page compression.<br />
# Ideally, lines should be no more than 80 columns wide<br />
<br />
Additionally, make sure to run the linter on your package:<br />
{{Cmd|doas apk add atools<br />
apkbuild-lint APKBUILD}}<br />
<br />
For more information see [[Development using git:Quality assurance]] and [[Package_policies]].<br />
Also check out [https://gitlab.alpinelinux.org/alpine/aports/-/blob/master/COMMITSTYLE.md?ref_type=heads aports/COMMITSTYLE.md] and [https://gitlab.alpinelinux.org/alpine/aports/-/blob/master/CODINGSTYLE.md?ref_type=heads aports/CODINGSTYLE.md]<br />
<br />
== Commit your work ==<br />
<br />
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. <br />
<br />
Update your git repo, before adding new files: <br />
<br />
{{Cmd|cd $aportsdir<br />
git pull}}<br />
<br />
This should pull all the changes made by others into your local git repo.<br />
<br />
When you think you are ready you can add your files to git: <br />
<br />
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.<br />
<br />
{{Cmd|cd $aportsdir<br />
git add testing/$pkgdir (include any other files needed for the build; $pkgname.install...)<br />
git commit}}<br />
<br />
Use the following commit message template for new aports (without the comments):<br />
<br />
{{Cat|template|testing/$pkgname: new aport # this will be the subject line<br />
# a blank line<br />
$url # project homepage<br />
$pkgdesc # one line description}}<br />
<br />
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:<br />
<br />
{{Cat|aports/.git/hooks/prepare-commit-msg|<nowiki>#!/bin/sh<br />
case "$2,$3" in<br />
,|template,)<br />
if git diff-index --diff-filter=A --name-only --cached HEAD \<br />
| grep -q '/APKBUILD$'; then<br />
meta() { git diff --staged | grep "^+$1" | sed 's/.*="\?//;s/"$//';}<br />
printf 'testing/%s: new aport\n\n%s\n%s\n' "$(meta pkgname)" \<br />
"$(meta url)" "$(meta pkgdesc)" "$(cat $1)" > "$1"<br />
else<br />
printf '%s\n\n%s' `git diff-index --name-only --cached HEAD \<br />
| sed -n 's/\/APKBUILD$//p;q'` "$(cat $1)" > "$1"<br />
fi;;<br />
esac</nowiki>}}<br />
<br />
Now your changes are only available locally in your repository.<br />
<br />
Because you do not have push rights to the Alpine aports repository you need to create a merge request to [https://gitlab.alpinelinux.org/alpine/aports Alpine's GitLab instance].<br />
<br />
Alternatively you can also create a diff (patch) of the changes you made and send this patch to the <br />
[https://lists.alpinelinux.org/~alpine/aports alpine-aports mailinglist].<br />
<br />
To create a diff patch:<br />
<br />
{{Cmd|git format-patch HEAD^}}<br />
<br />
or if you have sprunge, you can create a link to your patch for convenience<br />
<br />
{{Cmd|git format-patch HEAD^ --stdout <nowiki>|</nowiki> sprunge}}<br />
<br />
== Automated flagging of outdated ports ==<br />
Consider adding your port to [https://release-monitoring.org/ Anitya], so it will be flagged as outdated<br />
as soon as a new stable version is released by upstream.<br />
<br />
== See Also ==<br />
* [[APKBUILD Reference]]<br />
* [[APKBUILD examples]]<br />
* [[Development using git]]<br />
* [[Development using git:Quality assurance]]<br />
<br />
[[category: Package Manager]]</div>Rickyrockrathttps://wiki.alpinelinux.org/w/index.php?title=Creating_an_Alpine_package&diff=26376Creating an Alpine package2024-02-11T23:42:09Z<p>Rickyrockrat: /* Overview */</p>
<hr />
<div>{{TOC right}}<br />
== Overview ==<br />
<br />
This is a brief list of the steps to add a new package. Details are below, but a NB can miss a few steps.<br />
<ol><br />
<li>Create an account on github.alpine<br />
<li>Fork the aports repository. <br />
<li>Clone your new fork.<br />
<li>Set git pull.rebase=true, set your username and email.<br />
<li>Create a new branch (don't use master).<br />
<li>Add a new directory under testing that is your new package name.<br />
<li>Add your APKBUILD file.<br />
<li>Run abuild checksum<br />
<li>Make sure you run the apkbuild-lint and aport -r and there are no warnings.<br />
<li>Commit your APKBUILD with the commit message: 'testing/packagename: new aport'<br />
<li>Push your changes to github.alpine.<br />
<li>Create a merge request.<br />
</ol><br />
<br />
Please see the rest of this wiki for details on the steps above.<br />
<br />
== Requirements ==<br />
<br />
To build a package for Alpine Linux you need an Alpine Linux installation. Check the [[Installation]] page to see all available installation options.<br />
<br />
== Setup your system and account ==<br />
{{:Setup_your_system_and_account_for_building_packages}}<br />
<br />
== Getting some help ==<br />
<br />
It might be wise to start by checking what the [[Abuild and Helpers|abuild]] program can/cannot do.<br />
<br />
{{Cmd|abuild -h}}<br />
<br />
For real help, you can also go on #alpine-devel on [[IRC]].<br />
<br />
A reference for APKBUILD files is available as [[APKBUILD Reference]] wiki page or a man page in the 'abuild-doc' package:<br />
<br />
{{Cmd|man APKBUILD}}<br />
<br />
<br />
== Creating an APKBUILD file ==<br />
<br />
=== Use a template APKBUILD ===<br />
<br />
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.<br />
<br />
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.<br />
<br />
{{:Abuild and Helpers}}<br />
<br />
{{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. }}<br />
<br />
[[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. <br />
<br />
If you are creating a daemon package which needs initd scripts you can add the -c making it: <br />
<br />
{{Cmd|newapkbuild -c ''packagename''}}<br />
<br />
This will copy the sample initd and confd files to the build directory.<BR><br />
A third file sample.install file will be copied as well (we will discuss this later on).<br />
<br />
=== Modify your APKBUILD ===<br />
Edit APKBUILD and fill in the needed info (especially pkgname, pkgver, pkgdesc, url, license, depends and source). <br />
<br />
If you are going to use any of the variables for directories like $pkgdir, always make sure they are double quoted like: <br />
<br />
"$pkgdir"/somedir<br />
<br />
This will prevent issues with spaces/special characters in the future. <br />
<br />
{{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.}}<br />
<br />
=== APKBUILD variables/functions ===<br />
<br />
==== source ====<br />
<br />
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.<br />
<br />
Here are few things to note:<br />
<br />
* 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:<br />
: {{cmd|abuild checksum}}<br />
: {{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.}}<br />
<br />
* When the remote file is hosted at SourceForge, it's best to specify the special mirrors link used by SourceForge:<br />
: <pre>http://downloads.sourceforge.net/$pkgname/$pkgname-$pkgver.tar.gz</pre><br />
: (or similar depending on the package).<br />
<br />
* When the remote filename is not specified in the URI (ie, does not end in '/software-1.0.tar.gz'), such as:<br />
: <pre>http://oss.example.org/?get=software&ver=1.0</pre><br />
: You must prepend '${pkgname}-${pkgver}.tar.gz::' to the protocol, like so:<br />
: <pre>source="${pkgname}-${pkgver}.tar.gz::http://oss.example.org/?get=software&ver=1.0"</pre><br />
: 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.<br />
<br />
* 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>https://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.<br />
<br />
* abuild currently supports the following protocols for remote file retrieval:<br />
** http<br />
** https<br />
** ftp<br />
<br />
<!--: {{Note|If the you want to download from https, you need GNU wget installed on your system.}}--><br />
<br />
* abuild currently supports the following archive types/archive file extensions:<br />
** .tar<br />
** .tar.gz / .tgz<br />
** .tar.bz2<br />
** .tar.lz (only in Alpine >=3.7)<br />
** .tar.lzma<br />
** .tar.xz<br />
** .zip<br />
<br />
==== depends &amp; makedepends ====<br />
<br />
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 [https://en.wikipedia.org/wiki/Rtfm RTFM]. <br />
<br />
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: <br />
<br />
{{Cmd|abuild unpack}}<br />
<br />
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, ...). <br />
<br />
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.<br />
<br />
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).<br />
<br />
* [https://gitweb.gentoo.org/repo/gentoo.git/tree/ Gentoo Ebuilds] <br />
* [https://archlinux.org/packages/?q=search Arch Linux packages] [https://aur.archlinux.org/ Arch Linux User Repository]<br />
<br />
==== license ====<br />
<br />
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.<br />
<br />
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.<br />
<br />
Note that some licenses have additional requirements that should be adhered to. The <code>MIT</code> license for example has the requirement:<br />
<br />
<blockquote><br />
The above copyright notice and this permission notice (including the next paragraph) shall be included in all copies or substantial portions of the Software.<br />
</blockquote><br />
<br />
This means that we need to include the license as shipped with the project.<br />
<br />
If a package has a special/custom license or is not listed as [https://opensource.org/licenses/alphabetical OSI approved], use the identifier "custom". In that case we need to provide the license file with the package as well.<br />
<br />
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: <br />
<br />
subpackages="$pkgname-doc"<br />
<br />
Add a similar line to the following to your package() function, depending on the license description file: <br />
<br />
{{Cmd|install -Dm644 COPYING "$pkgdir"/usr/share/licenses/$pkgname/COPYING}}<br />
<br />
If you follow these steps then abuild will automatically add the license to the package-doc apk for you.<br />
<br />
{{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. }}<br />
<br />
==== arch ====<br />
<br />
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 (e.g., a pure-python package).<br />
{{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.}}<br />
<br />
==== url ====<br />
<br />
Website address for the program. This is useful later on when either finding documentation or other information about the package.<br />
<br />
==== pkgdesc ====<br />
<br />
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.<br />
<br />
Here is an example from apk_info for the OpenSSH client package:<br />
<br />
pkgdesc="Port of OpenBSD's free SSH release - client"<br />
<br />
==== pkgver ====<br />
<br />
Provide the release number of the package you are building.<br />
<br />
==== pkgrel ====<br />
<br />
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.<br />
<br />
==== pkgname ====<br />
<br />
The base name of the package you are creating. For Freeswitch 1.0.6, you would use "freeswitch"<br />
<br />
==== install ====<br />
<br />
There are 6 different kinds of install scripts. Each script is called with the $pkgname.''<action>'' where ''<action>'' is one of the following:<br />
<br />
<dl><br />
<dt>$pkgname.pre-install<br />
<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:<br />
<pre><br />
#!/bin/sh<br />
<br />
addgroup -S clamav 2>/dev/null<br />
adduser -S -D -H -s /bin/false -G clamav -g clamav clamav 2>/dev/null<br />
<br />
exit 0<br />
</pre><br />
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.<br />
<br />
<dt>$pkgname.post-install<br />
<dd>This script is executed after the package is installed.<br />
<br />
<dt>$pkgname.pre-upgrade<br />
<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.<br />
<br />
<dt>$pkgname.post-upgrade<br />
<dd>Same as post-install but is executed after upgrading/downgrading/reinstalling an already installed package. <br />
<br />
<dt>$pkgname.pre-deinstall<br />
<dd>This script is executed before uninstalling a package. If script exits with failure apk will not uninstall the package.<br />
<br />
<dt>$pkgname.post-deinstall<br />
<dd>This script is executed after a package have been uninstalled. For example, can be used to restore busybox links:<br />
<pre><br />
#!/bin/sh<br />
busybox --install -s<br />
</pre><br />
<br />
</dl><br />
<br />
If the package has a pre-install and post-install script the APKBUILD should have the ''install'' variable defined:<br />
<pre><br />
...<br />
install="$pkgname.pre-install $pkgname.post-install"<br />
<br />
...<br />
</pre><br />
<br />
==== subpackages ====<br />
<br />
$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. <br />
<br />
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. <br />
<br />
To see if you need the -dev package you can run the following cmd: <br />
<br />
{{Cmd|find pkg/usr/ -name '*.[acho]' -o -name '*.la'}}<br />
<br />
If this returns any files you need to include the -dev package. <br />
<br />
<br> To see if you need the -doc package you can run the following cmd: <br />
<br />
{{Cmd|find pkg/usr/share -name doc -o -name man -o -name info -o -name html -o -name sgml -o -name licenses}}<br />
<br />
If this returns any directories you need to include the -doc package. <br />
<br />
===== Custom subpackages =====<br />
<br />
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: <br />
<br />
test() {<br />
mkdir -p "$subpkgdir"/usr<br />
mv "$pkgdir"/usr/package-test "$subpkgdir"/usr/<br />
# or amove usr/package-test<br />
}<br />
<br />
<br />
We also need to add the package info to $subpackages variable: <br />
<br />
subpackages="$pkgname-doc $pkgname-dev $pkgname-test"<br />
<br />
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. <br />
<br />
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: <br />
<br />
depends="perl"<br />
makedepends="perl-dev"<br />
<br />
If we would install the base package it would not install perl, but if we install the package-test package it would.<br />
<br />
==== Patches ====<br />
<br />
Please make sure you always submit human readable patches. Ways to create them are: <br />
<br />
directory compare: <br />
<br />
{{Cmd|diff -Nurp original_directory new_directory &gt; filename.patch}}<br />
<br />
file compare: <br />
<br />
{{Cmd|diff -up original.file new.file &gt; filename.patch}}<br />
<br />
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.<br />
<br />
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: <br />
<br />
10-patch1.patch 20-patch2.patch 30-patch3.patch<br />
<br />
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).<br />
<br />
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:<br />
<br />
prepare() {<br />
default_prepare<br />
<br />
# do your stuff<br />
}<br />
<br />
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''.<br />
<br />
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.<br />
<br />
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.<br />
<br />
{{Cat|example.patch|<nowiki><br />
Author: John Doe <johndoe@mail.com><br />
URL: http://.....<br />
Summary: Fixes musl compatibility<br />
----<br />
--- a/src/3rdparty/chromium/third_party/WebKit/Source/wtf/Assertions.cpp.orig<br />
+++ b/src/3rdparty/chromium/third_party/WebKit/Source/wtf/Assertions.cpp<br />
@@ -142,7 +142,7 @@<br />
};<br />
<br />
FrameToNameScope::FrameToNameScope(void* addr) : m_name(0), m_cxaDemangled(0) {<br />
-#if OS(MACOSX) || (OS(LINUX) && !defined(__UCLIBC__))<br />
+#if OS(MACOSX) || (OS(LINUX) && defined(__GLIBC__))<br />
Dl_info info;<br />
if (!dladdr(addr, &info) || !info.dli_sname)<br />
return;<br />
</nowiki>}}<br />
<br />
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.<br />
<br />
It is good etiquette to give credit at the top and the location of where you originally found them with notes.<br />
<br />
Excluding patches with global variable resembling patch_opts is not available on Alpine. To exclude patches you need to create your own custom prepare().<br />
<br />
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.<br />
<br />
Just do something like:<br />
<br />
<pre><br />
makedepends="patchutils"<br />
<br />
prepare() {<br />
...<br />
cd "$builddir"<br />
filterdiff -x '*drivers/video/logo*' "$srcdir"/original.patch > "$builddir"/modified.patch<br />
patch -p1 -i "$builddir"/modified.patch<br />
}<br />
</pre><br />
<br />
You need to put the wildcard pattern in single quotes for it to work.<br />
<br />
==== Configure options ====<br />
<br />
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. <br />
<br />
We are not covering the depend switches here we have discussed this already in the depend section.<br />
<br />
<br />
==== Make options ====<br />
<br />
If you notice weird problems when compiling or installing the package with make/make install you could try to disable [https://www.gnu.org/software/make/manual/make.html#Parallel parallel] building/installing. A normal make line would be: <br />
<br />
{{Cmd|make}}<br />
<br />
To disable parallel we use: <br />
<br />
{{Cmd|make -j1}}<br />
<br />
We can use the same for make install. <br />
<br />
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: <br />
<br />
{{Cmd|make DESTDIR{{=}}"$pkgdir" install}}<br />
<br />
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 doas when needed. If by accident the Makefile does not support DESTDIR variable it will fail to install in our build system system directories.<br />
<br />
==== builddir ====<br />
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.<br />
<br />
<pre><br />
builddir="$srcdir"/$pkgname-$pkgver<br />
</pre><br />
<br />
==== Additional files ====<br />
<br />
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): <br />
<br />
{{Cmd|install -Dm644 doc/$pkgname.conf "$pkgdir"/etc/$pkgname.conf}}<br />
<br />
== Build the package ==<br />
<br />
If you did not already create the checksums as mentioned above you can do so now: <br />
<br />
{{Cmd|cd $pkgname<br />
abuild checksum}}<br />
<br />
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.<br />
<br />
{{Cmd|abuild -r}}<br />
<br />
See also [[Abuild_and_Helpers|Abuild and Helpers]].<br />
<br />
== Testing the package locally ==<br />
<br />
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.<br />
<br />
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.<br />
<br />
{{Cat|/etc/apk/repositories|/home/USER/packages/testing/<br />
/home/USER/packages/main/<br />
/home/USER/packages/community/<br />
https://dl-cdn.alpinelinux.org/alpine/edge/main<br />
https://dl-cdn.alpinelinux.org/alpine/edge/community<br />
https://dl-cdn.alpinelinux.org/alpine/edge/testing<br />
}}<br />
<br />
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>:<br />
<br />
{{Cmd|doas apk add --repository /home/USER/packages/testing $pkgname}}<br />
<br />
== Code review ==<br />
<br />
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:<br />
<br />
# Custom global variables should be prefixed with underscore (_).<br />
# Compact code as in merged commands, removed unused variables, removal of functions that do the same thing that are automatically handled by abuild.<br />
# Versioning is done properly. For details see [[APKBUILD_Reference#pkgver]].<br />
# Licensing is done properly. Remove unnecessary copying of licensing that is already OSI approved.<br />
# Naming conventions rules for unofficial variables as in _gitrev is preferred over commit.<br />
# Indent with tabs not spaces.<br />
# Removal of explicit return 1. (They are still found the old APKBUILD files if you are learning but are now strongly discouraged.)<br />
# 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.<br />
# Explicit call to subpackages="$pkgname-doc" must be used instead of explicit gzip man page compression.<br />
# Ideally, lines should be no more than 80 columns wide<br />
<br />
Additionally, make sure to run the linter on your package:<br />
{{Cmd|doas apk add atools<br />
apkbuild-lint APKBUILD}}<br />
<br />
For more information see [[Development using git:Quality assurance]] and [[Package_policies]].<br />
Also check out [https://gitlab.alpinelinux.org/alpine/aports/-/blob/master/COMMITSTYLE.md?ref_type=heads aports/COMMITSTYLE.md] and [https://gitlab.alpinelinux.org/alpine/aports/-/blob/master/CODINGSTYLE.md?ref_type=heads aports/CODINGSTYLE.md]<br />
<br />
== Commit your work ==<br />
<br />
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. <br />
<br />
Update your git repo, before adding new files: <br />
<br />
{{Cmd|cd $aportsdir<br />
git pull}}<br />
<br />
This should pull all the changes made by others into your local git repo.<br />
<br />
When you think you are ready you can add your files to git: <br />
<br />
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.<br />
<br />
{{Cmd|cd $aportsdir<br />
git add testing/$pkgdir (include any other files needed for the build; $pkgname.install...)<br />
git commit}}<br />
<br />
Use the following commit message template for new aports (without the comments):<br />
<br />
{{Cat|template|testing/$pkgname: new aport # this will be the subject line<br />
# a blank line<br />
$url # project homepage<br />
$pkgdesc # one line description}}<br />
<br />
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:<br />
<br />
{{Cat|aports/.git/hooks/prepare-commit-msg|<nowiki>#!/bin/sh<br />
case "$2,$3" in<br />
,|template,)<br />
if git diff-index --diff-filter=A --name-only --cached HEAD \<br />
| grep -q '/APKBUILD$'; then<br />
meta() { git diff --staged | grep "^+$1" | sed 's/.*="\?//;s/"$//';}<br />
printf 'testing/%s: new aport\n\n%s\n%s\n' "$(meta pkgname)" \<br />
"$(meta url)" "$(meta pkgdesc)" "$(cat $1)" > "$1"<br />
else<br />
printf '%s\n\n%s' `git diff-index --name-only --cached HEAD \<br />
| sed -n 's/\/APKBUILD$//p;q'` "$(cat $1)" > "$1"<br />
fi;;<br />
esac</nowiki>}}<br />
<br />
Now your changes are only available locally in your repository.<br />
<br />
Because you do not have push rights to the Alpine aports repository you need to create a merge request to [https://gitlab.alpinelinux.org/alpine/aports Alpine's GitLab instance].<br />
<br />
Alternatively you can also create a diff (patch) of the changes you made and send this patch to the <br />
[https://lists.alpinelinux.org/~alpine/aports alpine-aports mailinglist].<br />
<br />
To create a diff patch:<br />
<br />
{{Cmd|git format-patch HEAD^}}<br />
<br />
or if you have sprunge, you can create a link to your patch for convenience<br />
<br />
{{Cmd|git format-patch HEAD^ --stdout <nowiki>|</nowiki> sprunge}}<br />
<br />
== Automated flagging of outdated ports ==<br />
Consider adding your port to [https://release-monitoring.org/ Anitya], so it will be flagged as outdated<br />
as soon as a new stable version is released by upstream.<br />
<br />
== See Also ==<br />
* [[APKBUILD Reference]]<br />
* [[APKBUILD examples]]<br />
* [[Development using git]]<br />
* [[Development using git:Quality assurance]]<br />
<br />
[[category: Package Manager]]</div>Rickyrockrathttps://wiki.alpinelinux.org/w/index.php?title=Creating_an_Alpine_package&diff=26375Creating an Alpine package2024-02-11T23:38:59Z<p>Rickyrockrat: /* Overview */</p>
<hr />
<div>{{TOC right}}<br />
== Overview ==<br />
<br />
This is a brief list of the steps to add a new package. Details are below, but a NB can miss a few steps.<br />
<ol><br />
<li>Create an account on github.alpine<br />
<li>Fork the aports repository. <br />
<li>Clone your new fork.<br />
<li>Create a new branch (don't use master).<br />
<li>Add a new directory under testing that is your new package name.<br />
<li>Add your APKBUILD file.<br />
<li>Run abuild checksum<br />
<li>Make sure you run the apkbuild-lint and aport -r and there are no warnings.<br />
<li>Commit your APKBUILD with the commit message: 'testing/packagename: new aport'<br />
<li>Push your changes to github.alpine.<br />
<li>Create a merge request.<br />
</ol><br />
<br />
Please see the rest of this wiki for details on the steps above.<br />
<br />
== Requirements ==<br />
<br />
To build a package for Alpine Linux you need an Alpine Linux installation. Check the [[Installation]] page to see all available installation options.<br />
<br />
== Setup your system and account ==<br />
{{:Setup_your_system_and_account_for_building_packages}}<br />
<br />
== Getting some help ==<br />
<br />
It might be wise to start by checking what the [[Abuild and Helpers|abuild]] program can/cannot do.<br />
<br />
{{Cmd|abuild -h}}<br />
<br />
For real help, you can also go on #alpine-devel on [[IRC]].<br />
<br />
A reference for APKBUILD files is available as [[APKBUILD Reference]] wiki page or a man page in the 'abuild-doc' package:<br />
<br />
{{Cmd|man APKBUILD}}<br />
<br />
<br />
== Creating an APKBUILD file ==<br />
<br />
=== Use a template APKBUILD ===<br />
<br />
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.<br />
<br />
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.<br />
<br />
{{:Abuild and Helpers}}<br />
<br />
{{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. }}<br />
<br />
[[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. <br />
<br />
If you are creating a daemon package which needs initd scripts you can add the -c making it: <br />
<br />
{{Cmd|newapkbuild -c ''packagename''}}<br />
<br />
This will copy the sample initd and confd files to the build directory.<BR><br />
A third file sample.install file will be copied as well (we will discuss this later on).<br />
<br />
=== Modify your APKBUILD ===<br />
Edit APKBUILD and fill in the needed info (especially pkgname, pkgver, pkgdesc, url, license, depends and source). <br />
<br />
If you are going to use any of the variables for directories like $pkgdir, always make sure they are double quoted like: <br />
<br />
"$pkgdir"/somedir<br />
<br />
This will prevent issues with spaces/special characters in the future. <br />
<br />
{{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.}}<br />
<br />
=== APKBUILD variables/functions ===<br />
<br />
==== source ====<br />
<br />
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.<br />
<br />
Here are few things to note:<br />
<br />
* 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:<br />
: {{cmd|abuild checksum}}<br />
: {{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.}}<br />
<br />
* When the remote file is hosted at SourceForge, it's best to specify the special mirrors link used by SourceForge:<br />
: <pre>http://downloads.sourceforge.net/$pkgname/$pkgname-$pkgver.tar.gz</pre><br />
: (or similar depending on the package).<br />
<br />
* When the remote filename is not specified in the URI (ie, does not end in '/software-1.0.tar.gz'), such as:<br />
: <pre>http://oss.example.org/?get=software&ver=1.0</pre><br />
: You must prepend '${pkgname}-${pkgver}.tar.gz::' to the protocol, like so:<br />
: <pre>source="${pkgname}-${pkgver}.tar.gz::http://oss.example.org/?get=software&ver=1.0"</pre><br />
: 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.<br />
<br />
* 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>https://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.<br />
<br />
* abuild currently supports the following protocols for remote file retrieval:<br />
** http<br />
** https<br />
** ftp<br />
<br />
<!--: {{Note|If the you want to download from https, you need GNU wget installed on your system.}}--><br />
<br />
* abuild currently supports the following archive types/archive file extensions:<br />
** .tar<br />
** .tar.gz / .tgz<br />
** .tar.bz2<br />
** .tar.lz (only in Alpine >=3.7)<br />
** .tar.lzma<br />
** .tar.xz<br />
** .zip<br />
<br />
==== depends &amp; makedepends ====<br />
<br />
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 [https://en.wikipedia.org/wiki/Rtfm RTFM]. <br />
<br />
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: <br />
<br />
{{Cmd|abuild unpack}}<br />
<br />
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, ...). <br />
<br />
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.<br />
<br />
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).<br />
<br />
* [https://gitweb.gentoo.org/repo/gentoo.git/tree/ Gentoo Ebuilds] <br />
* [https://archlinux.org/packages/?q=search Arch Linux packages] [https://aur.archlinux.org/ Arch Linux User Repository]<br />
<br />
==== license ====<br />
<br />
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.<br />
<br />
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.<br />
<br />
Note that some licenses have additional requirements that should be adhered to. The <code>MIT</code> license for example has the requirement:<br />
<br />
<blockquote><br />
The above copyright notice and this permission notice (including the next paragraph) shall be included in all copies or substantial portions of the Software.<br />
</blockquote><br />
<br />
This means that we need to include the license as shipped with the project.<br />
<br />
If a package has a special/custom license or is not listed as [https://opensource.org/licenses/alphabetical OSI approved], use the identifier "custom". In that case we need to provide the license file with the package as well.<br />
<br />
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: <br />
<br />
subpackages="$pkgname-doc"<br />
<br />
Add a similar line to the following to your package() function, depending on the license description file: <br />
<br />
{{Cmd|install -Dm644 COPYING "$pkgdir"/usr/share/licenses/$pkgname/COPYING}}<br />
<br />
If you follow these steps then abuild will automatically add the license to the package-doc apk for you.<br />
<br />
{{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. }}<br />
<br />
==== arch ====<br />
<br />
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 (e.g., a pure-python package).<br />
{{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.}}<br />
<br />
==== url ====<br />
<br />
Website address for the program. This is useful later on when either finding documentation or other information about the package.<br />
<br />
==== pkgdesc ====<br />
<br />
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.<br />
<br />
Here is an example from apk_info for the OpenSSH client package:<br />
<br />
pkgdesc="Port of OpenBSD's free SSH release - client"<br />
<br />
==== pkgver ====<br />
<br />
Provide the release number of the package you are building.<br />
<br />
==== pkgrel ====<br />
<br />
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.<br />
<br />
==== pkgname ====<br />
<br />
The base name of the package you are creating. For Freeswitch 1.0.6, you would use "freeswitch"<br />
<br />
==== install ====<br />
<br />
There are 6 different kinds of install scripts. Each script is called with the $pkgname.''<action>'' where ''<action>'' is one of the following:<br />
<br />
<dl><br />
<dt>$pkgname.pre-install<br />
<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:<br />
<pre><br />
#!/bin/sh<br />
<br />
addgroup -S clamav 2>/dev/null<br />
adduser -S -D -H -s /bin/false -G clamav -g clamav clamav 2>/dev/null<br />
<br />
exit 0<br />
</pre><br />
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.<br />
<br />
<dt>$pkgname.post-install<br />
<dd>This script is executed after the package is installed.<br />
<br />
<dt>$pkgname.pre-upgrade<br />
<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.<br />
<br />
<dt>$pkgname.post-upgrade<br />
<dd>Same as post-install but is executed after upgrading/downgrading/reinstalling an already installed package. <br />
<br />
<dt>$pkgname.pre-deinstall<br />
<dd>This script is executed before uninstalling a package. If script exits with failure apk will not uninstall the package.<br />
<br />
<dt>$pkgname.post-deinstall<br />
<dd>This script is executed after a package have been uninstalled. For example, can be used to restore busybox links:<br />
<pre><br />
#!/bin/sh<br />
busybox --install -s<br />
</pre><br />
<br />
</dl><br />
<br />
If the package has a pre-install and post-install script the APKBUILD should have the ''install'' variable defined:<br />
<pre><br />
...<br />
install="$pkgname.pre-install $pkgname.post-install"<br />
<br />
...<br />
</pre><br />
<br />
==== subpackages ====<br />
<br />
$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. <br />
<br />
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. <br />
<br />
To see if you need the -dev package you can run the following cmd: <br />
<br />
{{Cmd|find pkg/usr/ -name '*.[acho]' -o -name '*.la'}}<br />
<br />
If this returns any files you need to include the -dev package. <br />
<br />
<br> To see if you need the -doc package you can run the following cmd: <br />
<br />
{{Cmd|find pkg/usr/share -name doc -o -name man -o -name info -o -name html -o -name sgml -o -name licenses}}<br />
<br />
If this returns any directories you need to include the -doc package. <br />
<br />
===== Custom subpackages =====<br />
<br />
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: <br />
<br />
test() {<br />
mkdir -p "$subpkgdir"/usr<br />
mv "$pkgdir"/usr/package-test "$subpkgdir"/usr/<br />
# or amove usr/package-test<br />
}<br />
<br />
<br />
We also need to add the package info to $subpackages variable: <br />
<br />
subpackages="$pkgname-doc $pkgname-dev $pkgname-test"<br />
<br />
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. <br />
<br />
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: <br />
<br />
depends="perl"<br />
makedepends="perl-dev"<br />
<br />
If we would install the base package it would not install perl, but if we install the package-test package it would.<br />
<br />
==== Patches ====<br />
<br />
Please make sure you always submit human readable patches. Ways to create them are: <br />
<br />
directory compare: <br />
<br />
{{Cmd|diff -Nurp original_directory new_directory &gt; filename.patch}}<br />
<br />
file compare: <br />
<br />
{{Cmd|diff -up original.file new.file &gt; filename.patch}}<br />
<br />
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.<br />
<br />
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: <br />
<br />
10-patch1.patch 20-patch2.patch 30-patch3.patch<br />
<br />
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).<br />
<br />
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:<br />
<br />
prepare() {<br />
default_prepare<br />
<br />
# do your stuff<br />
}<br />
<br />
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''.<br />
<br />
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.<br />
<br />
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.<br />
<br />
{{Cat|example.patch|<nowiki><br />
Author: John Doe <johndoe@mail.com><br />
URL: http://.....<br />
Summary: Fixes musl compatibility<br />
----<br />
--- a/src/3rdparty/chromium/third_party/WebKit/Source/wtf/Assertions.cpp.orig<br />
+++ b/src/3rdparty/chromium/third_party/WebKit/Source/wtf/Assertions.cpp<br />
@@ -142,7 +142,7 @@<br />
};<br />
<br />
FrameToNameScope::FrameToNameScope(void* addr) : m_name(0), m_cxaDemangled(0) {<br />
-#if OS(MACOSX) || (OS(LINUX) && !defined(__UCLIBC__))<br />
+#if OS(MACOSX) || (OS(LINUX) && defined(__GLIBC__))<br />
Dl_info info;<br />
if (!dladdr(addr, &info) || !info.dli_sname)<br />
return;<br />
</nowiki>}}<br />
<br />
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.<br />
<br />
It is good etiquette to give credit at the top and the location of where you originally found them with notes.<br />
<br />
Excluding patches with global variable resembling patch_opts is not available on Alpine. To exclude patches you need to create your own custom prepare().<br />
<br />
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.<br />
<br />
Just do something like:<br />
<br />
<pre><br />
makedepends="patchutils"<br />
<br />
prepare() {<br />
...<br />
cd "$builddir"<br />
filterdiff -x '*drivers/video/logo*' "$srcdir"/original.patch > "$builddir"/modified.patch<br />
patch -p1 -i "$builddir"/modified.patch<br />
}<br />
</pre><br />
<br />
You need to put the wildcard pattern in single quotes for it to work.<br />
<br />
==== Configure options ====<br />
<br />
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. <br />
<br />
We are not covering the depend switches here we have discussed this already in the depend section.<br />
<br />
<br />
==== Make options ====<br />
<br />
If you notice weird problems when compiling or installing the package with make/make install you could try to disable [https://www.gnu.org/software/make/manual/make.html#Parallel parallel] building/installing. A normal make line would be: <br />
<br />
{{Cmd|make}}<br />
<br />
To disable parallel we use: <br />
<br />
{{Cmd|make -j1}}<br />
<br />
We can use the same for make install. <br />
<br />
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: <br />
<br />
{{Cmd|make DESTDIR{{=}}"$pkgdir" install}}<br />
<br />
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 doas when needed. If by accident the Makefile does not support DESTDIR variable it will fail to install in our build system system directories.<br />
<br />
==== builddir ====<br />
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.<br />
<br />
<pre><br />
builddir="$srcdir"/$pkgname-$pkgver<br />
</pre><br />
<br />
==== Additional files ====<br />
<br />
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): <br />
<br />
{{Cmd|install -Dm644 doc/$pkgname.conf "$pkgdir"/etc/$pkgname.conf}}<br />
<br />
== Build the package ==<br />
<br />
If you did not already create the checksums as mentioned above you can do so now: <br />
<br />
{{Cmd|cd $pkgname<br />
abuild checksum}}<br />
<br />
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.<br />
<br />
{{Cmd|abuild -r}}<br />
<br />
See also [[Abuild_and_Helpers|Abuild and Helpers]].<br />
<br />
== Testing the package locally ==<br />
<br />
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.<br />
<br />
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.<br />
<br />
{{Cat|/etc/apk/repositories|/home/USER/packages/testing/<br />
/home/USER/packages/main/<br />
/home/USER/packages/community/<br />
https://dl-cdn.alpinelinux.org/alpine/edge/main<br />
https://dl-cdn.alpinelinux.org/alpine/edge/community<br />
https://dl-cdn.alpinelinux.org/alpine/edge/testing<br />
}}<br />
<br />
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>:<br />
<br />
{{Cmd|doas apk add --repository /home/USER/packages/testing $pkgname}}<br />
<br />
== Code review ==<br />
<br />
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:<br />
<br />
# Custom global variables should be prefixed with underscore (_).<br />
# Compact code as in merged commands, removed unused variables, removal of functions that do the same thing that are automatically handled by abuild.<br />
# Versioning is done properly. For details see [[APKBUILD_Reference#pkgver]].<br />
# Licensing is done properly. Remove unnecessary copying of licensing that is already OSI approved.<br />
# Naming conventions rules for unofficial variables as in _gitrev is preferred over commit.<br />
# Indent with tabs not spaces.<br />
# Removal of explicit return 1. (They are still found the old APKBUILD files if you are learning but are now strongly discouraged.)<br />
# 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.<br />
# Explicit call to subpackages="$pkgname-doc" must be used instead of explicit gzip man page compression.<br />
# Ideally, lines should be no more than 80 columns wide<br />
<br />
Additionally, make sure to run the linter on your package:<br />
{{Cmd|doas apk add atools<br />
apkbuild-lint APKBUILD}}<br />
<br />
For more information see [[Development using git:Quality assurance]] and [[Package_policies]].<br />
Also check out [https://gitlab.alpinelinux.org/alpine/aports/-/blob/master/COMMITSTYLE.md?ref_type=heads aports/COMMITSTYLE.md] and [https://gitlab.alpinelinux.org/alpine/aports/-/blob/master/CODINGSTYLE.md?ref_type=heads aports/CODINGSTYLE.md]<br />
<br />
== Commit your work ==<br />
<br />
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. <br />
<br />
Update your git repo, before adding new files: <br />
<br />
{{Cmd|cd $aportsdir<br />
git pull}}<br />
<br />
This should pull all the changes made by others into your local git repo.<br />
<br />
When you think you are ready you can add your files to git: <br />
<br />
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.<br />
<br />
{{Cmd|cd $aportsdir<br />
git add testing/$pkgdir (include any other files needed for the build; $pkgname.install...)<br />
git commit}}<br />
<br />
Use the following commit message template for new aports (without the comments):<br />
<br />
{{Cat|template|testing/$pkgname: new aport # this will be the subject line<br />
# a blank line<br />
$url # project homepage<br />
$pkgdesc # one line description}}<br />
<br />
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:<br />
<br />
{{Cat|aports/.git/hooks/prepare-commit-msg|<nowiki>#!/bin/sh<br />
case "$2,$3" in<br />
,|template,)<br />
if git diff-index --diff-filter=A --name-only --cached HEAD \<br />
| grep -q '/APKBUILD$'; then<br />
meta() { git diff --staged | grep "^+$1" | sed 's/.*="\?//;s/"$//';}<br />
printf 'testing/%s: new aport\n\n%s\n%s\n' "$(meta pkgname)" \<br />
"$(meta url)" "$(meta pkgdesc)" "$(cat $1)" > "$1"<br />
else<br />
printf '%s\n\n%s' `git diff-index --name-only --cached HEAD \<br />
| sed -n 's/\/APKBUILD$//p;q'` "$(cat $1)" > "$1"<br />
fi;;<br />
esac</nowiki>}}<br />
<br />
Now your changes are only available locally in your repository.<br />
<br />
Because you do not have push rights to the Alpine aports repository you need to create a merge request to [https://gitlab.alpinelinux.org/alpine/aports Alpine's GitLab instance].<br />
<br />
Alternatively you can also create a diff (patch) of the changes you made and send this patch to the <br />
[https://lists.alpinelinux.org/~alpine/aports alpine-aports mailinglist].<br />
<br />
To create a diff patch:<br />
<br />
{{Cmd|git format-patch HEAD^}}<br />
<br />
or if you have sprunge, you can create a link to your patch for convenience<br />
<br />
{{Cmd|git format-patch HEAD^ --stdout <nowiki>|</nowiki> sprunge}}<br />
<br />
== Automated flagging of outdated ports ==<br />
Consider adding your port to [https://release-monitoring.org/ Anitya], so it will be flagged as outdated<br />
as soon as a new stable version is released by upstream.<br />
<br />
== See Also ==<br />
* [[APKBUILD Reference]]<br />
* [[APKBUILD examples]]<br />
* [[Development using git]]<br />
* [[Development using git:Quality assurance]]<br />
<br />
[[category: Package Manager]]</div>Rickyrockrathttps://wiki.alpinelinux.org/w/index.php?title=Creating_an_Alpine_package&diff=26374Creating an Alpine package2024-02-11T23:37:38Z<p>Rickyrockrat: Added a Quickstart/Overview.</p>
<hr />
<div>{{TOC right}}<br />
== Overview ==<br />
<br />
This is a brief list of the steps to add a new package. Details are below, but a NB can miss a few steps.<br />
<ol><br />
<li>Create an account on github.alpine<br />
<li>Fork the aports repository. <br />
<li>Clone your new fork.<br />
<li>Create a new branch (don't use master).<br />
<li>Add a new directory under testing that is your new package name.<br />
<li>Add your APKBUILD file.<br />
<li>Run aport makesum<br />
<li>Make sure you run the apklint and aport -r and there are no warnings.<br />
<li>Commit your APKBUILD with the commit message: 'testing/packagename: new aport'<br />
<li>Push your changes to github.alpine.<br />
<li>Create a merge request.<br />
</ol><br />
<br />
Please see the rest of this wiki for details on the steps above.<br />
<br />
== Requirements ==<br />
<br />
To build a package for Alpine Linux you need an Alpine Linux installation. Check the [[Installation]] page to see all available installation options.<br />
<br />
== Setup your system and account ==<br />
{{:Setup_your_system_and_account_for_building_packages}}<br />
<br />
== Getting some help ==<br />
<br />
It might be wise to start by checking what the [[Abuild and Helpers|abuild]] program can/cannot do.<br />
<br />
{{Cmd|abuild -h}}<br />
<br />
For real help, you can also go on #alpine-devel on [[IRC]].<br />
<br />
A reference for APKBUILD files is available as [[APKBUILD Reference]] wiki page or a man page in the 'abuild-doc' package:<br />
<br />
{{Cmd|man APKBUILD}}<br />
<br />
<br />
== Creating an APKBUILD file ==<br />
<br />
=== Use a template APKBUILD ===<br />
<br />
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.<br />
<br />
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.<br />
<br />
{{:Abuild and Helpers}}<br />
<br />
{{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. }}<br />
<br />
[[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. <br />
<br />
If you are creating a daemon package which needs initd scripts you can add the -c making it: <br />
<br />
{{Cmd|newapkbuild -c ''packagename''}}<br />
<br />
This will copy the sample initd and confd files to the build directory.<BR><br />
A third file sample.install file will be copied as well (we will discuss this later on).<br />
<br />
=== Modify your APKBUILD ===<br />
Edit APKBUILD and fill in the needed info (especially pkgname, pkgver, pkgdesc, url, license, depends and source). <br />
<br />
If you are going to use any of the variables for directories like $pkgdir, always make sure they are double quoted like: <br />
<br />
"$pkgdir"/somedir<br />
<br />
This will prevent issues with spaces/special characters in the future. <br />
<br />
{{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.}}<br />
<br />
=== APKBUILD variables/functions ===<br />
<br />
==== source ====<br />
<br />
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.<br />
<br />
Here are few things to note:<br />
<br />
* 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:<br />
: {{cmd|abuild checksum}}<br />
: {{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.}}<br />
<br />
* When the remote file is hosted at SourceForge, it's best to specify the special mirrors link used by SourceForge:<br />
: <pre>http://downloads.sourceforge.net/$pkgname/$pkgname-$pkgver.tar.gz</pre><br />
: (or similar depending on the package).<br />
<br />
* When the remote filename is not specified in the URI (ie, does not end in '/software-1.0.tar.gz'), such as:<br />
: <pre>http://oss.example.org/?get=software&ver=1.0</pre><br />
: You must prepend '${pkgname}-${pkgver}.tar.gz::' to the protocol, like so:<br />
: <pre>source="${pkgname}-${pkgver}.tar.gz::http://oss.example.org/?get=software&ver=1.0"</pre><br />
: 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.<br />
<br />
* 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>https://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.<br />
<br />
* abuild currently supports the following protocols for remote file retrieval:<br />
** http<br />
** https<br />
** ftp<br />
<br />
<!--: {{Note|If the you want to download from https, you need GNU wget installed on your system.}}--><br />
<br />
* abuild currently supports the following archive types/archive file extensions:<br />
** .tar<br />
** .tar.gz / .tgz<br />
** .tar.bz2<br />
** .tar.lz (only in Alpine >=3.7)<br />
** .tar.lzma<br />
** .tar.xz<br />
** .zip<br />
<br />
==== depends &amp; makedepends ====<br />
<br />
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 [https://en.wikipedia.org/wiki/Rtfm RTFM]. <br />
<br />
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: <br />
<br />
{{Cmd|abuild unpack}}<br />
<br />
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, ...). <br />
<br />
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.<br />
<br />
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).<br />
<br />
* [https://gitweb.gentoo.org/repo/gentoo.git/tree/ Gentoo Ebuilds] <br />
* [https://archlinux.org/packages/?q=search Arch Linux packages] [https://aur.archlinux.org/ Arch Linux User Repository]<br />
<br />
==== license ====<br />
<br />
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.<br />
<br />
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.<br />
<br />
Note that some licenses have additional requirements that should be adhered to. The <code>MIT</code> license for example has the requirement:<br />
<br />
<blockquote><br />
The above copyright notice and this permission notice (including the next paragraph) shall be included in all copies or substantial portions of the Software.<br />
</blockquote><br />
<br />
This means that we need to include the license as shipped with the project.<br />
<br />
If a package has a special/custom license or is not listed as [https://opensource.org/licenses/alphabetical OSI approved], use the identifier "custom". In that case we need to provide the license file with the package as well.<br />
<br />
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: <br />
<br />
subpackages="$pkgname-doc"<br />
<br />
Add a similar line to the following to your package() function, depending on the license description file: <br />
<br />
{{Cmd|install -Dm644 COPYING "$pkgdir"/usr/share/licenses/$pkgname/COPYING}}<br />
<br />
If you follow these steps then abuild will automatically add the license to the package-doc apk for you.<br />
<br />
{{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. }}<br />
<br />
==== arch ====<br />
<br />
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 (e.g., a pure-python package).<br />
{{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.}}<br />
<br />
==== url ====<br />
<br />
Website address for the program. This is useful later on when either finding documentation or other information about the package.<br />
<br />
==== pkgdesc ====<br />
<br />
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.<br />
<br />
Here is an example from apk_info for the OpenSSH client package:<br />
<br />
pkgdesc="Port of OpenBSD's free SSH release - client"<br />
<br />
==== pkgver ====<br />
<br />
Provide the release number of the package you are building.<br />
<br />
==== pkgrel ====<br />
<br />
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.<br />
<br />
==== pkgname ====<br />
<br />
The base name of the package you are creating. For Freeswitch 1.0.6, you would use "freeswitch"<br />
<br />
==== install ====<br />
<br />
There are 6 different kinds of install scripts. Each script is called with the $pkgname.''<action>'' where ''<action>'' is one of the following:<br />
<br />
<dl><br />
<dt>$pkgname.pre-install<br />
<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:<br />
<pre><br />
#!/bin/sh<br />
<br />
addgroup -S clamav 2>/dev/null<br />
adduser -S -D -H -s /bin/false -G clamav -g clamav clamav 2>/dev/null<br />
<br />
exit 0<br />
</pre><br />
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.<br />
<br />
<dt>$pkgname.post-install<br />
<dd>This script is executed after the package is installed.<br />
<br />
<dt>$pkgname.pre-upgrade<br />
<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.<br />
<br />
<dt>$pkgname.post-upgrade<br />
<dd>Same as post-install but is executed after upgrading/downgrading/reinstalling an already installed package. <br />
<br />
<dt>$pkgname.pre-deinstall<br />
<dd>This script is executed before uninstalling a package. If script exits with failure apk will not uninstall the package.<br />
<br />
<dt>$pkgname.post-deinstall<br />
<dd>This script is executed after a package have been uninstalled. For example, can be used to restore busybox links:<br />
<pre><br />
#!/bin/sh<br />
busybox --install -s<br />
</pre><br />
<br />
</dl><br />
<br />
If the package has a pre-install and post-install script the APKBUILD should have the ''install'' variable defined:<br />
<pre><br />
...<br />
install="$pkgname.pre-install $pkgname.post-install"<br />
<br />
...<br />
</pre><br />
<br />
==== subpackages ====<br />
<br />
$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. <br />
<br />
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. <br />
<br />
To see if you need the -dev package you can run the following cmd: <br />
<br />
{{Cmd|find pkg/usr/ -name '*.[acho]' -o -name '*.la'}}<br />
<br />
If this returns any files you need to include the -dev package. <br />
<br />
<br> To see if you need the -doc package you can run the following cmd: <br />
<br />
{{Cmd|find pkg/usr/share -name doc -o -name man -o -name info -o -name html -o -name sgml -o -name licenses}}<br />
<br />
If this returns any directories you need to include the -doc package. <br />
<br />
===== Custom subpackages =====<br />
<br />
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: <br />
<br />
test() {<br />
mkdir -p "$subpkgdir"/usr<br />
mv "$pkgdir"/usr/package-test "$subpkgdir"/usr/<br />
# or amove usr/package-test<br />
}<br />
<br />
<br />
We also need to add the package info to $subpackages variable: <br />
<br />
subpackages="$pkgname-doc $pkgname-dev $pkgname-test"<br />
<br />
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. <br />
<br />
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: <br />
<br />
depends="perl"<br />
makedepends="perl-dev"<br />
<br />
If we would install the base package it would not install perl, but if we install the package-test package it would.<br />
<br />
==== Patches ====<br />
<br />
Please make sure you always submit human readable patches. Ways to create them are: <br />
<br />
directory compare: <br />
<br />
{{Cmd|diff -Nurp original_directory new_directory &gt; filename.patch}}<br />
<br />
file compare: <br />
<br />
{{Cmd|diff -up original.file new.file &gt; filename.patch}}<br />
<br />
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.<br />
<br />
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: <br />
<br />
10-patch1.patch 20-patch2.patch 30-patch3.patch<br />
<br />
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).<br />
<br />
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:<br />
<br />
prepare() {<br />
default_prepare<br />
<br />
# do your stuff<br />
}<br />
<br />
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''.<br />
<br />
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.<br />
<br />
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.<br />
<br />
{{Cat|example.patch|<nowiki><br />
Author: John Doe <johndoe@mail.com><br />
URL: http://.....<br />
Summary: Fixes musl compatibility<br />
----<br />
--- a/src/3rdparty/chromium/third_party/WebKit/Source/wtf/Assertions.cpp.orig<br />
+++ b/src/3rdparty/chromium/third_party/WebKit/Source/wtf/Assertions.cpp<br />
@@ -142,7 +142,7 @@<br />
};<br />
<br />
FrameToNameScope::FrameToNameScope(void* addr) : m_name(0), m_cxaDemangled(0) {<br />
-#if OS(MACOSX) || (OS(LINUX) && !defined(__UCLIBC__))<br />
+#if OS(MACOSX) || (OS(LINUX) && defined(__GLIBC__))<br />
Dl_info info;<br />
if (!dladdr(addr, &info) || !info.dli_sname)<br />
return;<br />
</nowiki>}}<br />
<br />
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.<br />
<br />
It is good etiquette to give credit at the top and the location of where you originally found them with notes.<br />
<br />
Excluding patches with global variable resembling patch_opts is not available on Alpine. To exclude patches you need to create your own custom prepare().<br />
<br />
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.<br />
<br />
Just do something like:<br />
<br />
<pre><br />
makedepends="patchutils"<br />
<br />
prepare() {<br />
...<br />
cd "$builddir"<br />
filterdiff -x '*drivers/video/logo*' "$srcdir"/original.patch > "$builddir"/modified.patch<br />
patch -p1 -i "$builddir"/modified.patch<br />
}<br />
</pre><br />
<br />
You need to put the wildcard pattern in single quotes for it to work.<br />
<br />
==== Configure options ====<br />
<br />
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. <br />
<br />
We are not covering the depend switches here we have discussed this already in the depend section.<br />
<br />
<br />
==== Make options ====<br />
<br />
If you notice weird problems when compiling or installing the package with make/make install you could try to disable [https://www.gnu.org/software/make/manual/make.html#Parallel parallel] building/installing. A normal make line would be: <br />
<br />
{{Cmd|make}}<br />
<br />
To disable parallel we use: <br />
<br />
{{Cmd|make -j1}}<br />
<br />
We can use the same for make install. <br />
<br />
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: <br />
<br />
{{Cmd|make DESTDIR{{=}}"$pkgdir" install}}<br />
<br />
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 doas when needed. If by accident the Makefile does not support DESTDIR variable it will fail to install in our build system system directories.<br />
<br />
==== builddir ====<br />
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.<br />
<br />
<pre><br />
builddir="$srcdir"/$pkgname-$pkgver<br />
</pre><br />
<br />
==== Additional files ====<br />
<br />
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): <br />
<br />
{{Cmd|install -Dm644 doc/$pkgname.conf "$pkgdir"/etc/$pkgname.conf}}<br />
<br />
== Build the package ==<br />
<br />
If you did not already create the checksums as mentioned above you can do so now: <br />
<br />
{{Cmd|cd $pkgname<br />
abuild checksum}}<br />
<br />
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.<br />
<br />
{{Cmd|abuild -r}}<br />
<br />
See also [[Abuild_and_Helpers|Abuild and Helpers]].<br />
<br />
== Testing the package locally ==<br />
<br />
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.<br />
<br />
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.<br />
<br />
{{Cat|/etc/apk/repositories|/home/USER/packages/testing/<br />
/home/USER/packages/main/<br />
/home/USER/packages/community/<br />
https://dl-cdn.alpinelinux.org/alpine/edge/main<br />
https://dl-cdn.alpinelinux.org/alpine/edge/community<br />
https://dl-cdn.alpinelinux.org/alpine/edge/testing<br />
}}<br />
<br />
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>:<br />
<br />
{{Cmd|doas apk add --repository /home/USER/packages/testing $pkgname}}<br />
<br />
== Code review ==<br />
<br />
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:<br />
<br />
# Custom global variables should be prefixed with underscore (_).<br />
# Compact code as in merged commands, removed unused variables, removal of functions that do the same thing that are automatically handled by abuild.<br />
# Versioning is done properly. For details see [[APKBUILD_Reference#pkgver]].<br />
# Licensing is done properly. Remove unnecessary copying of licensing that is already OSI approved.<br />
# Naming conventions rules for unofficial variables as in _gitrev is preferred over commit.<br />
# Indent with tabs not spaces.<br />
# Removal of explicit return 1. (They are still found the old APKBUILD files if you are learning but are now strongly discouraged.)<br />
# 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.<br />
# Explicit call to subpackages="$pkgname-doc" must be used instead of explicit gzip man page compression.<br />
# Ideally, lines should be no more than 80 columns wide<br />
<br />
Additionally, make sure to run the linter on your package:<br />
{{Cmd|doas apk add atools<br />
apkbuild-lint APKBUILD}}<br />
<br />
For more information see [[Development using git:Quality assurance]] and [[Package_policies]].<br />
Also check out [https://gitlab.alpinelinux.org/alpine/aports/-/blob/master/COMMITSTYLE.md?ref_type=heads aports/COMMITSTYLE.md] and [https://gitlab.alpinelinux.org/alpine/aports/-/blob/master/CODINGSTYLE.md?ref_type=heads aports/CODINGSTYLE.md]<br />
<br />
== Commit your work ==<br />
<br />
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. <br />
<br />
Update your git repo, before adding new files: <br />
<br />
{{Cmd|cd $aportsdir<br />
git pull}}<br />
<br />
This should pull all the changes made by others into your local git repo.<br />
<br />
When you think you are ready you can add your files to git: <br />
<br />
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.<br />
<br />
{{Cmd|cd $aportsdir<br />
git add testing/$pkgdir (include any other files needed for the build; $pkgname.install...)<br />
git commit}}<br />
<br />
Use the following commit message template for new aports (without the comments):<br />
<br />
{{Cat|template|testing/$pkgname: new aport # this will be the subject line<br />
# a blank line<br />
$url # project homepage<br />
$pkgdesc # one line description}}<br />
<br />
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:<br />
<br />
{{Cat|aports/.git/hooks/prepare-commit-msg|<nowiki>#!/bin/sh<br />
case "$2,$3" in<br />
,|template,)<br />
if git diff-index --diff-filter=A --name-only --cached HEAD \<br />
| grep -q '/APKBUILD$'; then<br />
meta() { git diff --staged | grep "^+$1" | sed 's/.*="\?//;s/"$//';}<br />
printf 'testing/%s: new aport\n\n%s\n%s\n' "$(meta pkgname)" \<br />
"$(meta url)" "$(meta pkgdesc)" "$(cat $1)" > "$1"<br />
else<br />
printf '%s\n\n%s' `git diff-index --name-only --cached HEAD \<br />
| sed -n 's/\/APKBUILD$//p;q'` "$(cat $1)" > "$1"<br />
fi;;<br />
esac</nowiki>}}<br />
<br />
Now your changes are only available locally in your repository.<br />
<br />
Because you do not have push rights to the Alpine aports repository you need to create a merge request to [https://gitlab.alpinelinux.org/alpine/aports Alpine's GitLab instance].<br />
<br />
Alternatively you can also create a diff (patch) of the changes you made and send this patch to the <br />
[https://lists.alpinelinux.org/~alpine/aports alpine-aports mailinglist].<br />
<br />
To create a diff patch:<br />
<br />
{{Cmd|git format-patch HEAD^}}<br />
<br />
or if you have sprunge, you can create a link to your patch for convenience<br />
<br />
{{Cmd|git format-patch HEAD^ --stdout <nowiki>|</nowiki> sprunge}}<br />
<br />
== Automated flagging of outdated ports ==<br />
Consider adding your port to [https://release-monitoring.org/ Anitya], so it will be flagged as outdated<br />
as soon as a new stable version is released by upstream.<br />
<br />
== See Also ==<br />
* [[APKBUILD Reference]]<br />
* [[APKBUILD examples]]<br />
* [[Development using git]]<br />
* [[Development using git:Quality assurance]]<br />
<br />
[[category: Package Manager]]</div>Rickyrockrathttps://wiki.alpinelinux.org/w/index.php?title=How_to_set_up_Alpine_as_a_wireless_router&diff=22915How to set up Alpine as a wireless router2023-01-17T04:00:55Z<p>Rickyrockrat: Added nano pi build for latest alpine/kernel</p>
<hr />
<div>=== Pi Zero W Wireless Router ===<br />
<br />
This page describes building a Wireless Access Point with two wired ethernet ports for building a home router that connects to the internet with one wired port, and an internal LAN with the second wired port and the on-board WiFi.<br><br />
<br />
The intent is to provide this:<br><br />
<pre><br />
|<-->eth1 <-->| <br />
Internet <--> eth0 <-->FireWall<-->br0 Internal<--> ssh,bind,dhcp, with ssh reverse ssh connections.<br />
|<-->wlan0<-->|<br />
</pre><br />
<br />
=== Overview ===<br />
I generally run Debian and when forced by Red Hot Irons, Red Hat. This is my first foray into Alpine. So far I am very impressed. I mirrored the 3.12 armhf repos so I had things local when I needed them. Word to the wise, it comprises 13 GB of apk files.<br><br />
One *really* nice feature of Alpine is apk, the yum/apt replacement:<br><br />
* It is simple and to the point.<br />
* The same tool provides *repo* level dependency reporting!<br />
* Install of single packages without repo signing (I never did get the signing correct, but I can install).<br />
<br />
=== Prepare ===<br />
* Obtain a microSD card (or HDD) you can wipe the data from. We will assume it is /dev/sdc.<br />
* Make a 256M FAT16 partition (sudo mkfs.vfat -n ALPBOOT /dev/sdc1)<br />
* The rest of the device can be ext2 (ext3/4 on HDD) (sudo mke2fs -m1 -L alext3 /dev/sdc2).<br />
* Untar the alpine-rpi-3.12.3-armhf.tar.gz and copy all of the files to the fat16 partition which can be as large as 2G. <br />
* Make sure you have all the packages from the package list below installed on the SD card. This will save you lots of time.<br />
* Add this to usercfg.txt at the root of the FAT16 partition:<br />
enable_uart=1<br />
gpu_mem=16<br />
dtparam=audio=off<br />
* This is the contents of cmdline.txt:<br />
modules=loop,squashfs,sd-mod,usb-storage console=tty1 console=ttyAMA0,115200<br />
<br />
=== First Boot ===<br />
* Put the SD into the pi zero<br />
* Connect the serial port<br />
* Run minicom with the parameters set to 115200,n,8,1, no flow control.<br />
* Power up the Pi.<br />
<br />
=== Copy Root ===<br />
* mkdir /stage<br />
* mount /dev/sda2 /stage<br />
* for d in $(ls -1 /|grep -v 'media\|stage\|dev\|proc\|sys'); do cp -a /$d /stage; done<br />
* modules are loop mounted to /.modloop, and lib/modules is symlinked to that, so<br />
* rm /stage/lib/modules<br />
* cp -a /.modloop /stage/lib/modules<br />
* Fix cmdline.txt<br />
mount -o remount,rw /media/mmcblk0p1<br />
echo 'root=/dev/mmcblk0p2' >> /media/mmcblk0p1/cmdline.txt<br />
* reboot<br />
<br />
=== Install ===<br />
* verify you are now operating from the ext2 filesystem where you copied the rootfs.<br />
* install openssh, openssh-server, openssh-client, openssh-server-common,<br />
* install dnsmasq, ethtool, hostapd*, busybox extras, iptables*, iw,net-tools, tree, wireless-tools.<br />
* edit all the configurations supplied here.<br />
<br />
===== ssh config =====<br />
The allowed users are not normal names since I want the names to be a little obfuscated. Not that it really matters, since this is a key driven setup<br><br />
AddressFamily inet<br><br />
ListenAddress 0.0.0.0<br><br />
HostKey /etc/ssh/ssh_host_rsa_key<br><br />
LogLevel INFO<br><br />
LoginGraceTime 30<br><br />
PermitRootLogin no<br><br />
StrictModes yes<br><br />
AllowUsers Som123X Extern4524User<br><br />
PubkeyAuthentication yes<br><br />
AuthorizedKeysFile /etc/ssh/authorized_keys<br><br />
HostbasedAuthentication yes<br><br />
IgnoreUserKnownHosts yes<br><br />
IgnoreRhosts yes<br><br />
PasswordAuthentication no<br><br />
ChallengeResponseAuthentication no<br><br />
AllowTcpForwarding yes<br><br />
GatewayPorts yes<br><br />
X11Forwarding no<br><br />
<br />
<br />
===== dnsmasq.conf =====<br />
/etc/dnsmasq.conf<br><br />
This has two subnets. One for normal dhcp, the other for pseudo static - dhcp provided by MAC. One example here.<br><br />
<pre><br />
interface=br0<br />
except-interface=eth0<br />
dhcp-range=subnet0,192.168.0.10,192.168.0.100,255.255.255.0,24h<br />
dhcp-range=subnet1,192.168.0.4,192.168.0.6,255.255.255.0,24h<br />
bind-interfaces<br />
#log-queries<br />
#log-dhcp<br />
dhcp-host=70:85:66:c4:48:55,192.168.0.4,nas<br />
</pre><br />
<br />
===== /etc/hosts =====<br />
dnsmasq provides DNS answers from the hosts file. Nice. <br><br />
<pre><br />
127.0.0.1 localhost localhost.localdomain<br />
::1 localhost localhost.localdomain<br />
192.168.0.3 wireless<br />
192.168.0.4 nas<br />
192.168.0.5 mpd<br />
</pre><br />
<br />
===== hostapd.conf =====<br />
/etc/hostapd/hostapd.conf<br><br />
<pre><br />
interface=wlan0<br />
bridge=br0<br />
hw_mode=g<br />
channel=7<br />
wmm_enabled=0<br />
macaddr_acl=0<br />
auth_algs=1<br />
ignore_broadcast_ssid=0<br />
wpa=2<br />
wpa_key_mgmt=WPA-PSK<br />
wpa_pairwise=TKIP<br />
rsn_pairwise=CCMP<br />
ssid=Whatever<br />
wpa_passphrase=YouMakeItUp<br />
</pre><br />
<br />
===== interfaces =====<br />
/etc/network/interfaces<br><br />
<pre><br />
auto lo<br />
iface lo inet loopback<br />
<br />
auto eth0<br />
iface eth0 inet dhcp<br />
hostname ANYNAME<br />
hwaddress ether FE:ED:BE:EF:33:DD<br />
<br />
iface eth1 inet manual<br />
iface wlan0 inet manual<br />
<br />
auto br0<br />
iface br0 inet static<br />
pre-up ifconfig eth1 up<br />
bridge-ports eth1 wlan0<br />
bridge-stp off<br />
address 192.168.0.3<br />
broadcaset 192.168.1.255<br />
netmask 255.255.255.0<br />
</pre><br />
<br />
===== Permissive iptables =====<br />
Do NOT use this connected to the internet! There is NO protection.<br><br />
This is my stopopen in my replacement iptables<br><br />
iptables -P INPUT ACCEPT<br><<br />
iptables -F INPUT<br><br />
iptables -P OUTPUT ACCEPT<br><br />
iptables -F OUTPUT<br><br />
iptables -P FORWARD ACCEPT<br><br />
iptables -F FORWARD<br><br />
iptables -F -t nat<br><br />
iptables -F<br><br />
<br />
=== References ===<br />
apk notes:<br />
<br />
* Create, index and check dependencies on a list of apk files: apk index -o APKINDEX.unsigned.tar.gz *.apk<br />
* Install a package: apk add iw OR apk add /path/to/iw-5.4-r0.apk<br />
* remove a package: apk del iw<br />
* repository lists are in: /etc/apk/repositories<br />
* Local URL: /media/mmcblk0p1/apks<br />
* Remote URL: http://dl-cdn.alpinelinux.org/alpine/v3.12/main<br />
<br />
[https://en.wikipedia.org/wiki/File_Allocation_Table FAT16/32 limits]<br><br />
[https://udhcp.busybox.net/README.udhcpc udhcpc]<br><br />
[https://linux.die.net/man/8/ez-ipupdate ez-ipupdate]<br><br />
[[Alpine_Linux:FAQ#Dynamic_DNS|Dynamic_DNS]]<br><br />
[[Bridge|Alpine Linux Bridge]]<br><br />
[[Connecting_to_a_wireless_access_point|Connect to wireless AP]]<br><br />
[https://unix.stackexchange.com/questions/222264/how-do-i-limit-dnsmasq-listening-to-only-one-interface dnsmasq listen restrictions]<br><br />
[https://wiki.archlinux.org/index.php/IPv6#Disable_IPv6 Disable IPV6]<br><br />
[https://github.com/imp/dnsmasq/blob/master/dnsmasq.conf.example dnsmasq Docs]<br><br />
[https://man.openbsd.org/hostapd.conf.5 HostApd Docs]<br><br />
[rsync://rsync.alpinelinux.org/alpine Alpine Repos]<br><br />
[https://stevessmarthomeguide.com/home-network-dns-dnsmasq Set Static DNS names]<br><br />
[https://unix.stackexchange.com/questions/504100/how-to-create-ssh-reverse-tunnel-with-iptables-forwarding Reverse SSH tunnel]<br><br />
===== Pi Related =====<br />
[https://github.com/rickyrockrat/nanopi-alpine NanoPi NEO build script]<br><br />
===== Pi Specific =====<br />
[https://raspberrypi.stackexchange.com/questions/89803/access-point-as-wifi-router-repeater-optional-with-bridge/89804 Pi Wifi Repeater]<br><br />
[https://raspberrypi.stackexchange.com/questions/81486/raspberry-pi-wifi-to-ethernet-bridge-for-a-server/81518 WiFi Bridge]<br><br />
[[Raspberry_Pi|Alpine Install]]<br><br />
[[Classic_install_or_sys_mode_on_Raspberry_Pi|Classic Sys Install on Pi]]<br><br />
<br />
==== Not Related, but Interesting ====<br />
[https://blog.thewalr.us/2017/09/26/raspberry-pi-zero-w-simultaneous-ap-and-managed-mode-wifi AP and Managed Mode]<br><br />
[https://www.instructables.com/Using-a-Raspberry-PI-Zero-W-As-an-Access-Point-and AP and MQTT]<br><br />
<br />
==== Package List ====<br />
Put these in the apks/armhf directory on the 256M Fat partition:<br><br />
<br />
iptables-1.8.4-r2.apk openssh-8.3_p1-r1.apk<br />
iptables-openrc-1.8.4-r2.apk openssh-client-8.3_p1-r1.apk<br />
abuild-3.6.0-r1.apk iw-5.4-r0.apk openssh-keygen-8.3_p1-r1.apk<br />
alpine-base-3.12.3-r0.apk kbd-bkeymaps-2.2.0-r2.apk openssh-server-8.3_p1-r1.apk<br />
alpine-baselayout-3.2.0-r7.apk libacl-2.2.53-r0.apk openssh-server-common-8.3_p1-r1.apk<br />
alpine-conf-3.9.0-r1.apk libattr-2.4.48-r0.apk openssh-sftp-server-8.3_p1-r1.apk<br />
alpine-keys-2.2-r0.apk libblkid-2.35.2-r0.apk openssl-1.1.1i-r0.apk<br />
alpine-mirrors-3.5.10-r0.apk libc-utils-0.7.2-r3.apk patch-2.7.6-r6.apk<br />
apk-tools-2.10.5-r1.apk libcap-2.27-r0.apk pcsc-lite-libs-1.8.26-r0.apk<br />
attr-2.4.48-r0.apk libcom_err-1.45.6-r0.apk pkgconf-1.7.2-r0.apk<br />
bash-5.0.17-r0.apk libcrypto1.1-1.1.1i-r0.apk ppp-atm-2.4.8-r2.apk<br />
bash-completion-2.10-r0.apk libcurl-7.69.1-r3.apk ppp-chat-2.4.8-r2.apk<br />
bonding-2.6-r4.apk libedit-20191231.3.1-r0.apk ppp-daemon-2.4.8-r2.apk<br />
bridge-1.5-r4.apk libev-4.33-r0.apk ppp-l2tp-2.4.8-r2.apk<br />
bridge-utils-1.6-r0.apk libgcc-9.3.0-r2.apk ppp-minconn-2.4.8-r2.apk<br />
busybox-1.31.1-r19.apk libmnl-1.0.4-r0.apk ppp-passprompt-2.4.8-r2.apk<br />
busybox-extras-1.31.1-r19.apk libnftnl-1.1.6-r0.apk ppp-passwordfd-2.4.8-r2.apk<br />
busybox-initscripts-3.2-r2.apk libnftnl-libs-1.1.6-r0.apk ppp-pppoe-2.4.8-r2.apk<br />
busybox-suid-1.31.1-r19.apk libnl3-3.5.0-r0.apk ppp-radius-2.4.8-r2.apk<br />
c-ares-1.16.1-r0.apk libpcap-1.9.1-r2.apk ppp-winbind-2.4.8-r2.apk<br />
ca-certificates-20191127-r4.apk libssl1.1-1.1.1i-r0.apk readline-8.0.4-r0.apk<br />
ca-certificates-bundle-20191127-r4.apk libstdc++-9.3.0-r2.apk scanelf-1.2.6-r0.apk<br />
chrony-3.5.1-r0.apk libtls-standalone-2.9.1-r1.apk signature.tar.gz<br />
chrony-openrc-3.5.1-r0.apk libusb-1.0.23-r0.apk ssl_client-1.31.1-r19.apk<br />
curl-7.69.1-r3.apk libuuid-2.35.2-r0.apk tar-1.32-r1.apk<br />
dbus-libs-1.12.18-r0.apk lzip-1.21-r0.apk tcpdump-4.9.3-r2.apk<br />
dnsmasq-2.81-r0.apk mii-tool-1.60_git20140218-r2.apk tree-1.8.0-r0.apk<br />
e2fsprogs-1.45.6-r0.apk musl-1.1.24-r10.apk tzdata-2020c-r1.apk<br />
e2fsprogs-libs-1.45.6-r0.apk musl-utils-1.1.24-r10.apk usb-modeswitch-2.6.0-r1.apk<br />
ethtool-5.6-r0.apk ncurses-libs-6.2_p20200523-r0.apk vlan-2.2-r0.apk<br />
ez-ipupdate-3.0.10-r9.apk ncurses-terminfo-base-6.2_p20200523-r0.apk wireless-tools-30_pre9-r1.apk<br />
fakeroot-1.24-r0.apk net-tools-1.60_git20140218-r2.apk wpa_supplicant-2.9-r5.apk<br />
haveged-1.9.8-r1.apk network-extras-1.2-r0.apk wpa_supplicant-openrc-2.9-r5.apk<br />
haveged-openrc-1.9.8-r1.apk nghttp2-1.41.0-r0.apk zlib-1.2.11-r3.apk<br />
hostapd-2.9-r2.apk nghttp2-libs-1.41.0-r0.apk<br />
hostapd-openrc-2.9-r2.apk openrc-0.42.1-r11.apk</div>Rickyrockrathttps://wiki.alpinelinux.org/w/index.php?title=Alpine_on_ARM&diff=22914Alpine on ARM2023-01-17T02:48:29Z<p>Rickyrockrat: /* Specific guides */</p>
<hr />
<div>{{TOC right}}<br />
{{Style}}<br />
{{Move|ARM SOCs}}<br />
<br />
(Parts of this page are WIP, still incomplete and some might be incorrect.)<br />
<br />
<br />
==Supported SoCs==<br />
<br />
Currently Alpine supports armv6/armhf arch on the following SoCs<br />
<br />
(This is taken from the DTBs which Alpine includes)<br />
<br />
{| class="wikitable collapsible"<br />
| am335x-base0033<br />
| am335x-bone<br />
| am335x-boneblack<br />
| am335x-evm<br />
| am335x-evmsk<br />
| am335x-nano<br />
| am335x-pepper<br />
| am3517-craneboard<br />
| am3517-evm<br />
| am3517_mt_ventoux<br />
| am437x-gp-evm<br />
|-<br />
| am437x-sk-evm<br />
| am43x-epos-evm<br />
| exynos4210-origen<br />
| exynos4210-smdkv310<br />
| exynos4210-trats<br />
| exynos4210-universal_c210<br />
| exynos4412-odroidu3<br />
| exynos4412-odroidx<br />
| exynos4412-odroidx2<br />
| exynos4412-origen<br />
| exynos4412-smdk4412<br />
| exynos4412-tiny4412<br />
|-<br />
| exynos4412-trats2<br />
| exynos5250-arndale<br />
| exynos5250-smdk5250<br />
| exynos5250-snow<br />
| exynos5260-xyref5260<br />
| exynos5410-smdk5410<br />
| exynos5420-arndale-octa<br />
| exynos5420-peach-pit<br />
| exynos5420-smdk5420<br />
| exynos5440-sd5v1<br />
| exynos5440-ssdk5440<br />
| exynos5800-peach-pi<br />
|-<br />
| imx1-ads<br />
| imx1-apf9328<br />
| imx25-eukrea-mbimxsd25-baseboard-cmo-qvga<br />
| imx25-eukrea-mbimxsd25-baseboard-dvi-svga<br />
| imx25-eukrea-mbimxsd25-baseboard-dvi-vga<br />
| imx25-eukrea-mbimxsd25-baseboard<br />
| imx25-karo-tx25<br />
| imx25-pdk<br />
| imx27-apf27<br />
| imx27-apf27dev<br />
| imx27-eukrea-mbimxsd27-baseboard<br />
| imx27-pdk<br />
|-<br />
| imx27-phytec-phycard-s-rdk<br />
| imx27-phytec-phycore-rdk<br />
| imx31-bug<br />
| imx35-eukrea-mbimxsd35-baseboard<br />
| imx35-pdk<br />
| imx50-evk<br />
| imx51-apf51<br />
| imx51-apf51dev<br />
| imx51-babbage<br />
| imx51-digi-connectcore-jsk<br />
| imx51-eukrea-mbimxsd51-baseboard<br />
| imx53-ard<br />
|-<br />
| imx53-m53evk<br />
| imx53-mba53<br />
| imx53-qsb<br />
| imx53-qsrb<br />
| imx53-smd<br />
| imx53-tx53-x03x<br />
| imx53-tx53-x13x<br />
| imx53-voipac-bsb<br />
| imx6dl-aristainetos_4<br />
| imx6dl-aristainetos_7<br />
| imx6dl-cubox-i<br />
| imx6dl-dfi-fs700-m60<br />
|-<br />
| imx6dl-gw51xx<br />
| imx6dl-gw52xx<br />
| imx6dl-gw53xx<br />
| imx6dl-gw54xx<br />
| imx6dl-gw552x<br />
| imx6dl-hummingboard<br />
| imx6dl-nitrogen6x<br />
| imx6dl-phytec-pbab01<br />
| imx6dl-rex-basic<br />
| imx6dl-riotboard<br />
| imx6dl-sabreauto<br />
| imx6dl-sabrelite<br />
|-<br />
| imx6dl-sabresd<br />
| imx6dl-tx6dl-comtft<br />
| imx6dl-tx6u-801x<br />
| imx6dl-tx6u-811x<br />
| imx6dl-wandboard-revb1<br />
| imx6dl-wandboard<br />
| imx6q-arm2<br />
| imx6q-cm-fx6<br />
| imx6q-cubox-i<br />
| imx6q-dfi-fs700-m60<br />
| imx6q-dmo-edmqmx6<br />
| imx6q-gk802<br />
|-<br />
| imx6q-gw51xx<br />
| imx6q-gw52xx<br />
| imx6q-gw53xx<br />
| imx6q-gw5400-a<br />
| imx6q-gw54xx<br />
| imx6q-gw552x<br />
| imx6q-hummingboard<br />
| imx6q-nitrogen6x<br />
| imx6q-phytec-pbab01<br />
| imx6q-rex-pro<br />
| imx6q-sabreauto<br />
| imx6q-sabrelite<br />
|-<br />
| imx6q-sabresd<br />
| imx6q-sbc6x<br />
| imx6q-tx6q-1010-comtft<br />
| imx6q-tx6q-1010<br />
| imx6q-tx6q-1020-comtft<br />
| imx6q-tx6q-1020<br />
| imx6q-tx6q-1110<br />
| imx6q-udoo<br />
| imx6q-wandboard-revb1<br />
| imx6q-wandboard<br />
| imx6sl-evk<br />
| imx6sx-sdb<br />
|-<br />
| armada-3720-espressobin-v7-emmc<br />
|-<br />
| omap3-beagle-xm-ab<br />
| omap3-beagle-xm<br />
| omap3-beagle<br />
| omap3-cm-t3517<br />
| omap3-cm-t3530<br />
| omap3-cm-t3730<br />
| omap3-devkit8000<br />
| omap3-evm-37xx<br />
| omap3-evm<br />
| omap3-gta04a3<br />
| omap3-gta04a4<br />
| omap3-gta04a5<br />
|-<br />
| omap3-ha-lcd<br />
| omap3-ha<br />
| omap3-igep0020<br />
| omap3-igep0030<br />
| omap3-ldp<br />
| omap3-lilly-dbb056<br />
| omap3-n9<br />
| omap3-n900<br />
| omap3-n950<br />
| omap3-overo-alto35<br />
| omap3-overo-chestnut43<br />
| omap3-overo-gallop43<br />
|-<br />
| omap3-overo-palo43<br />
| omap3-overo-storm-alto35<br />
| omap3-overo-storm-chestnut43<br />
| omap3-overo-storm-gallop43<br />
| omap3-overo-storm-palo43<br />
| omap3-overo-storm-summit<br />
| omap3-overo-storm-tobi<br />
| omap3-overo-summit<br />
| omap3-overo-tobi<br />
| omap3-sbc-t3517<br />
| omap3-sbc-t3530<br />
| omap3-sbc-t3730<br />
|-<br />
| omap3-thunder<br />
| omap3-zoom3<br />
| omap3430-sdp<br />
| omap4-duovero-parlor<br />
| omap4-panda-a4<br />
| omap4-panda-es<br />
| omap4-panda<br />
| omap4-sdp-es23plus<br />
| omap4-sdp<br />
| omap4-var-dvk-om44<br />
| omap4-var-stk-om44<br />
| omap5-cm-t54<br />
|-<br />
| omap5-sbc-t54<br />
| omap5-uevm<br />
| qcom-apq8064-cm-qs600<br />
| qcom-apq8064-ifc6410<br />
| qcom-apq8074-dragonboard<br />
| qcom-apq8084-ifc6540<br />
| qcom-apq8084-mtp<br />
| qcom-ipq8064-ap148<br />
| qcom-msm8660-surf<br />
| qcom-msm8960-cdp<br />
| qcom-msm8974-sony-xperia-honami<br />
| sun4i-a10-a1000<br />
|-<br />
| sun4i-a10-ba10-tvbox<br />
| sun4i-a10-cubieboard<br />
| sun4i-a10-hackberry<br />
| sun4i-a10-inet97fv2<br />
| sun4i-a10-mini-xplus<br />
| sun4i-a10-olinuxino-lime<br />
| sun4i-a10-pcduino<br />
| sun5i-a10s-olinuxino-micro<br />
| sun5i-a10s-r7-tv-dongle<br />
| sun5i-a13-hsg-h702<br />
| sun5i-a13-olinuxino-micro<br />
| sun5i-a13-olinuxino<br />
|-<br />
| sun6i-a31-app4-evb1<br />
| sun6i-a31-colombus<br />
| sun6i-a31-hummingbird<br />
| sun6i-a31-m9<br />
| sun7i-a20-cubieboard2<br />
| sun7i-a20-cubietruck<br />
| sun7i-a20-hummingbird<br />
| sun7i-a20-i12-tvbox<br />
| sun7i-a20-olinuxino-lime<br />
| sun7i-a20-olinuxino-micro<br />
| sun7i-a20-pcduino3<br />
| sun8i-a23-ippo-q8h-v5<br />
|-<br />
| vexpress-v2p-ca15-tc1<br />
| vexpress-v2p-ca15_a7<br />
| vexpress-v2p-ca5s<br />
| vexpress-v2p-ca9<br />
| vf610-colibri-eval-v3<br />
| vf610-cosmic<br />
| vf610-twr<br />
|}<br />
<br />
==Install Alpine on supported SoCs==<br />
<br />
=== Generic information ===<br />
<br />
(If anyone has one of the above devices and has successfully installed Alpine on it, please consider adding the missing info here.)<br />
<br />
==== Example with Wandboard ====<br />
<br />
===== Get latest Alpine image =====<br />
Download the last Generic ARM image on https://alpinelinux.org/downloads/<br />
Extract the archive somewhere.<br />
<br />
===== Prepare SD Card =====<br />
First install SPL and u-boot.img (this could change for other board):<br />
in root, write the SPL from Alpine extracted files :<br />
dd if=u-boot/wandboard/SPL of=/dev/sdX seek=1 bs=1k<br />
and the u-boot.img :<br />
dd if=u-boot/wandboard/u-boot.img of=/dev/sdX seek=69 bs=1k<br />
<br />
After create the partition on the sd-card with fdisk, then copy folders apks/ boot/ efi/ extlinux/ u-boot/ to the sd-card partition. (I'm not sure all folder as useful).<br />
<br />
After you can put the sd-card in the Wandboard and boot it with serial console connected.<br><br />
The board should boot on the sd-card. When the prompt ask a login, enter 'root'.<br />
Then launch 'setup-alpine' to configure the system.<br />
<br />
=== Specific guides ===<br />
<br />
* [[DIY Fully working Alpine Linux for Allwinner and Other ARM SOCs]]<br />
* [[Raspberry_Pi]]<br />
* [[Raspberry_Pi_4_-_Persistent_system_acting_as_a_NAS_and_Time_Machine]]<br />
* [[Odroid-C2]]<br />
* [https://github.com/rickyrockrat/nanopi-alpine NanoPi Neo build script]<br />
<br />
==Unupported SoCs==<br />
<br />
If you have an armv6/armv7 SoC which is not listed above but is supported by mainline uboot/kernel then it's still possible to install Alpine<br />
<br />
<br />
===Requirements===<br />
<br />
* Alpine's forked uboot to support tarballs (fabled?)<br />
* serial console<br />
* crosscompiler/toolchain if you can not compile natively<br />
<br />
<br />
===The embedded world===<br />
<br />
A lot of the SoCs have their own way of doing things, although they use uboot and Linux kernel but often they are heavily modified to suit easy flashing of "ROMs" or other unknown reasons, e.g. Rockchip's notion "partition" are neither DOS nor GPT partitions.<br />
We will discuss to install Alpine in a more standard way like x86 with either DOS or GPT partitions. You will most likely have to install/flash the mainline uboot, which can be non-destructive if you use external storage.<br />
<br />
<br />
====Storage====<br />
<br />
One can load uboot from the following block devices if it's supported.<br />
* NAND<br />
* eMMC<br />
* SD card<br />
* USB<br />
<br />
<br />
====Power on====<br />
<br />
Some SoCs need both SPL and uboot, you need to check uboot for your board. Most (if not all) boards boots from the internal storage first (either NAND or eMMC) you will have to check documentation of your board if you wish to boot the SPL/uboot from SD/USB.<br />
<br />
One can view SPL+uboot as BIOS and boot-loader on PC. Think that you could put the BIOS on an external storage :D<br />
<br />
Once you have loaded the "standard" uboot, things are more or less like on x86.<br />
<br />
<br />
====Partitioning====<br />
<br />
Either DOS or GPT patitions should work. Start of the first partition should be on block 2048 so there is space for SPL/uboot and marked bootable (with<br />
the MBR bootable flag, or GPT legacy_bios_bootable attribute).<br />
* SPL starts at block 64 (please consult the docs for your board)<br />
* uboot starts at block 256 (please consult the docs for your board)<br />
Just dd SPL and boot with the correct offset to the media you wish to boot<br />
<br />
====Booting Linux kernel====<br />
<br />
* uboot uses extlinux.conf file to locate the kernel/initramfs/... just like syslinx, you need to put that file on the partitions which is marked bootable in the /boot directory<br />
* there should be an extra line "FDTDIR" which points to the DTBs<br />
e.g.<br />
<pre><br />
label Fedora (3.17.0-0.rc4.git2.1.fc22.armv7hl) 22 (Rawhide)<br />
kernel /boot/vmlinuz-3.17.0-0.rc4.git2.1.fc22.armv7hl<br />
append ro root=UUID=8eac677f-8ea8-4270-8479-d5ddbb797450 console=ttyS0,115200n8 LANG=en_US.UTF-8 drm.debug=0xf<br />
fdtdir /boot/dtb-3.17.0-0.rc4.git2.1.fc22.armv7hl<br />
initrd /boot/initramfs-3.17.0-0.rc4.git2.1.fc22.armv7hl.img<br />
</pre><br />
<br />
==Using QEMU==<br />
<br />
<pre><br />
qemu-system-arm -M vexpress-a9 -kernel zImage -initrd initramfs-grsec -dtb vexpress-v2p-ca9.dtb -hda hda.img -serial stdio<br />
</pre><br />
<br />
<br />
<br />
== References ==<br />
<br />
* [http://www.armadeus.org/wiki/index.php?title=Kernel-with-device-tree dtb (Device Tree Binary)]<br />
* [https://forum.odroid.com/viewtopic.php?t=30459 Odroid-C2] 2018 ''([https://archlinuxarm.org/platforms/armv8/amlogic/odroid-c2 ARMv8, AArch64]; [https://forum.odroid.com/viewtopic.php?f=138&t=32608 Alpine Linux custom build])''<br />
* [https://cusdeb.com/ CusDeb.com] - bootstrap SD-card images for single-board computers online; ''([https://github.com/tolstoyevsky/pieman Pieman])''<br />
* [https://kernelci.org/soc/ <s>Available</s> SoCs]<br />
<br />
[[Category:Hardware]]<br />
[[category:ARM]]</div>Rickyrockrathttps://wiki.alpinelinux.org/w/index.php?title=How_to_set_up_Alpine_as_a_wireless_router&diff=22750How to set up Alpine as a wireless router2022-12-08T05:26:55Z<p>Rickyrockrat: /* hostapd.conf */</p>
<hr />
<div>=== Pi Zero W Wireless Router ===<br />
<br />
This page describes building a Wireless Access Point with two wired ethernet ports for building a home router that connects to the internet with one wired port, and an internal LAN with the second wired port and the on-board WiFi.<br><br />
<br />
The intent is to provide this:<br><br />
<pre><br />
|<-->eth1 <-->| <br />
Internet <--> eth0 <-->FireWall<-->br0 Internal<--> ssh,bind,dhcp, with ssh reverse ssh connections.<br />
|<-->wlan0<-->|<br />
</pre><br />
<br />
=== Overview ===<br />
I generally run Debian and when forced by Red Hot Irons, Red Hat. This is my first foray into Alpine. So far I am very impressed. I mirrored the 3.12 armhf repos so I had things local when I needed them. Word to the wise, it comprises 13 GB of apk files.<br><br />
One *really* nice feature of Alpine is apk, the yum/apt replacement:<br><br />
* It is simple and to the point.<br />
* The same tool provides *repo* level dependency reporting!<br />
* Install of single packages without repo signing (I never did get the signing correct, but I can install).<br />
<br />
=== Prepare ===<br />
* Obtain a microSD card (or HDD) you can wipe the data from. We will assume it is /dev/sdc.<br />
* Make a 256M FAT16 partition (sudo mkfs.vfat -n ALPBOOT /dev/sdc1)<br />
* The rest of the device can be ext2 (ext3/4 on HDD) (sudo mke2fs -m1 -L alext3 /dev/sdc2).<br />
* Untar the alpine-rpi-3.12.3-armhf.tar.gz and copy all of the files to the fat16 partition which can be as large as 2G. <br />
* Make sure you have all the packages from the package list below installed on the SD card. This will save you lots of time.<br />
* Add this to usercfg.txt at the root of the FAT16 partition:<br />
enable_uart=1<br />
gpu_mem=16<br />
dtparam=audio=off<br />
* This is the contents of cmdline.txt:<br />
modules=loop,squashfs,sd-mod,usb-storage console=tty1 console=ttyAMA0,115200<br />
<br />
=== First Boot ===<br />
* Put the SD into the pi zero<br />
* Connect the serial port<br />
* Run minicom with the parameters set to 115200,n,8,1, no flow control.<br />
* Power up the Pi.<br />
<br />
=== Copy Root ===<br />
* mkdir /stage<br />
* mount /dev/sda2 /stage<br />
* for d in $(ls -1 /|grep -v 'media\|stage\|dev\|proc\|sys'); do cp -a /$d /stage; done<br />
* modules are loop mounted to /.modloop, and lib/modules is symlinked to that, so<br />
* rm /stage/lib/modules<br />
* cp -a /.modloop /stage/lib/modules<br />
* Fix cmdline.txt<br />
mount -o remount,rw /media/mmcblk0p1<br />
echo 'root=/dev/mmcblk0p2' >> /media/mmcblk0p1/cmdline.txt<br />
* reboot<br />
<br />
=== Install ===<br />
* verify you are now operating from the ext2 filesystem where you copied the rootfs.<br />
* install openssh, openssh-server, openssh-client, openssh-server-common,<br />
* install dnsmasq, ethtool, hostapd*, busybox extras, iptables*, iw,net-tools, tree, wireless-tools.<br />
* edit all the configurations supplied here.<br />
<br />
===== ssh config =====<br />
The allowed users are not normal names since I want the names to be a little obfuscated. Not that it really matters, since this is a key driven setup<br><br />
AddressFamily inet<br><br />
ListenAddress 0.0.0.0<br><br />
HostKey /etc/ssh/ssh_host_rsa_key<br><br />
LogLevel INFO<br><br />
LoginGraceTime 30<br><br />
PermitRootLogin no<br><br />
StrictModes yes<br><br />
AllowUsers Som123X Extern4524User<br><br />
PubkeyAuthentication yes<br><br />
AuthorizedKeysFile /etc/ssh/authorized_keys<br><br />
HostbasedAuthentication yes<br><br />
IgnoreUserKnownHosts yes<br><br />
IgnoreRhosts yes<br><br />
PasswordAuthentication no<br><br />
ChallengeResponseAuthentication no<br><br />
AllowTcpForwarding yes<br><br />
GatewayPorts yes<br><br />
X11Forwarding no<br><br />
<br />
<br />
===== dnsmasq.conf =====<br />
/etc/dnsmasq.conf<br><br />
This has two subnets. One for normal dhcp, the other for pseudo static - dhcp provided by MAC. One example here.<br><br />
<pre><br />
interface=br0<br />
except-interface=eth0<br />
dhcp-range=subnet0,192.168.0.10,192.168.0.100,255.255.255.0,24h<br />
dhcp-range=subnet1,192.168.0.4,192.168.0.6,255.255.255.0,24h<br />
bind-interfaces<br />
#log-queries<br />
#log-dhcp<br />
dhcp-host=70:85:66:c4:48:55,192.168.0.4,nas<br />
</pre><br />
<br />
===== /etc/hosts =====<br />
dnsmasq provides DNS answers from the hosts file. Nice. <br><br />
<pre><br />
127.0.0.1 localhost localhost.localdomain<br />
::1 localhost localhost.localdomain<br />
192.168.0.3 wireless<br />
192.168.0.4 nas<br />
192.168.0.5 mpd<br />
</pre><br />
<br />
===== hostapd.conf =====<br />
/etc/hostapd/hostapd.conf<br><br />
<pre><br />
interface=wlan0<br />
bridge=br0<br />
hw_mode=g<br />
channel=7<br />
wmm_enabled=0<br />
macaddr_acl=0<br />
auth_algs=1<br />
ignore_broadcast_ssid=0<br />
wpa=2<br />
wpa_key_mgmt=WPA-PSK<br />
wpa_pairwise=TKIP<br />
rsn_pairwise=CCMP<br />
ssid=Whatever<br />
wpa_passphrase=YouMakeItUp<br />
</pre><br />
<br />
===== interfaces =====<br />
/etc/network/interfaces<br><br />
<pre><br />
auto lo<br />
iface lo inet loopback<br />
<br />
auto eth0<br />
iface eth0 inet dhcp<br />
hostname ANYNAME<br />
hwaddress ether FE:ED:BE:EF:33:DD<br />
<br />
iface eth1 inet manual<br />
iface wlan0 inet manual<br />
<br />
auto br0<br />
iface br0 inet static<br />
pre-up ifconfig eth1 up<br />
bridge-ports eth1 wlan0<br />
bridge-stp off<br />
address 192.168.0.3<br />
broadcaset 192.168.1.255<br />
netmask 255.255.255.0<br />
</pre><br />
<br />
===== Permissive iptables =====<br />
Do NOT use this connected to the internet! There is NO protection.<br><br />
This is my stopopen in my replacement iptables<br><br />
iptables -P INPUT ACCEPT<br><<br />
iptables -F INPUT<br><br />
iptables -P OUTPUT ACCEPT<br><br />
iptables -F OUTPUT<br><br />
iptables -P FORWARD ACCEPT<br><br />
iptables -F FORWARD<br><br />
iptables -F -t nat<br><br />
iptables -F<br><br />
<br />
=== References ===<br />
apk notes:<br />
<br />
* Create, index and check dependencies on a list of apk files: apk index -o APKINDEX.unsigned.tar.gz *.apk<br />
* Install a package: apk add iw OR apk add /path/to/iw-5.4-r0.apk<br />
* remove a package: apk del iw<br />
* repository lists are in: /etc/apk/repositories<br />
* Local URL: /media/mmcblk0p1/apks<br />
* Remote URL: http://dl-cdn.alpinelinux.org/alpine/v3.12/main<br />
<br />
[https://en.wikipedia.org/wiki/File_Allocation_Table FAT16/32 limits]<br><br />
[https://udhcp.busybox.net/README.udhcpc udhcpc]<br><br />
[https://linux.die.net/man/8/ez-ipupdate ez-ipupdate]<br><br />
[[Alpine_Linux:FAQ#Dynamic_DNS|Dynamic_DNS]]<br><br />
[[Bridge|Alpine Linux Bridge]]<br><br />
[[Connecting_to_a_wireless_access_point|Connect to wireless AP]]<br><br />
[https://unix.stackexchange.com/questions/222264/how-do-i-limit-dnsmasq-listening-to-only-one-interface dnsmasq listen restrictions]<br><br />
[https://wiki.archlinux.org/index.php/IPv6#Disable_IPv6 Disable IPV6]<br><br />
[https://github.com/imp/dnsmasq/blob/master/dnsmasq.conf.example dnsmasq Docs]<br><br />
[https://man.openbsd.org/hostapd.conf.5 HostApd Docs]<br><br />
[rsync://rsync.alpinelinux.org/alpine Alpine Repos]<br><br />
[https://stevessmarthomeguide.com/home-network-dns-dnsmasq Set Static DNS names]<br><br />
[https://unix.stackexchange.com/questions/504100/how-to-create-ssh-reverse-tunnel-with-iptables-forwarding Reverse SSH tunnel]<br><br />
===== Pi Specific =====<br />
[https://raspberrypi.stackexchange.com/questions/89803/access-point-as-wifi-router-repeater-optional-with-bridge/89804 Pi Wifi Repeater]<br><br />
[https://raspberrypi.stackexchange.com/questions/81486/raspberry-pi-wifi-to-ethernet-bridge-for-a-server/81518 WiFi Bridge]<br><br />
[[Raspberry_Pi|Alpine Install]]<br><br />
[[Classic_install_or_sys_mode_on_Raspberry_Pi|Classic Sys Install on Pi]]<br><br />
<br />
==== Not Related, but Interesting ====<br />
[https://blog.thewalr.us/2017/09/26/raspberry-pi-zero-w-simultaneous-ap-and-managed-mode-wifi AP and Managed Mode]<br><br />
[https://www.instructables.com/Using-a-Raspberry-PI-Zero-W-As-an-Access-Point-and AP and MQTT]<br><br />
<br />
==== Package List ====<br />
Put these in the apks/armhf directory on the 256M Fat partition:<br><br />
<br />
iptables-1.8.4-r2.apk openssh-8.3_p1-r1.apk<br />
iptables-openrc-1.8.4-r2.apk openssh-client-8.3_p1-r1.apk<br />
abuild-3.6.0-r1.apk iw-5.4-r0.apk openssh-keygen-8.3_p1-r1.apk<br />
alpine-base-3.12.3-r0.apk kbd-bkeymaps-2.2.0-r2.apk openssh-server-8.3_p1-r1.apk<br />
alpine-baselayout-3.2.0-r7.apk libacl-2.2.53-r0.apk openssh-server-common-8.3_p1-r1.apk<br />
alpine-conf-3.9.0-r1.apk libattr-2.4.48-r0.apk openssh-sftp-server-8.3_p1-r1.apk<br />
alpine-keys-2.2-r0.apk libblkid-2.35.2-r0.apk openssl-1.1.1i-r0.apk<br />
alpine-mirrors-3.5.10-r0.apk libc-utils-0.7.2-r3.apk patch-2.7.6-r6.apk<br />
apk-tools-2.10.5-r1.apk libcap-2.27-r0.apk pcsc-lite-libs-1.8.26-r0.apk<br />
attr-2.4.48-r0.apk libcom_err-1.45.6-r0.apk pkgconf-1.7.2-r0.apk<br />
bash-5.0.17-r0.apk libcrypto1.1-1.1.1i-r0.apk ppp-atm-2.4.8-r2.apk<br />
bash-completion-2.10-r0.apk libcurl-7.69.1-r3.apk ppp-chat-2.4.8-r2.apk<br />
bonding-2.6-r4.apk libedit-20191231.3.1-r0.apk ppp-daemon-2.4.8-r2.apk<br />
bridge-1.5-r4.apk libev-4.33-r0.apk ppp-l2tp-2.4.8-r2.apk<br />
bridge-utils-1.6-r0.apk libgcc-9.3.0-r2.apk ppp-minconn-2.4.8-r2.apk<br />
busybox-1.31.1-r19.apk libmnl-1.0.4-r0.apk ppp-passprompt-2.4.8-r2.apk<br />
busybox-extras-1.31.1-r19.apk libnftnl-1.1.6-r0.apk ppp-passwordfd-2.4.8-r2.apk<br />
busybox-initscripts-3.2-r2.apk libnftnl-libs-1.1.6-r0.apk ppp-pppoe-2.4.8-r2.apk<br />
busybox-suid-1.31.1-r19.apk libnl3-3.5.0-r0.apk ppp-radius-2.4.8-r2.apk<br />
c-ares-1.16.1-r0.apk libpcap-1.9.1-r2.apk ppp-winbind-2.4.8-r2.apk<br />
ca-certificates-20191127-r4.apk libssl1.1-1.1.1i-r0.apk readline-8.0.4-r0.apk<br />
ca-certificates-bundle-20191127-r4.apk libstdc++-9.3.0-r2.apk scanelf-1.2.6-r0.apk<br />
chrony-3.5.1-r0.apk libtls-standalone-2.9.1-r1.apk signature.tar.gz<br />
chrony-openrc-3.5.1-r0.apk libusb-1.0.23-r0.apk ssl_client-1.31.1-r19.apk<br />
curl-7.69.1-r3.apk libuuid-2.35.2-r0.apk tar-1.32-r1.apk<br />
dbus-libs-1.12.18-r0.apk lzip-1.21-r0.apk tcpdump-4.9.3-r2.apk<br />
dnsmasq-2.81-r0.apk mii-tool-1.60_git20140218-r2.apk tree-1.8.0-r0.apk<br />
e2fsprogs-1.45.6-r0.apk musl-1.1.24-r10.apk tzdata-2020c-r1.apk<br />
e2fsprogs-libs-1.45.6-r0.apk musl-utils-1.1.24-r10.apk usb-modeswitch-2.6.0-r1.apk<br />
ethtool-5.6-r0.apk ncurses-libs-6.2_p20200523-r0.apk vlan-2.2-r0.apk<br />
ez-ipupdate-3.0.10-r9.apk ncurses-terminfo-base-6.2_p20200523-r0.apk wireless-tools-30_pre9-r1.apk<br />
fakeroot-1.24-r0.apk net-tools-1.60_git20140218-r2.apk wpa_supplicant-2.9-r5.apk<br />
haveged-1.9.8-r1.apk network-extras-1.2-r0.apk wpa_supplicant-openrc-2.9-r5.apk<br />
haveged-openrc-1.9.8-r1.apk nghttp2-1.41.0-r0.apk zlib-1.2.11-r3.apk<br />
hostapd-2.9-r2.apk nghttp2-libs-1.41.0-r0.apk<br />
hostapd-openrc-2.9-r2.apk openrc-0.42.1-r11.apk</div>Rickyrockrathttps://wiki.alpinelinux.org/w/index.php?title=How_to_set_up_Alpine_as_a_wireless_router&diff=22749How to set up Alpine as a wireless router2022-12-08T05:25:15Z<p>Rickyrockrat: /* interfaces */</p>
<hr />
<div>=== Pi Zero W Wireless Router ===<br />
<br />
This page describes building a Wireless Access Point with two wired ethernet ports for building a home router that connects to the internet with one wired port, and an internal LAN with the second wired port and the on-board WiFi.<br><br />
<br />
The intent is to provide this:<br><br />
<pre><br />
|<-->eth1 <-->| <br />
Internet <--> eth0 <-->FireWall<-->br0 Internal<--> ssh,bind,dhcp, with ssh reverse ssh connections.<br />
|<-->wlan0<-->|<br />
</pre><br />
<br />
=== Overview ===<br />
I generally run Debian and when forced by Red Hot Irons, Red Hat. This is my first foray into Alpine. So far I am very impressed. I mirrored the 3.12 armhf repos so I had things local when I needed them. Word to the wise, it comprises 13 GB of apk files.<br><br />
One *really* nice feature of Alpine is apk, the yum/apt replacement:<br><br />
* It is simple and to the point.<br />
* The same tool provides *repo* level dependency reporting!<br />
* Install of single packages without repo signing (I never did get the signing correct, but I can install).<br />
<br />
=== Prepare ===<br />
* Obtain a microSD card (or HDD) you can wipe the data from. We will assume it is /dev/sdc.<br />
* Make a 256M FAT16 partition (sudo mkfs.vfat -n ALPBOOT /dev/sdc1)<br />
* The rest of the device can be ext2 (ext3/4 on HDD) (sudo mke2fs -m1 -L alext3 /dev/sdc2).<br />
* Untar the alpine-rpi-3.12.3-armhf.tar.gz and copy all of the files to the fat16 partition which can be as large as 2G. <br />
* Make sure you have all the packages from the package list below installed on the SD card. This will save you lots of time.<br />
* Add this to usercfg.txt at the root of the FAT16 partition:<br />
enable_uart=1<br />
gpu_mem=16<br />
dtparam=audio=off<br />
* This is the contents of cmdline.txt:<br />
modules=loop,squashfs,sd-mod,usb-storage console=tty1 console=ttyAMA0,115200<br />
<br />
=== First Boot ===<br />
* Put the SD into the pi zero<br />
* Connect the serial port<br />
* Run minicom with the parameters set to 115200,n,8,1, no flow control.<br />
* Power up the Pi.<br />
<br />
=== Copy Root ===<br />
* mkdir /stage<br />
* mount /dev/sda2 /stage<br />
* for d in $(ls -1 /|grep -v 'media\|stage\|dev\|proc\|sys'); do cp -a /$d /stage; done<br />
* modules are loop mounted to /.modloop, and lib/modules is symlinked to that, so<br />
* rm /stage/lib/modules<br />
* cp -a /.modloop /stage/lib/modules<br />
* Fix cmdline.txt<br />
mount -o remount,rw /media/mmcblk0p1<br />
echo 'root=/dev/mmcblk0p2' >> /media/mmcblk0p1/cmdline.txt<br />
* reboot<br />
<br />
=== Install ===<br />
* verify you are now operating from the ext2 filesystem where you copied the rootfs.<br />
* install openssh, openssh-server, openssh-client, openssh-server-common,<br />
* install dnsmasq, ethtool, hostapd*, busybox extras, iptables*, iw,net-tools, tree, wireless-tools.<br />
* edit all the configurations supplied here.<br />
<br />
===== ssh config =====<br />
The allowed users are not normal names since I want the names to be a little obfuscated. Not that it really matters, since this is a key driven setup<br><br />
AddressFamily inet<br><br />
ListenAddress 0.0.0.0<br><br />
HostKey /etc/ssh/ssh_host_rsa_key<br><br />
LogLevel INFO<br><br />
LoginGraceTime 30<br><br />
PermitRootLogin no<br><br />
StrictModes yes<br><br />
AllowUsers Som123X Extern4524User<br><br />
PubkeyAuthentication yes<br><br />
AuthorizedKeysFile /etc/ssh/authorized_keys<br><br />
HostbasedAuthentication yes<br><br />
IgnoreUserKnownHosts yes<br><br />
IgnoreRhosts yes<br><br />
PasswordAuthentication no<br><br />
ChallengeResponseAuthentication no<br><br />
AllowTcpForwarding yes<br><br />
GatewayPorts yes<br><br />
X11Forwarding no<br><br />
<br />
<br />
===== dnsmasq.conf =====<br />
/etc/dnsmasq.conf<br><br />
This has two subnets. One for normal dhcp, the other for pseudo static - dhcp provided by MAC. One example here.<br><br />
<pre><br />
interface=br0<br />
except-interface=eth0<br />
dhcp-range=subnet0,192.168.0.10,192.168.0.100,255.255.255.0,24h<br />
dhcp-range=subnet1,192.168.0.4,192.168.0.6,255.255.255.0,24h<br />
bind-interfaces<br />
#log-queries<br />
#log-dhcp<br />
dhcp-host=70:85:66:c4:48:55,192.168.0.4,nas<br />
</pre><br />
<br />
===== /etc/hosts =====<br />
dnsmasq provides DNS answers from the hosts file. Nice. <br><br />
<pre><br />
127.0.0.1 localhost localhost.localdomain<br />
::1 localhost localhost.localdomain<br />
192.168.0.3 wireless<br />
192.168.0.4 nas<br />
192.168.0.5 mpd<br />
</pre><br />
<br />
===== hostapd.conf =====<br />
/etc/hostapd/hostapd.conf<br><br />
interface=wlan0<br><br />
bridge=br0<br><br />
hw_mode=g<br><br />
channel=7<br><br />
wmm_enabled=0<br><br />
macaddr_acl=0<br><br />
auth_algs=1<br><br />
ignore_broadcast_ssid=0<br><br />
wpa=2<br><br />
wpa_key_mgmt=WPA-PSK<br><br />
wpa_pairwise=TKIP<br><br />
rsn_pairwise=CCMP<br><br />
ssid=Whatever<br><br />
wpa_passphrase=YouMakeItUp<br><br />
<br />
===== interfaces =====<br />
/etc/network/interfaces<br><br />
<pre><br />
auto lo<br />
iface lo inet loopback<br />
<br />
auto eth0<br />
iface eth0 inet dhcp<br />
hostname ANYNAME<br />
hwaddress ether FE:ED:BE:EF:33:DD<br />
<br />
iface eth1 inet manual<br />
iface wlan0 inet manual<br />
<br />
auto br0<br />
iface br0 inet static<br />
pre-up ifconfig eth1 up<br />
bridge-ports eth1 wlan0<br />
bridge-stp off<br />
address 192.168.0.3<br />
broadcaset 192.168.1.255<br />
netmask 255.255.255.0<br />
</pre><br />
<br />
===== Permissive iptables =====<br />
Do NOT use this connected to the internet! There is NO protection.<br><br />
This is my stopopen in my replacement iptables<br><br />
iptables -P INPUT ACCEPT<br><<br />
iptables -F INPUT<br><br />
iptables -P OUTPUT ACCEPT<br><br />
iptables -F OUTPUT<br><br />
iptables -P FORWARD ACCEPT<br><br />
iptables -F FORWARD<br><br />
iptables -F -t nat<br><br />
iptables -F<br><br />
<br />
=== References ===<br />
apk notes:<br />
<br />
* Create, index and check dependencies on a list of apk files: apk index -o APKINDEX.unsigned.tar.gz *.apk<br />
* Install a package: apk add iw OR apk add /path/to/iw-5.4-r0.apk<br />
* remove a package: apk del iw<br />
* repository lists are in: /etc/apk/repositories<br />
* Local URL: /media/mmcblk0p1/apks<br />
* Remote URL: http://dl-cdn.alpinelinux.org/alpine/v3.12/main<br />
<br />
[https://en.wikipedia.org/wiki/File_Allocation_Table FAT16/32 limits]<br><br />
[https://udhcp.busybox.net/README.udhcpc udhcpc]<br><br />
[https://linux.die.net/man/8/ez-ipupdate ez-ipupdate]<br><br />
[[Alpine_Linux:FAQ#Dynamic_DNS|Dynamic_DNS]]<br><br />
[[Bridge|Alpine Linux Bridge]]<br><br />
[[Connecting_to_a_wireless_access_point|Connect to wireless AP]]<br><br />
[https://unix.stackexchange.com/questions/222264/how-do-i-limit-dnsmasq-listening-to-only-one-interface dnsmasq listen restrictions]<br><br />
[https://wiki.archlinux.org/index.php/IPv6#Disable_IPv6 Disable IPV6]<br><br />
[https://github.com/imp/dnsmasq/blob/master/dnsmasq.conf.example dnsmasq Docs]<br><br />
[https://man.openbsd.org/hostapd.conf.5 HostApd Docs]<br><br />
[rsync://rsync.alpinelinux.org/alpine Alpine Repos]<br><br />
[https://stevessmarthomeguide.com/home-network-dns-dnsmasq Set Static DNS names]<br><br />
[https://unix.stackexchange.com/questions/504100/how-to-create-ssh-reverse-tunnel-with-iptables-forwarding Reverse SSH tunnel]<br><br />
===== Pi Specific =====<br />
[https://raspberrypi.stackexchange.com/questions/89803/access-point-as-wifi-router-repeater-optional-with-bridge/89804 Pi Wifi Repeater]<br><br />
[https://raspberrypi.stackexchange.com/questions/81486/raspberry-pi-wifi-to-ethernet-bridge-for-a-server/81518 WiFi Bridge]<br><br />
[[Raspberry_Pi|Alpine Install]]<br><br />
[[Classic_install_or_sys_mode_on_Raspberry_Pi|Classic Sys Install on Pi]]<br><br />
<br />
==== Not Related, but Interesting ====<br />
[https://blog.thewalr.us/2017/09/26/raspberry-pi-zero-w-simultaneous-ap-and-managed-mode-wifi AP and Managed Mode]<br><br />
[https://www.instructables.com/Using-a-Raspberry-PI-Zero-W-As-an-Access-Point-and AP and MQTT]<br><br />
<br />
==== Package List ====<br />
Put these in the apks/armhf directory on the 256M Fat partition:<br><br />
<br />
iptables-1.8.4-r2.apk openssh-8.3_p1-r1.apk<br />
iptables-openrc-1.8.4-r2.apk openssh-client-8.3_p1-r1.apk<br />
abuild-3.6.0-r1.apk iw-5.4-r0.apk openssh-keygen-8.3_p1-r1.apk<br />
alpine-base-3.12.3-r0.apk kbd-bkeymaps-2.2.0-r2.apk openssh-server-8.3_p1-r1.apk<br />
alpine-baselayout-3.2.0-r7.apk libacl-2.2.53-r0.apk openssh-server-common-8.3_p1-r1.apk<br />
alpine-conf-3.9.0-r1.apk libattr-2.4.48-r0.apk openssh-sftp-server-8.3_p1-r1.apk<br />
alpine-keys-2.2-r0.apk libblkid-2.35.2-r0.apk openssl-1.1.1i-r0.apk<br />
alpine-mirrors-3.5.10-r0.apk libc-utils-0.7.2-r3.apk patch-2.7.6-r6.apk<br />
apk-tools-2.10.5-r1.apk libcap-2.27-r0.apk pcsc-lite-libs-1.8.26-r0.apk<br />
attr-2.4.48-r0.apk libcom_err-1.45.6-r0.apk pkgconf-1.7.2-r0.apk<br />
bash-5.0.17-r0.apk libcrypto1.1-1.1.1i-r0.apk ppp-atm-2.4.8-r2.apk<br />
bash-completion-2.10-r0.apk libcurl-7.69.1-r3.apk ppp-chat-2.4.8-r2.apk<br />
bonding-2.6-r4.apk libedit-20191231.3.1-r0.apk ppp-daemon-2.4.8-r2.apk<br />
bridge-1.5-r4.apk libev-4.33-r0.apk ppp-l2tp-2.4.8-r2.apk<br />
bridge-utils-1.6-r0.apk libgcc-9.3.0-r2.apk ppp-minconn-2.4.8-r2.apk<br />
busybox-1.31.1-r19.apk libmnl-1.0.4-r0.apk ppp-passprompt-2.4.8-r2.apk<br />
busybox-extras-1.31.1-r19.apk libnftnl-1.1.6-r0.apk ppp-passwordfd-2.4.8-r2.apk<br />
busybox-initscripts-3.2-r2.apk libnftnl-libs-1.1.6-r0.apk ppp-pppoe-2.4.8-r2.apk<br />
busybox-suid-1.31.1-r19.apk libnl3-3.5.0-r0.apk ppp-radius-2.4.8-r2.apk<br />
c-ares-1.16.1-r0.apk libpcap-1.9.1-r2.apk ppp-winbind-2.4.8-r2.apk<br />
ca-certificates-20191127-r4.apk libssl1.1-1.1.1i-r0.apk readline-8.0.4-r0.apk<br />
ca-certificates-bundle-20191127-r4.apk libstdc++-9.3.0-r2.apk scanelf-1.2.6-r0.apk<br />
chrony-3.5.1-r0.apk libtls-standalone-2.9.1-r1.apk signature.tar.gz<br />
chrony-openrc-3.5.1-r0.apk libusb-1.0.23-r0.apk ssl_client-1.31.1-r19.apk<br />
curl-7.69.1-r3.apk libuuid-2.35.2-r0.apk tar-1.32-r1.apk<br />
dbus-libs-1.12.18-r0.apk lzip-1.21-r0.apk tcpdump-4.9.3-r2.apk<br />
dnsmasq-2.81-r0.apk mii-tool-1.60_git20140218-r2.apk tree-1.8.0-r0.apk<br />
e2fsprogs-1.45.6-r0.apk musl-1.1.24-r10.apk tzdata-2020c-r1.apk<br />
e2fsprogs-libs-1.45.6-r0.apk musl-utils-1.1.24-r10.apk usb-modeswitch-2.6.0-r1.apk<br />
ethtool-5.6-r0.apk ncurses-libs-6.2_p20200523-r0.apk vlan-2.2-r0.apk<br />
ez-ipupdate-3.0.10-r9.apk ncurses-terminfo-base-6.2_p20200523-r0.apk wireless-tools-30_pre9-r1.apk<br />
fakeroot-1.24-r0.apk net-tools-1.60_git20140218-r2.apk wpa_supplicant-2.9-r5.apk<br />
haveged-1.9.8-r1.apk network-extras-1.2-r0.apk wpa_supplicant-openrc-2.9-r5.apk<br />
haveged-openrc-1.9.8-r1.apk nghttp2-1.41.0-r0.apk zlib-1.2.11-r3.apk<br />
hostapd-2.9-r2.apk nghttp2-libs-1.41.0-r0.apk<br />
hostapd-openrc-2.9-r2.apk openrc-0.42.1-r11.apk</div>Rickyrockrathttps://wiki.alpinelinux.org/w/index.php?title=How_to_set_up_Alpine_as_a_wireless_router&diff=22748How to set up Alpine as a wireless router2022-12-08T05:23:45Z<p>Rickyrockrat: /* /etc/hosts */</p>
<hr />
<div>=== Pi Zero W Wireless Router ===<br />
<br />
This page describes building a Wireless Access Point with two wired ethernet ports for building a home router that connects to the internet with one wired port, and an internal LAN with the second wired port and the on-board WiFi.<br><br />
<br />
The intent is to provide this:<br><br />
<pre><br />
|<-->eth1 <-->| <br />
Internet <--> eth0 <-->FireWall<-->br0 Internal<--> ssh,bind,dhcp, with ssh reverse ssh connections.<br />
|<-->wlan0<-->|<br />
</pre><br />
<br />
=== Overview ===<br />
I generally run Debian and when forced by Red Hot Irons, Red Hat. This is my first foray into Alpine. So far I am very impressed. I mirrored the 3.12 armhf repos so I had things local when I needed them. Word to the wise, it comprises 13 GB of apk files.<br><br />
One *really* nice feature of Alpine is apk, the yum/apt replacement:<br><br />
* It is simple and to the point.<br />
* The same tool provides *repo* level dependency reporting!<br />
* Install of single packages without repo signing (I never did get the signing correct, but I can install).<br />
<br />
=== Prepare ===<br />
* Obtain a microSD card (or HDD) you can wipe the data from. We will assume it is /dev/sdc.<br />
* Make a 256M FAT16 partition (sudo mkfs.vfat -n ALPBOOT /dev/sdc1)<br />
* The rest of the device can be ext2 (ext3/4 on HDD) (sudo mke2fs -m1 -L alext3 /dev/sdc2).<br />
* Untar the alpine-rpi-3.12.3-armhf.tar.gz and copy all of the files to the fat16 partition which can be as large as 2G. <br />
* Make sure you have all the packages from the package list below installed on the SD card. This will save you lots of time.<br />
* Add this to usercfg.txt at the root of the FAT16 partition:<br />
enable_uart=1<br />
gpu_mem=16<br />
dtparam=audio=off<br />
* This is the contents of cmdline.txt:<br />
modules=loop,squashfs,sd-mod,usb-storage console=tty1 console=ttyAMA0,115200<br />
<br />
=== First Boot ===<br />
* Put the SD into the pi zero<br />
* Connect the serial port<br />
* Run minicom with the parameters set to 115200,n,8,1, no flow control.<br />
* Power up the Pi.<br />
<br />
=== Copy Root ===<br />
* mkdir /stage<br />
* mount /dev/sda2 /stage<br />
* for d in $(ls -1 /|grep -v 'media\|stage\|dev\|proc\|sys'); do cp -a /$d /stage; done<br />
* modules are loop mounted to /.modloop, and lib/modules is symlinked to that, so<br />
* rm /stage/lib/modules<br />
* cp -a /.modloop /stage/lib/modules<br />
* Fix cmdline.txt<br />
mount -o remount,rw /media/mmcblk0p1<br />
echo 'root=/dev/mmcblk0p2' >> /media/mmcblk0p1/cmdline.txt<br />
* reboot<br />
<br />
=== Install ===<br />
* verify you are now operating from the ext2 filesystem where you copied the rootfs.<br />
* install openssh, openssh-server, openssh-client, openssh-server-common,<br />
* install dnsmasq, ethtool, hostapd*, busybox extras, iptables*, iw,net-tools, tree, wireless-tools.<br />
* edit all the configurations supplied here.<br />
<br />
===== ssh config =====<br />
The allowed users are not normal names since I want the names to be a little obfuscated. Not that it really matters, since this is a key driven setup<br><br />
AddressFamily inet<br><br />
ListenAddress 0.0.0.0<br><br />
HostKey /etc/ssh/ssh_host_rsa_key<br><br />
LogLevel INFO<br><br />
LoginGraceTime 30<br><br />
PermitRootLogin no<br><br />
StrictModes yes<br><br />
AllowUsers Som123X Extern4524User<br><br />
PubkeyAuthentication yes<br><br />
AuthorizedKeysFile /etc/ssh/authorized_keys<br><br />
HostbasedAuthentication yes<br><br />
IgnoreUserKnownHosts yes<br><br />
IgnoreRhosts yes<br><br />
PasswordAuthentication no<br><br />
ChallengeResponseAuthentication no<br><br />
AllowTcpForwarding yes<br><br />
GatewayPorts yes<br><br />
X11Forwarding no<br><br />
<br />
<br />
===== dnsmasq.conf =====<br />
/etc/dnsmasq.conf<br><br />
This has two subnets. One for normal dhcp, the other for pseudo static - dhcp provided by MAC. One example here.<br><br />
<pre><br />
interface=br0<br />
except-interface=eth0<br />
dhcp-range=subnet0,192.168.0.10,192.168.0.100,255.255.255.0,24h<br />
dhcp-range=subnet1,192.168.0.4,192.168.0.6,255.255.255.0,24h<br />
bind-interfaces<br />
#log-queries<br />
#log-dhcp<br />
dhcp-host=70:85:66:c4:48:55,192.168.0.4,nas<br />
</pre><br />
<br />
===== /etc/hosts =====<br />
dnsmasq provides DNS answers from the hosts file. Nice. <br><br />
<pre><br />
127.0.0.1 localhost localhost.localdomain<br />
::1 localhost localhost.localdomain<br />
192.168.0.3 wireless<br />
192.168.0.4 nas<br />
192.168.0.5 mpd<br />
</pre><br />
<br />
===== hostapd.conf =====<br />
/etc/hostapd/hostapd.conf<br><br />
interface=wlan0<br><br />
bridge=br0<br><br />
hw_mode=g<br><br />
channel=7<br><br />
wmm_enabled=0<br><br />
macaddr_acl=0<br><br />
auth_algs=1<br><br />
ignore_broadcast_ssid=0<br><br />
wpa=2<br><br />
wpa_key_mgmt=WPA-PSK<br><br />
wpa_pairwise=TKIP<br><br />
rsn_pairwise=CCMP<br><br />
ssid=Whatever<br><br />
wpa_passphrase=YouMakeItUp<br><br />
<br />
===== interfaces =====<br />
/etc/network/interfaces<br><br />
auto lo<br><br />
iface lo inet loopback<br><br />
<br><br />
auto eth0<br><br />
iface eth0 inet dhcp<br><br />
hostname ANYNAME<br><br />
hwaddress ether FE:ED:BE:EF:33:DD<br><br />
<br><br />
iface eth1 inet manual<br><br />
iface wlan0 inet manual<br><br />
<br><br />
auto br0<br><br />
iface br0 inet static<br><br />
pre-up ifconfig eth1 up<br><br />
bridge-ports eth1 wlan0<br><br />
bridge-stp off<br><br />
address 192.168.0.3<br><br />
broadcaset 192.168.1.255<br><br />
netmask 255.255.255.0<br><br />
<br />
===== Permissive iptables =====<br />
Do NOT use this connected to the internet! There is NO protection.<br><br />
This is my stopopen in my replacement iptables<br><br />
iptables -P INPUT ACCEPT<br><<br />
iptables -F INPUT<br><br />
iptables -P OUTPUT ACCEPT<br><br />
iptables -F OUTPUT<br><br />
iptables -P FORWARD ACCEPT<br><br />
iptables -F FORWARD<br><br />
iptables -F -t nat<br><br />
iptables -F<br><br />
<br />
=== References ===<br />
apk notes:<br />
<br />
* Create, index and check dependencies on a list of apk files: apk index -o APKINDEX.unsigned.tar.gz *.apk<br />
* Install a package: apk add iw OR apk add /path/to/iw-5.4-r0.apk<br />
* remove a package: apk del iw<br />
* repository lists are in: /etc/apk/repositories<br />
* Local URL: /media/mmcblk0p1/apks<br />
* Remote URL: http://dl-cdn.alpinelinux.org/alpine/v3.12/main<br />
<br />
[https://en.wikipedia.org/wiki/File_Allocation_Table FAT16/32 limits]<br><br />
[https://udhcp.busybox.net/README.udhcpc udhcpc]<br><br />
[https://linux.die.net/man/8/ez-ipupdate ez-ipupdate]<br><br />
[[Alpine_Linux:FAQ#Dynamic_DNS|Dynamic_DNS]]<br><br />
[[Bridge|Alpine Linux Bridge]]<br><br />
[[Connecting_to_a_wireless_access_point|Connect to wireless AP]]<br><br />
[https://unix.stackexchange.com/questions/222264/how-do-i-limit-dnsmasq-listening-to-only-one-interface dnsmasq listen restrictions]<br><br />
[https://wiki.archlinux.org/index.php/IPv6#Disable_IPv6 Disable IPV6]<br><br />
[https://github.com/imp/dnsmasq/blob/master/dnsmasq.conf.example dnsmasq Docs]<br><br />
[https://man.openbsd.org/hostapd.conf.5 HostApd Docs]<br><br />
[rsync://rsync.alpinelinux.org/alpine Alpine Repos]<br><br />
[https://stevessmarthomeguide.com/home-network-dns-dnsmasq Set Static DNS names]<br><br />
[https://unix.stackexchange.com/questions/504100/how-to-create-ssh-reverse-tunnel-with-iptables-forwarding Reverse SSH tunnel]<br><br />
===== Pi Specific =====<br />
[https://raspberrypi.stackexchange.com/questions/89803/access-point-as-wifi-router-repeater-optional-with-bridge/89804 Pi Wifi Repeater]<br><br />
[https://raspberrypi.stackexchange.com/questions/81486/raspberry-pi-wifi-to-ethernet-bridge-for-a-server/81518 WiFi Bridge]<br><br />
[[Raspberry_Pi|Alpine Install]]<br><br />
[[Classic_install_or_sys_mode_on_Raspberry_Pi|Classic Sys Install on Pi]]<br><br />
<br />
==== Not Related, but Interesting ====<br />
[https://blog.thewalr.us/2017/09/26/raspberry-pi-zero-w-simultaneous-ap-and-managed-mode-wifi AP and Managed Mode]<br><br />
[https://www.instructables.com/Using-a-Raspberry-PI-Zero-W-As-an-Access-Point-and AP and MQTT]<br><br />
<br />
==== Package List ====<br />
Put these in the apks/armhf directory on the 256M Fat partition:<br><br />
<br />
iptables-1.8.4-r2.apk openssh-8.3_p1-r1.apk<br />
iptables-openrc-1.8.4-r2.apk openssh-client-8.3_p1-r1.apk<br />
abuild-3.6.0-r1.apk iw-5.4-r0.apk openssh-keygen-8.3_p1-r1.apk<br />
alpine-base-3.12.3-r0.apk kbd-bkeymaps-2.2.0-r2.apk openssh-server-8.3_p1-r1.apk<br />
alpine-baselayout-3.2.0-r7.apk libacl-2.2.53-r0.apk openssh-server-common-8.3_p1-r1.apk<br />
alpine-conf-3.9.0-r1.apk libattr-2.4.48-r0.apk openssh-sftp-server-8.3_p1-r1.apk<br />
alpine-keys-2.2-r0.apk libblkid-2.35.2-r0.apk openssl-1.1.1i-r0.apk<br />
alpine-mirrors-3.5.10-r0.apk libc-utils-0.7.2-r3.apk patch-2.7.6-r6.apk<br />
apk-tools-2.10.5-r1.apk libcap-2.27-r0.apk pcsc-lite-libs-1.8.26-r0.apk<br />
attr-2.4.48-r0.apk libcom_err-1.45.6-r0.apk pkgconf-1.7.2-r0.apk<br />
bash-5.0.17-r0.apk libcrypto1.1-1.1.1i-r0.apk ppp-atm-2.4.8-r2.apk<br />
bash-completion-2.10-r0.apk libcurl-7.69.1-r3.apk ppp-chat-2.4.8-r2.apk<br />
bonding-2.6-r4.apk libedit-20191231.3.1-r0.apk ppp-daemon-2.4.8-r2.apk<br />
bridge-1.5-r4.apk libev-4.33-r0.apk ppp-l2tp-2.4.8-r2.apk<br />
bridge-utils-1.6-r0.apk libgcc-9.3.0-r2.apk ppp-minconn-2.4.8-r2.apk<br />
busybox-1.31.1-r19.apk libmnl-1.0.4-r0.apk ppp-passprompt-2.4.8-r2.apk<br />
busybox-extras-1.31.1-r19.apk libnftnl-1.1.6-r0.apk ppp-passwordfd-2.4.8-r2.apk<br />
busybox-initscripts-3.2-r2.apk libnftnl-libs-1.1.6-r0.apk ppp-pppoe-2.4.8-r2.apk<br />
busybox-suid-1.31.1-r19.apk libnl3-3.5.0-r0.apk ppp-radius-2.4.8-r2.apk<br />
c-ares-1.16.1-r0.apk libpcap-1.9.1-r2.apk ppp-winbind-2.4.8-r2.apk<br />
ca-certificates-20191127-r4.apk libssl1.1-1.1.1i-r0.apk readline-8.0.4-r0.apk<br />
ca-certificates-bundle-20191127-r4.apk libstdc++-9.3.0-r2.apk scanelf-1.2.6-r0.apk<br />
chrony-3.5.1-r0.apk libtls-standalone-2.9.1-r1.apk signature.tar.gz<br />
chrony-openrc-3.5.1-r0.apk libusb-1.0.23-r0.apk ssl_client-1.31.1-r19.apk<br />
curl-7.69.1-r3.apk libuuid-2.35.2-r0.apk tar-1.32-r1.apk<br />
dbus-libs-1.12.18-r0.apk lzip-1.21-r0.apk tcpdump-4.9.3-r2.apk<br />
dnsmasq-2.81-r0.apk mii-tool-1.60_git20140218-r2.apk tree-1.8.0-r0.apk<br />
e2fsprogs-1.45.6-r0.apk musl-1.1.24-r10.apk tzdata-2020c-r1.apk<br />
e2fsprogs-libs-1.45.6-r0.apk musl-utils-1.1.24-r10.apk usb-modeswitch-2.6.0-r1.apk<br />
ethtool-5.6-r0.apk ncurses-libs-6.2_p20200523-r0.apk vlan-2.2-r0.apk<br />
ez-ipupdate-3.0.10-r9.apk ncurses-terminfo-base-6.2_p20200523-r0.apk wireless-tools-30_pre9-r1.apk<br />
fakeroot-1.24-r0.apk net-tools-1.60_git20140218-r2.apk wpa_supplicant-2.9-r5.apk<br />
haveged-1.9.8-r1.apk network-extras-1.2-r0.apk wpa_supplicant-openrc-2.9-r5.apk<br />
haveged-openrc-1.9.8-r1.apk nghttp2-1.41.0-r0.apk zlib-1.2.11-r3.apk<br />
hostapd-2.9-r2.apk nghttp2-libs-1.41.0-r0.apk<br />
hostapd-openrc-2.9-r2.apk openrc-0.42.1-r11.apk</div>Rickyrockrathttps://wiki.alpinelinux.org/w/index.php?title=How_to_set_up_Alpine_as_a_wireless_router&diff=22747How to set up Alpine as a wireless router2022-12-08T05:23:05Z<p>Rickyrockrat: /* dnsmasq.conf */</p>
<hr />
<div>=== Pi Zero W Wireless Router ===<br />
<br />
This page describes building a Wireless Access Point with two wired ethernet ports for building a home router that connects to the internet with one wired port, and an internal LAN with the second wired port and the on-board WiFi.<br><br />
<br />
The intent is to provide this:<br><br />
<pre><br />
|<-->eth1 <-->| <br />
Internet <--> eth0 <-->FireWall<-->br0 Internal<--> ssh,bind,dhcp, with ssh reverse ssh connections.<br />
|<-->wlan0<-->|<br />
</pre><br />
<br />
=== Overview ===<br />
I generally run Debian and when forced by Red Hot Irons, Red Hat. This is my first foray into Alpine. So far I am very impressed. I mirrored the 3.12 armhf repos so I had things local when I needed them. Word to the wise, it comprises 13 GB of apk files.<br><br />
One *really* nice feature of Alpine is apk, the yum/apt replacement:<br><br />
* It is simple and to the point.<br />
* The same tool provides *repo* level dependency reporting!<br />
* Install of single packages without repo signing (I never did get the signing correct, but I can install).<br />
<br />
=== Prepare ===<br />
* Obtain a microSD card (or HDD) you can wipe the data from. We will assume it is /dev/sdc.<br />
* Make a 256M FAT16 partition (sudo mkfs.vfat -n ALPBOOT /dev/sdc1)<br />
* The rest of the device can be ext2 (ext3/4 on HDD) (sudo mke2fs -m1 -L alext3 /dev/sdc2).<br />
* Untar the alpine-rpi-3.12.3-armhf.tar.gz and copy all of the files to the fat16 partition which can be as large as 2G. <br />
* Make sure you have all the packages from the package list below installed on the SD card. This will save you lots of time.<br />
* Add this to usercfg.txt at the root of the FAT16 partition:<br />
enable_uart=1<br />
gpu_mem=16<br />
dtparam=audio=off<br />
* This is the contents of cmdline.txt:<br />
modules=loop,squashfs,sd-mod,usb-storage console=tty1 console=ttyAMA0,115200<br />
<br />
=== First Boot ===<br />
* Put the SD into the pi zero<br />
* Connect the serial port<br />
* Run minicom with the parameters set to 115200,n,8,1, no flow control.<br />
* Power up the Pi.<br />
<br />
=== Copy Root ===<br />
* mkdir /stage<br />
* mount /dev/sda2 /stage<br />
* for d in $(ls -1 /|grep -v 'media\|stage\|dev\|proc\|sys'); do cp -a /$d /stage; done<br />
* modules are loop mounted to /.modloop, and lib/modules is symlinked to that, so<br />
* rm /stage/lib/modules<br />
* cp -a /.modloop /stage/lib/modules<br />
* Fix cmdline.txt<br />
mount -o remount,rw /media/mmcblk0p1<br />
echo 'root=/dev/mmcblk0p2' >> /media/mmcblk0p1/cmdline.txt<br />
* reboot<br />
<br />
=== Install ===<br />
* verify you are now operating from the ext2 filesystem where you copied the rootfs.<br />
* install openssh, openssh-server, openssh-client, openssh-server-common,<br />
* install dnsmasq, ethtool, hostapd*, busybox extras, iptables*, iw,net-tools, tree, wireless-tools.<br />
* edit all the configurations supplied here.<br />
<br />
===== ssh config =====<br />
The allowed users are not normal names since I want the names to be a little obfuscated. Not that it really matters, since this is a key driven setup<br><br />
AddressFamily inet<br><br />
ListenAddress 0.0.0.0<br><br />
HostKey /etc/ssh/ssh_host_rsa_key<br><br />
LogLevel INFO<br><br />
LoginGraceTime 30<br><br />
PermitRootLogin no<br><br />
StrictModes yes<br><br />
AllowUsers Som123X Extern4524User<br><br />
PubkeyAuthentication yes<br><br />
AuthorizedKeysFile /etc/ssh/authorized_keys<br><br />
HostbasedAuthentication yes<br><br />
IgnoreUserKnownHosts yes<br><br />
IgnoreRhosts yes<br><br />
PasswordAuthentication no<br><br />
ChallengeResponseAuthentication no<br><br />
AllowTcpForwarding yes<br><br />
GatewayPorts yes<br><br />
X11Forwarding no<br><br />
<br />
<br />
===== dnsmasq.conf =====<br />
/etc/dnsmasq.conf<br><br />
This has two subnets. One for normal dhcp, the other for pseudo static - dhcp provided by MAC. One example here.<br><br />
<pre><br />
interface=br0<br />
except-interface=eth0<br />
dhcp-range=subnet0,192.168.0.10,192.168.0.100,255.255.255.0,24h<br />
dhcp-range=subnet1,192.168.0.4,192.168.0.6,255.255.255.0,24h<br />
bind-interfaces<br />
#log-queries<br />
#log-dhcp<br />
dhcp-host=70:85:66:c4:48:55,192.168.0.4,nas<br />
</pre><br />
<br />
===== /etc/hosts =====<br />
dnsmasq provides DNS answers from the hosts file. Nice. <br><br />
127.0.0.1 localhost localhost.localdomain<br><br />
::1 localhost localhost.localdomain<br><br />
192.168.0.3 wireless<br><br />
192.168.0.4 nas<br><br />
192.168.0.5 mpd<br><br />
<br />
===== hostapd.conf =====<br />
/etc/hostapd/hostapd.conf<br><br />
interface=wlan0<br><br />
bridge=br0<br><br />
hw_mode=g<br><br />
channel=7<br><br />
wmm_enabled=0<br><br />
macaddr_acl=0<br><br />
auth_algs=1<br><br />
ignore_broadcast_ssid=0<br><br />
wpa=2<br><br />
wpa_key_mgmt=WPA-PSK<br><br />
wpa_pairwise=TKIP<br><br />
rsn_pairwise=CCMP<br><br />
ssid=Whatever<br><br />
wpa_passphrase=YouMakeItUp<br><br />
<br />
===== interfaces =====<br />
/etc/network/interfaces<br><br />
auto lo<br><br />
iface lo inet loopback<br><br />
<br><br />
auto eth0<br><br />
iface eth0 inet dhcp<br><br />
hostname ANYNAME<br><br />
hwaddress ether FE:ED:BE:EF:33:DD<br><br />
<br><br />
iface eth1 inet manual<br><br />
iface wlan0 inet manual<br><br />
<br><br />
auto br0<br><br />
iface br0 inet static<br><br />
pre-up ifconfig eth1 up<br><br />
bridge-ports eth1 wlan0<br><br />
bridge-stp off<br><br />
address 192.168.0.3<br><br />
broadcaset 192.168.1.255<br><br />
netmask 255.255.255.0<br><br />
<br />
===== Permissive iptables =====<br />
Do NOT use this connected to the internet! There is NO protection.<br><br />
This is my stopopen in my replacement iptables<br><br />
iptables -P INPUT ACCEPT<br><<br />
iptables -F INPUT<br><br />
iptables -P OUTPUT ACCEPT<br><br />
iptables -F OUTPUT<br><br />
iptables -P FORWARD ACCEPT<br><br />
iptables -F FORWARD<br><br />
iptables -F -t nat<br><br />
iptables -F<br><br />
<br />
=== References ===<br />
apk notes:<br />
<br />
* Create, index and check dependencies on a list of apk files: apk index -o APKINDEX.unsigned.tar.gz *.apk<br />
* Install a package: apk add iw OR apk add /path/to/iw-5.4-r0.apk<br />
* remove a package: apk del iw<br />
* repository lists are in: /etc/apk/repositories<br />
* Local URL: /media/mmcblk0p1/apks<br />
* Remote URL: http://dl-cdn.alpinelinux.org/alpine/v3.12/main<br />
<br />
[https://en.wikipedia.org/wiki/File_Allocation_Table FAT16/32 limits]<br><br />
[https://udhcp.busybox.net/README.udhcpc udhcpc]<br><br />
[https://linux.die.net/man/8/ez-ipupdate ez-ipupdate]<br><br />
[[Alpine_Linux:FAQ#Dynamic_DNS|Dynamic_DNS]]<br><br />
[[Bridge|Alpine Linux Bridge]]<br><br />
[[Connecting_to_a_wireless_access_point|Connect to wireless AP]]<br><br />
[https://unix.stackexchange.com/questions/222264/how-do-i-limit-dnsmasq-listening-to-only-one-interface dnsmasq listen restrictions]<br><br />
[https://wiki.archlinux.org/index.php/IPv6#Disable_IPv6 Disable IPV6]<br><br />
[https://github.com/imp/dnsmasq/blob/master/dnsmasq.conf.example dnsmasq Docs]<br><br />
[https://man.openbsd.org/hostapd.conf.5 HostApd Docs]<br><br />
[rsync://rsync.alpinelinux.org/alpine Alpine Repos]<br><br />
[https://stevessmarthomeguide.com/home-network-dns-dnsmasq Set Static DNS names]<br><br />
[https://unix.stackexchange.com/questions/504100/how-to-create-ssh-reverse-tunnel-with-iptables-forwarding Reverse SSH tunnel]<br><br />
===== Pi Specific =====<br />
[https://raspberrypi.stackexchange.com/questions/89803/access-point-as-wifi-router-repeater-optional-with-bridge/89804 Pi Wifi Repeater]<br><br />
[https://raspberrypi.stackexchange.com/questions/81486/raspberry-pi-wifi-to-ethernet-bridge-for-a-server/81518 WiFi Bridge]<br><br />
[[Raspberry_Pi|Alpine Install]]<br><br />
[[Classic_install_or_sys_mode_on_Raspberry_Pi|Classic Sys Install on Pi]]<br><br />
<br />
==== Not Related, but Interesting ====<br />
[https://blog.thewalr.us/2017/09/26/raspberry-pi-zero-w-simultaneous-ap-and-managed-mode-wifi AP and Managed Mode]<br><br />
[https://www.instructables.com/Using-a-Raspberry-PI-Zero-W-As-an-Access-Point-and AP and MQTT]<br><br />
<br />
==== Package List ====<br />
Put these in the apks/armhf directory on the 256M Fat partition:<br><br />
<br />
iptables-1.8.4-r2.apk openssh-8.3_p1-r1.apk<br />
iptables-openrc-1.8.4-r2.apk openssh-client-8.3_p1-r1.apk<br />
abuild-3.6.0-r1.apk iw-5.4-r0.apk openssh-keygen-8.3_p1-r1.apk<br />
alpine-base-3.12.3-r0.apk kbd-bkeymaps-2.2.0-r2.apk openssh-server-8.3_p1-r1.apk<br />
alpine-baselayout-3.2.0-r7.apk libacl-2.2.53-r0.apk openssh-server-common-8.3_p1-r1.apk<br />
alpine-conf-3.9.0-r1.apk libattr-2.4.48-r0.apk openssh-sftp-server-8.3_p1-r1.apk<br />
alpine-keys-2.2-r0.apk libblkid-2.35.2-r0.apk openssl-1.1.1i-r0.apk<br />
alpine-mirrors-3.5.10-r0.apk libc-utils-0.7.2-r3.apk patch-2.7.6-r6.apk<br />
apk-tools-2.10.5-r1.apk libcap-2.27-r0.apk pcsc-lite-libs-1.8.26-r0.apk<br />
attr-2.4.48-r0.apk libcom_err-1.45.6-r0.apk pkgconf-1.7.2-r0.apk<br />
bash-5.0.17-r0.apk libcrypto1.1-1.1.1i-r0.apk ppp-atm-2.4.8-r2.apk<br />
bash-completion-2.10-r0.apk libcurl-7.69.1-r3.apk ppp-chat-2.4.8-r2.apk<br />
bonding-2.6-r4.apk libedit-20191231.3.1-r0.apk ppp-daemon-2.4.8-r2.apk<br />
bridge-1.5-r4.apk libev-4.33-r0.apk ppp-l2tp-2.4.8-r2.apk<br />
bridge-utils-1.6-r0.apk libgcc-9.3.0-r2.apk ppp-minconn-2.4.8-r2.apk<br />
busybox-1.31.1-r19.apk libmnl-1.0.4-r0.apk ppp-passprompt-2.4.8-r2.apk<br />
busybox-extras-1.31.1-r19.apk libnftnl-1.1.6-r0.apk ppp-passwordfd-2.4.8-r2.apk<br />
busybox-initscripts-3.2-r2.apk libnftnl-libs-1.1.6-r0.apk ppp-pppoe-2.4.8-r2.apk<br />
busybox-suid-1.31.1-r19.apk libnl3-3.5.0-r0.apk ppp-radius-2.4.8-r2.apk<br />
c-ares-1.16.1-r0.apk libpcap-1.9.1-r2.apk ppp-winbind-2.4.8-r2.apk<br />
ca-certificates-20191127-r4.apk libssl1.1-1.1.1i-r0.apk readline-8.0.4-r0.apk<br />
ca-certificates-bundle-20191127-r4.apk libstdc++-9.3.0-r2.apk scanelf-1.2.6-r0.apk<br />
chrony-3.5.1-r0.apk libtls-standalone-2.9.1-r1.apk signature.tar.gz<br />
chrony-openrc-3.5.1-r0.apk libusb-1.0.23-r0.apk ssl_client-1.31.1-r19.apk<br />
curl-7.69.1-r3.apk libuuid-2.35.2-r0.apk tar-1.32-r1.apk<br />
dbus-libs-1.12.18-r0.apk lzip-1.21-r0.apk tcpdump-4.9.3-r2.apk<br />
dnsmasq-2.81-r0.apk mii-tool-1.60_git20140218-r2.apk tree-1.8.0-r0.apk<br />
e2fsprogs-1.45.6-r0.apk musl-1.1.24-r10.apk tzdata-2020c-r1.apk<br />
e2fsprogs-libs-1.45.6-r0.apk musl-utils-1.1.24-r10.apk usb-modeswitch-2.6.0-r1.apk<br />
ethtool-5.6-r0.apk ncurses-libs-6.2_p20200523-r0.apk vlan-2.2-r0.apk<br />
ez-ipupdate-3.0.10-r9.apk ncurses-terminfo-base-6.2_p20200523-r0.apk wireless-tools-30_pre9-r1.apk<br />
fakeroot-1.24-r0.apk net-tools-1.60_git20140218-r2.apk wpa_supplicant-2.9-r5.apk<br />
haveged-1.9.8-r1.apk network-extras-1.2-r0.apk wpa_supplicant-openrc-2.9-r5.apk<br />
haveged-openrc-1.9.8-r1.apk nghttp2-1.41.0-r0.apk zlib-1.2.11-r3.apk<br />
hostapd-2.9-r2.apk nghttp2-libs-1.41.0-r0.apk<br />
hostapd-openrc-2.9-r2.apk openrc-0.42.1-r11.apk</div>Rickyrockrathttps://wiki.alpinelinux.org/w/index.php?title=How_to_set_up_Alpine_as_a_wireless_router&diff=18456How to set up Alpine as a wireless router2021-01-03T14:01:46Z<p>Rickyrockrat: </p>
<hr />
<div>=== Pi Zero W Wireless Router ===<br />
<br />
This is a page to describe building a Wireless Access Point with two wired ethernet ports for building a home router that connects to the internet with one wired port, and internal Lan with the second wired port and the on-board WiFi.<br><br />
<br />
The intent is to provide this:<br><br />
<pre><br />
|<-->eth1 <-->| <br />
Internet <--> eth0 <-->FireWall<-->br0 Internal<--> ssh,bind,dhcp, with ssh reverse ssh connections.<br />
|<-->wlan0<-->|<br />
</pre><br />
=== Overview ===<br />
I generally run Debian and when forced by Red Hot Irons, Red Hat. This is my first foray into Alpine. So far I am very impressed. I mirrored the 3.12 armhf repos so I had things local when I needed them. Word to the wise. That is 13G of apk files.<br><br />
One *really* nice feature of Alpine is apk, the yum/apt replacement:<br><br />
* It is simple, short, and to the point.<br />
* The same tool provides *repo* level dependency reporting!<br />
* Install of single packages without repo signing (I never did get the signing correct, but I can install).<br />
=== Prepare ===<br />
* Find a microsd (or HDD) you can wipe. We will assume it is /dev/sdc.<br />
* make a 256M fat16 partition (sudo mkfs.vfat -n ALPBOOT /dev/sdc1)<br />
* the rest of the device can be ext2 (ext3/4 on HDD) (sudo mke2fs -m1 -L alext3 /dev/sdc2).<br />
* untar the alpine-rpi-3.12.3-armhf.tar.gz and copy all files to the fat16 partition which is good for up to 2G. <br />
* make sure you have all the packages from the package list below installed on the SD card. This will save you lots of time.<br />
* add this to usercfg.txt at the root of the FAT16:<br />
enable_uart=1<br />
gpu_mem=16<br />
dtparam=audio=off<br />
* This is the contents of cmdline.txt:<br />
modules=loop,squashfs,sd-mod,usb-storage console=tty1 console=ttyAMA0,115200<br />
=== First Boot ===<br />
* Put the SD into the pi zero<br />
* Connect the serial port<br />
* fire up minicom with 115200,n,8,1, with no software or hardware flow.<br />
* Power up the Pi.<br />
<br />
=== Copy Root ===<br />
* mkdir /stage<br />
* mount /dev/sda2 /stage<br />
* for d in $(ls -1 /|grep -v 'media\|stage\|dev\|proc\|sys'); do cp -a /$d /stage; done<br />
* modules are loop mounted to /.modloop, and lib/modules is symlinked to that, so<br />
* rm /stage/lib/modules<br />
* cp -a /.modloop /stage/lib/modules<br />
* Fixup cmdline.txt<br />
mount -o remount,rw /media/mmcblk0p1<br />
echo 'root=/dev/mmcblk0p2' >> /media/mmcblk0p1/cmdline.txt<br />
* reboot<br />
<br />
=== Install ===<br />
* verify you are now operating off of the ext2 FS where you copied over the rootfs.<br />
* install openssh, openssh-server, openssh-client, openssh-server-common,<br />
* install dnsmasq, ethtool, hostapd*, busybox extras, iptables*, iw,net-tools, tree, wireless-tools.<br />
* edit all the configurations supplied here.<br />
<br />
===== ssh config =====<br />
The allowed users are not normal names since I want the names to be a little obfuscated. Not that it really matters, since this is a key driven setup<br><br />
AddressFamily inet<br><br />
ListenAddress 0.0.0.0<br><br />
HostKey /etc/ssh/ssh_host_rsa_key<br><br />
LogLevel INFO<br><br />
LoginGraceTime 30<br><br />
PermitRootLogin no<br><br />
StrictModes yes<br><br />
AllowUsers Som123X Extern4524User<br><br />
PubkeyAuthentication yes<br><br />
AuthorizedKeysFile /etc/ssh/authorized_keys<br><br />
HostbasedAuthentication yes<br><br />
IgnoreUserKnownHosts yes<br><br />
IgnoreRhosts yes<br><br />
PasswordAuthentication no<br><br />
ChallengeResponseAuthentication no<br><br />
AllowTcpForwarding yes<br><br />
GatewayPorts yes<br><br />
X11Forwarding no<br><br />
<br />
<br />
===== dnsmasq.conf =====<br />
/etc/dnsmasq.conf<br><br />
This has two subnets. One for normal dhcp, the other for pseudo static - dhcp provided by MAC. One example here.<br><br />
interface=br0<br><br />
except-interface=eth0<br><br />
dhcp-range=subnet0,192.168.0.10,192.168.0.100,255.255.255.0,24h<br><br />
dhcp-range=subnet1,192.168.0.4,192.168.0.6,255.255.255.0,24h<br><br />
bind-interfaces<br><br />
#log-queries<br><br />
#log-dhcp<br><br />
dhcp-host=70:85:66:c4:48:55,192.168.0.4,nas<br><br />
<br />
===== /etc/hosts =====<br />
dnsmasq provides DNS answers from the hosts file. Nice. <br><br />
127.0.0.1 localhost localhost.localdomain<br><br />
::1 localhost localhost.localdomain<br><br />
192.168.0.3 wireless<br><br />
192.168.0.4 nas<br><br />
192.168.0.5 mpd<br><br />
<br />
===== hostapd.conf =====<br />
/etc/hostapd/hostapd.conf<br><br />
interface=wlan0<br><br />
bridge=br0<br><br />
hw_mode=g<br><br />
channel=7<br><br />
wmm_enabled=0<br><br />
macaddr_acl=0<br><br />
auth_algs=1<br><br />
ignore_broadcast_ssid=0<br><br />
wpa=2<br><br />
wpa_key_mgmt=WPA-PSK<br><br />
wpa_pairwise=TKIP<br><br />
rsn_pairwise=CCMP<br><br />
ssid=Whatever<br><br />
wpa_passphrase=YouMakeItUp<br><br />
<br />
===== interfaces =====<br />
/etc/network/interfaces<br><br />
auto lo<br><br />
iface lo inet loopback<br><br />
<br><br />
auto eth0<br><br />
iface eth0 inet dhcp<br><br />
hostname ANYNAME<br><br />
hwaddress ether FE:ED:BE:EF:33:DD<br><br />
<br><br />
iface eth1 inet manual<br><br />
iface wlan0 inet manual<br><br />
<br><br />
auto br0<br><br />
iface br0 inet static<br><br />
pre-up ifconfig eth1 up<br><br />
bridge-ports eth1 wlan0<br><br />
bridge-stp off<br><br />
address 192.168.0.3<br><br />
broadcaset 192.168.1.255<br><br />
netmask 255.255.255.0<br><br />
<br />
===== Permissive iptables =====<br />
Do NOT use this connected to the internet! This has no protection.<br><br />
This is my stopopen in my replacement iptables<br><br />
iptables -P INPUT ACCEPT<br><<br />
iptables -F INPUT<br><br />
iptables -P OUTPUT ACCEPT<br><br />
iptables -F OUTPUT<br><br />
iptables -P FORWARD ACCEPT<br><br />
iptables -F FORWARD<br><br />
iptables -F -t nat<br><br />
iptables -F<br><br />
<br />
=== References ===<br />
apk notes:<br />
<br />
* Create and index and check dependencies on a list of apk files: apk index -o APKINDEX.unsigned.tar.gz *.apk<br />
* Install a package: apk add iw OR apk add /path/to/iw-5.4-r0.apk<br />
* remove a package: apk del iw<br />
* repository lists are in: /etc/apk/repositories<br />
* Local URL: /media/mmcblk0p1/apks<br />
* Remote URL: http://dl-cdn.alpinelinux.org/alpine/v3.12/main<br />
<br />
[https://en.wikipedia.org/wiki/File_Allocation_Table FAT16/32 limits]<br><br />
[https://udhcp.busybox.net/README.udhcpc udhcpc]<br><br />
[https://linux.die.net/man/8/ez-ipupdate ez-ipupdate]<br><br />
[[Alpine_Linux:FAQ#Dynamic_DNS|Dynamic_DNS]]<br><br />
[[Bridge|Alpine Linux Bridge]]<br><br />
[[Connecting_to_a_wireless_access_point|Connect to wireless AP]]<br><br />
[https://unix.stackexchange.com/questions/222264/how-do-i-limit-dnsmasq-listening-to-only-one-interface dnsmasq listen restrictions]<br><br />
[https://wiki.archlinux.org/index.php/IPv6#Disable_IPv6 Disable IPV6]<br><br />
[https://github.com/imp/dnsmasq/blob/master/dnsmasq.conf.example dnsmasq Docs]<br><br />
[https://man.openbsd.org/hostapd.conf.5 HostApd Docs]<br><br />
[rsync://rsync.alpinelinux.org/alpine Alpine Repos]<br><br />
[https://stevessmarthomeguide.com/home-network-dns-dnsmasq Set Static DNS names]<br><br />
[https://unix.stackexchange.com/questions/504100/how-to-create-ssh-reverse-tunnel-with-iptables-forwarding Reverse SSH tunnel]<br><br />
===== Pi Specific =====<br />
[https://raspberrypi.stackexchange.com/questions/89803/access-point-as-wifi-router-repeater-optional-with-bridge/89804 Pi Wifi Repeater]<br><br />
[https://raspberrypi.stackexchange.com/questions/81486/raspberry-pi-wifi-to-ethernet-bridge-for-a-server/81518 WiFi Bridge]<br><br />
[[Raspberry_Pi|Alpine Install]]<br><br />
[[Raspberry_Pi_Zero_W_-_Installation|PiZeroW Install]]<br><br />
[[Classic_install_or_sys_mode_on_Raspberry_Pi|Classic Sys Install on Pi]]<br><br />
<br />
==== Not Related, but Interesting ====<br />
[https://blog.thewalr.us/2017/09/26/raspberry-pi-zero-w-simultaneous-ap-and-managed-mode-wifi AP and Managed Mode]<br><br />
[https://www.instructables.com/Using-a-Raspberry-PI-Zero-W-As-an-Access-Point-and AP and MQTT]<br><br />
<br />
==== Package List ====<br />
Put these in the apks/armhf directory on the 256M Fat partition:<br><br />
<br />
iptables-1.8.4-r2.apk openssh-8.3_p1-r1.apk<br />
iptables-openrc-1.8.4-r2.apk openssh-client-8.3_p1-r1.apk<br />
abuild-3.6.0-r1.apk iw-5.4-r0.apk openssh-keygen-8.3_p1-r1.apk<br />
alpine-base-3.12.3-r0.apk kbd-bkeymaps-2.2.0-r2.apk openssh-server-8.3_p1-r1.apk<br />
alpine-baselayout-3.2.0-r7.apk libacl-2.2.53-r0.apk openssh-server-common-8.3_p1-r1.apk<br />
alpine-conf-3.9.0-r1.apk libattr-2.4.48-r0.apk openssh-sftp-server-8.3_p1-r1.apk<br />
alpine-keys-2.2-r0.apk libblkid-2.35.2-r0.apk openssl-1.1.1i-r0.apk<br />
alpine-mirrors-3.5.10-r0.apk libc-utils-0.7.2-r3.apk patch-2.7.6-r6.apk<br />
apk-tools-2.10.5-r1.apk libcap-2.27-r0.apk pcsc-lite-libs-1.8.26-r0.apk<br />
attr-2.4.48-r0.apk libcom_err-1.45.6-r0.apk pkgconf-1.7.2-r0.apk<br />
bash-5.0.17-r0.apk libcrypto1.1-1.1.1i-r0.apk ppp-atm-2.4.8-r2.apk<br />
bash-completion-2.10-r0.apk libcurl-7.69.1-r3.apk ppp-chat-2.4.8-r2.apk<br />
bonding-2.6-r4.apk libedit-20191231.3.1-r0.apk ppp-daemon-2.4.8-r2.apk<br />
bridge-1.5-r4.apk libev-4.33-r0.apk ppp-l2tp-2.4.8-r2.apk<br />
bridge-utils-1.6-r0.apk libgcc-9.3.0-r2.apk ppp-minconn-2.4.8-r2.apk<br />
busybox-1.31.1-r19.apk libmnl-1.0.4-r0.apk ppp-passprompt-2.4.8-r2.apk<br />
busybox-extras-1.31.1-r19.apk libnftnl-1.1.6-r0.apk ppp-passwordfd-2.4.8-r2.apk<br />
busybox-initscripts-3.2-r2.apk libnftnl-libs-1.1.6-r0.apk ppp-pppoe-2.4.8-r2.apk<br />
busybox-suid-1.31.1-r19.apk libnl3-3.5.0-r0.apk ppp-radius-2.4.8-r2.apk<br />
c-ares-1.16.1-r0.apk libpcap-1.9.1-r2.apk ppp-winbind-2.4.8-r2.apk<br />
ca-certificates-20191127-r4.apk libssl1.1-1.1.1i-r0.apk readline-8.0.4-r0.apk<br />
ca-certificates-bundle-20191127-r4.apk libstdc++-9.3.0-r2.apk scanelf-1.2.6-r0.apk<br />
chrony-3.5.1-r0.apk libtls-standalone-2.9.1-r1.apk signature.tar.gz<br />
chrony-openrc-3.5.1-r0.apk libusb-1.0.23-r0.apk ssl_client-1.31.1-r19.apk<br />
curl-7.69.1-r3.apk libuuid-2.35.2-r0.apk tar-1.32-r1.apk<br />
dbus-libs-1.12.18-r0.apk lzip-1.21-r0.apk tcpdump-4.9.3-r2.apk<br />
dnsmasq-2.81-r0.apk mii-tool-1.60_git20140218-r2.apk tree-1.8.0-r0.apk<br />
e2fsprogs-1.45.6-r0.apk musl-1.1.24-r10.apk tzdata-2020c-r1.apk<br />
e2fsprogs-libs-1.45.6-r0.apk musl-utils-1.1.24-r10.apk usb-modeswitch-2.6.0-r1.apk<br />
ethtool-5.6-r0.apk ncurses-libs-6.2_p20200523-r0.apk vlan-2.2-r0.apk<br />
ez-ipupdate-3.0.10-r9.apk ncurses-terminfo-base-6.2_p20200523-r0.apk wireless-tools-30_pre9-r1.apk<br />
fakeroot-1.24-r0.apk net-tools-1.60_git20140218-r2.apk wpa_supplicant-2.9-r5.apk<br />
haveged-1.9.8-r1.apk network-extras-1.2-r0.apk wpa_supplicant-openrc-2.9-r5.apk<br />
haveged-openrc-1.9.8-r1.apk nghttp2-1.41.0-r0.apk zlib-1.2.11-r3.apk<br />
hostapd-2.9-r2.apk nghttp2-libs-1.41.0-r0.apk<br />
hostapd-openrc-2.9-r2.apk openrc-0.42.1-r11.apk</div>Rickyrockrathttps://wiki.alpinelinux.org/w/index.php?title=How_to_set_up_Alpine_as_a_wireless_router&diff=18455How to set up Alpine as a wireless router2021-01-03T13:46:25Z<p>Rickyrockrat: </p>
<hr />
<div>=== Pi Zero W Wireless Router ===<br />
<br />
This is a page to describe building a Wireless Access Point with two wired ethernet ports for building a home router that connects to the internet with one wired port, and internal Lan with the second wired port and the on-board WiFi.<br><br />
<br />
The intent is to provide this:<br><br />
<pre><br />
|<-->eth1 <-->| <br />
Internet <--> eth0 <-->FireWall<-->br0 Internal<--> ssh,bind,dhcp, with ssh reverse ssh connections.<br />
|<-->wlan0<-->|<br />
</pre><br />
=== Overview ===<br />
I generally run Debian and when forced by Red Hot Irons, Red Hat. This is my first foray into Alpine. So far I am very impressed. I mirrored the 3.12 armhf repos so I had things local when I needed them. Word to the wise. That is 13G of apk files.<br><br />
One *really* nice feature of Alpine is apk, the yum/apt replacement:<br><br />
* It is simple, short, and to the point.<br />
* The same tool provides *repo* level dependency reporting!<br />
* Install of single packages without repo signing (I never did get the signing correct, but I can install).<br />
<br />
=== Install ===<br />
* Find a microsd (or HDD) you can wipe. We will assume it is /dev/sdc.<br />
* make a 256M fat16 partition (sudo mkfs.vfat -n ALPBOOT /dev/sdc1)<br />
* the rest of the device can be ext2 (ext3/4 on HDD) (sudo mke2fs -m1 -L alext3 /dev/sdc2).<br />
* untar the alpine-rpi-3.12.3-armhf.tar.gz and copy all files to the fat16 partition which is good for up to 2G. <br />
* make sure you have all the packages from the package list below installed on the SD card. This will save you lots of time.<br />
* install openssh, openssh-server, openssh-client, openssh-server-common,<br />
* install dnsmasq, ethtool, hostapd*, busybox extras, iptables*, iw,net-tools, tree, wireless-tools.<br />
<br />
===== ssh config =====<br />
The allowed users are not normal names since I want the names to be a little obfuscated. Not that it really matters, since this is a key driven setup<br><br />
AddressFamily inet<br><br />
ListenAddress 0.0.0.0<br><br />
HostKey /etc/ssh/ssh_host_rsa_key<br><br />
LogLevel INFO<br><br />
LoginGraceTime 30<br><br />
PermitRootLogin no<br><br />
StrictModes yes<br><br />
AllowUsers Som123X Extern4524User<br><br />
PubkeyAuthentication yes<br><br />
AuthorizedKeysFile /etc/ssh/authorized_keys<br><br />
HostbasedAuthentication yes<br><br />
IgnoreUserKnownHosts yes<br><br />
IgnoreRhosts yes<br><br />
PasswordAuthentication no<br><br />
ChallengeResponseAuthentication no<br><br />
AllowTcpForwarding yes<br><br />
GatewayPorts yes<br><br />
X11Forwarding no<br><br />
<br />
<br />
===== dnsmasq.conf =====<br />
/etc/dnsmasq.conf<br><br />
This has two subnets. One for normal dhcp, the other for pseudo static - dhcp provided by MAC. One example here.<br><br />
interface=br0<br><br />
except-interface=eth0<br><br />
dhcp-range=subnet0,192.168.0.10,192.168.0.100,255.255.255.0,24h<br><br />
dhcp-range=subnet1,192.168.0.4,192.168.0.6,255.255.255.0,24h<br><br />
bind-interfaces<br><br />
#log-queries<br><br />
#log-dhcp<br><br />
dhcp-host=70:85:66:c4:48:55,192.168.0.4,nas<br><br />
<br />
===== /etc/hosts =====<br />
dnsmasq provides DNS answers from the hosts file. Nice. <br><br />
127.0.0.1 localhost localhost.localdomain<br><br />
::1 localhost localhost.localdomain<br><br />
192.168.0.3 wireless<br><br />
192.168.0.4 nas<br><br />
192.168.0.5 mpd<br><br />
<br />
===== hostapd.conf =====<br />
/etc/hostapd/hostapd.conf<br><br />
interface=wlan0<br><br />
bridge=br0<br><br />
hw_mode=g<br><br />
channel=7<br><br />
wmm_enabled=0<br><br />
macaddr_acl=0<br><br />
auth_algs=1<br><br />
ignore_broadcast_ssid=0<br><br />
wpa=2<br><br />
wpa_key_mgmt=WPA-PSK<br><br />
wpa_pairwise=TKIP<br><br />
rsn_pairwise=CCMP<br><br />
ssid=Whatever<br><br />
wpa_passphrase=YouMakeItUp<br><br />
<br />
===== interfaces =====<br />
/etc/network/interfaces<br><br />
auto lo<br><br />
iface lo inet loopback<br><br />
<br><br />
auto eth0<br><br />
iface eth0 inet dhcp<br><br />
hostname ANYNAME<br><br />
hwaddress ether FE:ED:BE:EF:33:DD<br><br />
<br><br />
iface eth1 inet manual<br><br />
iface wlan0 inet manual<br><br />
<br><br />
auto br0<br><br />
iface br0 inet static<br><br />
pre-up ifconfig eth1 up<br><br />
bridge-ports eth1 wlan0<br><br />
bridge-stp off<br><br />
address 192.168.0.3<br><br />
broadcaset 192.168.1.255<br><br />
netmask 255.255.255.0<br><br />
<br />
===== Permissive iptables =====<br />
Do NOT use this connected to the internet! This has no protection.<br><br />
This is my stopopen in my replacement iptables<br><br />
iptables -P INPUT ACCEPT<br><<br />
iptables -F INPUT<br><br />
iptables -P OUTPUT ACCEPT<br><br />
iptables -F OUTPUT<br><br />
iptables -P FORWARD ACCEPT<br><br />
iptables -F FORWARD<br><br />
iptables -F -t nat<br><br />
iptables -F<br><br />
<br />
=== References ===<br />
apk notes:<br />
<br />
* Create and index and check dependencies on a list of apk files: apk index -o APKINDEX.unsigned.tar.gz *.apk<br />
* Install a package: apk add iw OR apk add /path/to/iw-5.4-r0.apk<br />
* remove a package: apk del iw<br />
* repository lists are in: /etc/apk/repositories<br />
* Local URL: /media/mmcblk0p1/apks<br />
* Remote URL: http://dl-cdn.alpinelinux.org/alpine/v3.12/main<br />
<br />
[https://en.wikipedia.org/wiki/File_Allocation_Table FAT16/32 limits]<br><br />
[https://udhcp.busybox.net/README.udhcpc udhcpc]<br><br />
[https://linux.die.net/man/8/ez-ipupdate ez-ipupdate]<br><br />
[[Alpine_Linux:FAQ#Dynamic_DNS|Dynamic_DNS]]<br><br />
[[Bridge|Alpine Linux Bridge]]<br><br />
[[Connecting_to_a_wireless_access_point|Connect to wireless AP]]<br><br />
[https://unix.stackexchange.com/questions/222264/how-do-i-limit-dnsmasq-listening-to-only-one-interface dnsmasq listen restrictions]<br><br />
[https://wiki.archlinux.org/index.php/IPv6#Disable_IPv6 Disable IPV6]<br><br />
[https://github.com/imp/dnsmasq/blob/master/dnsmasq.conf.example dnsmasq Docs]<br><br />
[https://man.openbsd.org/hostapd.conf.5 HostApd Docs]<br><br />
[rsync://rsync.alpinelinux.org/alpine Alpine Repos]<br><br />
[https://stevessmarthomeguide.com/home-network-dns-dnsmasq Set Static DNS names]<br><br />
[https://unix.stackexchange.com/questions/504100/how-to-create-ssh-reverse-tunnel-with-iptables-forwarding Reverse SSH tunnel]<br><br />
===== Pi Specific =====<br />
[https://raspberrypi.stackexchange.com/questions/89803/access-point-as-wifi-router-repeater-optional-with-bridge/89804 Pi Wifi Repeater]<br><br />
[https://raspberrypi.stackexchange.com/questions/81486/raspberry-pi-wifi-to-ethernet-bridge-for-a-server/81518 WiFi Bridge]<br><br />
[[Raspberry_Pi|Alpine Install]]<br><br />
[[Raspberry_Pi_Zero_W_-_Installation|PiZeroW Install]]<br><br />
[[Classic_install_or_sys_mode_on_Raspberry_Pi|Classic Sys Install on Pi]]<br><br />
<br />
==== Not Related, but Interesting ====<br />
[https://blog.thewalr.us/2017/09/26/raspberry-pi-zero-w-simultaneous-ap-and-managed-mode-wifi AP and Managed Mode]<br><br />
[https://www.instructables.com/Using-a-Raspberry-PI-Zero-W-As-an-Access-Point-and AP and MQTT]<br><br />
<br />
==== Package List ====<br />
Put these in the apks/armhf directory on the 256M Fat partition:<br><br />
<br />
iptables-1.8.4-r2.apk openssh-8.3_p1-r1.apk<br />
iptables-openrc-1.8.4-r2.apk openssh-client-8.3_p1-r1.apk<br />
abuild-3.6.0-r1.apk iw-5.4-r0.apk openssh-keygen-8.3_p1-r1.apk<br />
alpine-base-3.12.3-r0.apk kbd-bkeymaps-2.2.0-r2.apk openssh-server-8.3_p1-r1.apk<br />
alpine-baselayout-3.2.0-r7.apk libacl-2.2.53-r0.apk openssh-server-common-8.3_p1-r1.apk<br />
alpine-conf-3.9.0-r1.apk libattr-2.4.48-r0.apk openssh-sftp-server-8.3_p1-r1.apk<br />
alpine-keys-2.2-r0.apk libblkid-2.35.2-r0.apk openssl-1.1.1i-r0.apk<br />
alpine-mirrors-3.5.10-r0.apk libc-utils-0.7.2-r3.apk patch-2.7.6-r6.apk<br />
apk-tools-2.10.5-r1.apk libcap-2.27-r0.apk pcsc-lite-libs-1.8.26-r0.apk<br />
attr-2.4.48-r0.apk libcom_err-1.45.6-r0.apk pkgconf-1.7.2-r0.apk<br />
bash-5.0.17-r0.apk libcrypto1.1-1.1.1i-r0.apk ppp-atm-2.4.8-r2.apk<br />
bash-completion-2.10-r0.apk libcurl-7.69.1-r3.apk ppp-chat-2.4.8-r2.apk<br />
bonding-2.6-r4.apk libedit-20191231.3.1-r0.apk ppp-daemon-2.4.8-r2.apk<br />
bridge-1.5-r4.apk libev-4.33-r0.apk ppp-l2tp-2.4.8-r2.apk<br />
bridge-utils-1.6-r0.apk libgcc-9.3.0-r2.apk ppp-minconn-2.4.8-r2.apk<br />
busybox-1.31.1-r19.apk libmnl-1.0.4-r0.apk ppp-passprompt-2.4.8-r2.apk<br />
busybox-extras-1.31.1-r19.apk libnftnl-1.1.6-r0.apk ppp-passwordfd-2.4.8-r2.apk<br />
busybox-initscripts-3.2-r2.apk libnftnl-libs-1.1.6-r0.apk ppp-pppoe-2.4.8-r2.apk<br />
busybox-suid-1.31.1-r19.apk libnl3-3.5.0-r0.apk ppp-radius-2.4.8-r2.apk<br />
c-ares-1.16.1-r0.apk libpcap-1.9.1-r2.apk ppp-winbind-2.4.8-r2.apk<br />
ca-certificates-20191127-r4.apk libssl1.1-1.1.1i-r0.apk readline-8.0.4-r0.apk<br />
ca-certificates-bundle-20191127-r4.apk libstdc++-9.3.0-r2.apk scanelf-1.2.6-r0.apk<br />
chrony-3.5.1-r0.apk libtls-standalone-2.9.1-r1.apk signature.tar.gz<br />
chrony-openrc-3.5.1-r0.apk libusb-1.0.23-r0.apk ssl_client-1.31.1-r19.apk<br />
curl-7.69.1-r3.apk libuuid-2.35.2-r0.apk tar-1.32-r1.apk<br />
dbus-libs-1.12.18-r0.apk lzip-1.21-r0.apk tcpdump-4.9.3-r2.apk<br />
dnsmasq-2.81-r0.apk mii-tool-1.60_git20140218-r2.apk tree-1.8.0-r0.apk<br />
e2fsprogs-1.45.6-r0.apk musl-1.1.24-r10.apk tzdata-2020c-r1.apk<br />
e2fsprogs-libs-1.45.6-r0.apk musl-utils-1.1.24-r10.apk usb-modeswitch-2.6.0-r1.apk<br />
ethtool-5.6-r0.apk ncurses-libs-6.2_p20200523-r0.apk vlan-2.2-r0.apk<br />
ez-ipupdate-3.0.10-r9.apk ncurses-terminfo-base-6.2_p20200523-r0.apk wireless-tools-30_pre9-r1.apk<br />
fakeroot-1.24-r0.apk net-tools-1.60_git20140218-r2.apk wpa_supplicant-2.9-r5.apk<br />
haveged-1.9.8-r1.apk network-extras-1.2-r0.apk wpa_supplicant-openrc-2.9-r5.apk<br />
haveged-openrc-1.9.8-r1.apk nghttp2-1.41.0-r0.apk zlib-1.2.11-r3.apk<br />
hostapd-2.9-r2.apk nghttp2-libs-1.41.0-r0.apk<br />
hostapd-openrc-2.9-r2.apk openrc-0.42.1-r11.apk</div>Rickyrockrathttps://wiki.alpinelinux.org/w/index.php?title=How_to_set_up_Alpine_as_a_wireless_router&diff=18452How to set up Alpine as a wireless router2021-01-03T13:06:09Z<p>Rickyrockrat: </p>
<hr />
<div>=== Pi Zero W Wireless Router ===<br />
<br />
This is a page to describe building a Wireless Access Point with two wired ethernet ports for building a home router that connects to the internet with one wired port, and internal Lan with the second wired port and the on-board WiFi.<br><br />
<br />
The intent is to provide this:<br><br />
<pre><br />
|<-->eth1 <-->| <br />
Internet <--> eth0 <-->FireWall<-->br0 Internal<--> ssh,bind,dhcp, with ssh reverse ssh connections.<br />
|<-->wlan0<-->|<br />
</pre><br />
=== Overview ===<br />
I generally run Debian and when forced by Red Hot Irons, Red Hat. This is my first foray into Alpine. So far I am very impressed. I mirrored the 3.12 armhf repos so I had things local when I needed them. Word to the wise. That is 13G of apk files.<br><br />
One *really* nice feature of Alpine is apk, the yum/apt replacement:<br><br />
* It is simple, short, and to the point.<br />
* The same tool provides *repo* level dependency reporting!<br />
* Install of single packages without repo signing (I never did get the signing correct, but I can install).<br />
<br />
=== Install ===<br />
* Find a microsd (or HDD) you can wipe. We will assume it is /dev/sdc.<br />
* make a 256M fat16 partition (sudo mkfs.vfat -n ALPBOOT /dev/sdc1)<br />
* the rest of the device can be ext2 (ext3/4 on HDD) (sudo mke2fs -m1 -L alext3 /dev/sdc2).<br />
* untar the alpine-rpi-3.12.3-armhf.tar.gz and copy all files to the fat16 partition which is good for up to 2G. <br />
* make sure you have all the packages from the package list below installed on the SD card. This will save you lots of time.<br />
* install openssh, openssh-server, openssh-client, openssh-server-common,<br />
* install dnsmasq, ethtool, hostapd*, busybox extras, iptables*, iw,net-tools, tree, wireless-tools.<br />
<br />
===== ssh config =====<br />
The allowed users are not normal names since I want the names to be a little obfuscated. Not that it really matters, since this is a key driven setup<br><br />
AddressFamily inet<br><br />
ListenAddress 0.0.0.0<br><br />
HostKey /etc/ssh/ssh_host_rsa_key<br><br />
LogLevel INFO<br><br />
LoginGraceTime 30<br><br />
PermitRootLogin no<br><br />
StrictModes yes<br><br />
AllowUsers Som123X Extern4524User<br><br />
PubkeyAuthentication yes<br><br />
AuthorizedKeysFile /etc/ssh/authorized_keys<br><br />
HostbasedAuthentication yes<br><br />
IgnoreUserKnownHosts yes<br><br />
IgnoreRhosts yes<br><br />
PasswordAuthentication no<br><br />
ChallengeResponseAuthentication no<br><br />
AllowTcpForwarding yes<br><br />
GatewayPorts yes<br><br />
X11Forwarding no<br><br />
<br />
===== dnsmasq.conf =====<br />
/etc/dnsmasq.conf<br><br />
interface=br0<br><br />
except-interface=eth0<br><br />
dhcp-range=192.168.0.10,192.168.0.100,255.255.255.0,24h<br><br />
bind-interfaces<br><br />
#log-queries<br><br />
#log-dhcp<br><br />
<br />
===== hostapd.conf =====<br />
/etc/hostapd/hostapd.conf<br><br />
interface=wlan0<br><br />
bridge=br0<br><br />
hw_mode=g<br><br />
channel=7<br><br />
wmm_enabled=0<br><br />
macaddr_acl=0<br><br />
auth_algs=1<br><br />
ignore_broadcast_ssid=0<br><br />
wpa=2<br><br />
wpa_key_mgmt=WPA-PSK<br><br />
wpa_pairwise=TKIP<br><br />
rsn_pairwise=CCMP<br><br />
ssid=Whatever<br><br />
wpa_passphrase=YouMakeItUp<br><br />
<br />
===== interfaces =====<br />
/etc/network/interfaces<br><br />
auto lo<br><br />
iface lo inet loopback<br><br />
<br><br />
auto eth0<br><br />
iface eth0 inet dhcp<br><br />
hostname ANYNAME<br><br />
hwaddress ether FE:ED:BE:EF:33:DD<br><br />
<br><br />
iface eth1 inet manual<br><br />
iface wlan0 inet manual<br><br />
<br><br />
auto br0<br><br />
iface br0 inet static<br><br />
pre-up ifconfig eth1 up<br><br />
bridge-ports eth1 wlan0<br><br />
bridge-stp off<br><br />
address 192.168.0.3<br><br />
broadcaset 192.168.1.255<br><br />
netmask 255.255.255.0<br><br />
<br />
===== Permissive iptables =====<br />
Do NOT use this connected to the internet! This has no protection.<br><br />
This is my stopopen in my replacement iptables<br><br />
iptables -P INPUT ACCEPT<br><<br />
iptables -F INPUT<br><br />
iptables -P OUTPUT ACCEPT<br><br />
iptables -F OUTPUT<br><br />
iptables -P FORWARD ACCEPT<br><br />
iptables -F FORWARD<br><br />
iptables -F -t nat<br><br />
iptables -F<br><br />
<br />
=== References ===<br />
apk notes:<br />
<br />
* Create and index and check dependencies on a list of apk files: apk index -o APKINDEX.unsigned.tar.gz *.apk<br />
* Install a package: apk add iw OR apk add /path/to/iw-5.4-r0.apk<br />
* remove a package: apk del iw<br />
* repository lists are in: /etc/apk/repositories<br />
* Local URL: /media/mmcblk0p1/apks<br />
* Remote URL: http://dl-cdn.alpinelinux.org/alpine/v3.12/main<br />
<br />
[https://en.wikipedia.org/wiki/File_Allocation_Table FAT16/32 limits]<br><br />
[https://udhcp.busybox.net/README.udhcpc udhcpc]<br><br />
[https://linux.die.net/man/8/ez-ipupdate ez-ipupdate]<br><br />
[[Alpine_Linux:FAQ#Dynamic_DNS|Dynamic_DNS]]<br><br />
[[Bridge|Alpine Linux Bridge]]<br><br />
[[Connecting_to_a_wireless_access_point|Connect to wireless AP]]<br><br />
[https://unix.stackexchange.com/questions/222264/how-do-i-limit-dnsmasq-listening-to-only-one-interface dnsmasq listen restrictions]<br><br />
[https://wiki.archlinux.org/index.php/IPv6#Disable_IPv6 Disable IPV6]<br><br />
[https://github.com/imp/dnsmasq/blob/master/dnsmasq.conf.example dnsmasq Docs]<br><br />
[https://man.openbsd.org/hostapd.conf.5 HostApd Docs]<br><br />
[rsync://rsync.alpinelinux.org/alpine Alpine Repos]<br><br />
[https://stevessmarthomeguide.com/home-network-dns-dnsmasq Set Static DNS names]<br><br />
[https://unix.stackexchange.com/questions/504100/how-to-create-ssh-reverse-tunnel-with-iptables-forwarding Reverse SSH tunnel]<br><br />
===== Pi Specific =====<br />
[https://raspberrypi.stackexchange.com/questions/89803/access-point-as-wifi-router-repeater-optional-with-bridge/89804 Pi Wifi Repeater]<br><br />
[https://raspberrypi.stackexchange.com/questions/81486/raspberry-pi-wifi-to-ethernet-bridge-for-a-server/81518 WiFi Bridge]<br><br />
[[Raspberry_Pi|Alpine Install]]<br><br />
[[Raspberry_Pi_Zero_W_-_Installation|PiZeroW Install]]<br><br />
[[Classic_install_or_sys_mode_on_Raspberry_Pi|Classic Sys Install on Pi]]<br><br />
<br />
==== Not Related, but Interesting ====<br />
[https://blog.thewalr.us/2017/09/26/raspberry-pi-zero-w-simultaneous-ap-and-managed-mode-wifi AP and Managed Mode]<br><br />
[https://www.instructables.com/Using-a-Raspberry-PI-Zero-W-As-an-Access-Point-and AP and MQTT]<br><br />
<br />
==== Package List ====<br />
Put these in the apks/armhf directory on the 256M Fat partition:<br><br />
<br />
iptables-1.8.4-r2.apk openssh-8.3_p1-r1.apk<br />
iptables-openrc-1.8.4-r2.apk openssh-client-8.3_p1-r1.apk<br />
abuild-3.6.0-r1.apk iw-5.4-r0.apk openssh-keygen-8.3_p1-r1.apk<br />
alpine-base-3.12.3-r0.apk kbd-bkeymaps-2.2.0-r2.apk openssh-server-8.3_p1-r1.apk<br />
alpine-baselayout-3.2.0-r7.apk libacl-2.2.53-r0.apk openssh-server-common-8.3_p1-r1.apk<br />
alpine-conf-3.9.0-r1.apk libattr-2.4.48-r0.apk openssh-sftp-server-8.3_p1-r1.apk<br />
alpine-keys-2.2-r0.apk libblkid-2.35.2-r0.apk openssl-1.1.1i-r0.apk<br />
alpine-mirrors-3.5.10-r0.apk libc-utils-0.7.2-r3.apk patch-2.7.6-r6.apk<br />
apk-tools-2.10.5-r1.apk libcap-2.27-r0.apk pcsc-lite-libs-1.8.26-r0.apk<br />
attr-2.4.48-r0.apk libcom_err-1.45.6-r0.apk pkgconf-1.7.2-r0.apk<br />
bash-5.0.17-r0.apk libcrypto1.1-1.1.1i-r0.apk ppp-atm-2.4.8-r2.apk<br />
bash-completion-2.10-r0.apk libcurl-7.69.1-r3.apk ppp-chat-2.4.8-r2.apk<br />
bonding-2.6-r4.apk libedit-20191231.3.1-r0.apk ppp-daemon-2.4.8-r2.apk<br />
bridge-1.5-r4.apk libev-4.33-r0.apk ppp-l2tp-2.4.8-r2.apk<br />
bridge-utils-1.6-r0.apk libgcc-9.3.0-r2.apk ppp-minconn-2.4.8-r2.apk<br />
busybox-1.31.1-r19.apk libmnl-1.0.4-r0.apk ppp-passprompt-2.4.8-r2.apk<br />
busybox-extras-1.31.1-r19.apk libnftnl-1.1.6-r0.apk ppp-passwordfd-2.4.8-r2.apk<br />
busybox-initscripts-3.2-r2.apk libnftnl-libs-1.1.6-r0.apk ppp-pppoe-2.4.8-r2.apk<br />
busybox-suid-1.31.1-r19.apk libnl3-3.5.0-r0.apk ppp-radius-2.4.8-r2.apk<br />
c-ares-1.16.1-r0.apk libpcap-1.9.1-r2.apk ppp-winbind-2.4.8-r2.apk<br />
ca-certificates-20191127-r4.apk libssl1.1-1.1.1i-r0.apk readline-8.0.4-r0.apk<br />
ca-certificates-bundle-20191127-r4.apk libstdc++-9.3.0-r2.apk scanelf-1.2.6-r0.apk<br />
chrony-3.5.1-r0.apk libtls-standalone-2.9.1-r1.apk signature.tar.gz<br />
chrony-openrc-3.5.1-r0.apk libusb-1.0.23-r0.apk ssl_client-1.31.1-r19.apk<br />
curl-7.69.1-r3.apk libuuid-2.35.2-r0.apk tar-1.32-r1.apk<br />
dbus-libs-1.12.18-r0.apk lzip-1.21-r0.apk tcpdump-4.9.3-r2.apk<br />
dnsmasq-2.81-r0.apk mii-tool-1.60_git20140218-r2.apk tree-1.8.0-r0.apk<br />
e2fsprogs-1.45.6-r0.apk musl-1.1.24-r10.apk tzdata-2020c-r1.apk<br />
e2fsprogs-libs-1.45.6-r0.apk musl-utils-1.1.24-r10.apk usb-modeswitch-2.6.0-r1.apk<br />
ethtool-5.6-r0.apk ncurses-libs-6.2_p20200523-r0.apk vlan-2.2-r0.apk<br />
ez-ipupdate-3.0.10-r9.apk ncurses-terminfo-base-6.2_p20200523-r0.apk wireless-tools-30_pre9-r1.apk<br />
fakeroot-1.24-r0.apk net-tools-1.60_git20140218-r2.apk wpa_supplicant-2.9-r5.apk<br />
haveged-1.9.8-r1.apk network-extras-1.2-r0.apk wpa_supplicant-openrc-2.9-r5.apk<br />
haveged-openrc-1.9.8-r1.apk nghttp2-1.41.0-r0.apk zlib-1.2.11-r3.apk<br />
hostapd-2.9-r2.apk nghttp2-libs-1.41.0-r0.apk<br />
hostapd-openrc-2.9-r2.apk openrc-0.42.1-r11.apk</div>Rickyrockrathttps://wiki.alpinelinux.org/w/index.php?title=How_to_set_up_Alpine_as_a_wireless_router&diff=18451How to set up Alpine as a wireless router2021-01-03T12:52:11Z<p>Rickyrockrat: </p>
<hr />
<div>=== Pi Zero W Wireless Router ===<br />
<br />
This is a page to describe building a Wireless Access Point with two wired ethernet ports for building a home router that connects to the internet with one wired port, and internal Lan with the second wired port and the on-board WiFi.<br><br />
<br />
The intent is to provide this:<br><br />
<pre><br />
|<-->eth1 <-->| <br />
Internet <--> eth0 <-->FireWall<-->br0 Internal<--> ssh,bind,dhcp, with ssh reverse ssh connections.<br />
|<-->wlan0<-->|<br />
</pre><br />
=== Overview ===<br />
I generally run Debian and when forced by Red Hot Irons, Red Hat. This is my first foray into Alpine. So far I am very impressed. I mirrored the 3.12 armhf repos so I had things local when I needed them. Word to the wise. That is 13G of apk files.<br><br />
One *really* nice feature of Alpine is apk, the yum/apt replacement:<br><br />
* It is simple, short, and to the point.<br />
* The same tool provides *repo* level dependency reporting!<br />
* Install of single packages without repo signing (I never did get the signing correct, but I can install).<br />
<br />
=== Install ===<br />
* Find a microsd (or HDD) you can wipe. We will assume it is /dev/sdc.<br />
* make a 256M fat16 partition (sudo mkfs.vfat -n ALPBOOT /dev/sdc1)<br />
* the rest of the device can be ext2 (ext3/4 on HDD) (sudo mke2fs -m1 -L alext3 /dev/sdc2).<br />
* untar the alpine-rpi-3.12.3-armhf.tar.gz and copy all files to the fat16 partition which is good for up to 2G. <br />
* make sure you have all the packages from the package list below installed on the SD card. This will save you lots of time.<br />
* install openssh, openssh-server, openssh-client, openssh-server-common,<br />
* install dnsmasq, ethtool, hostapd*, busybox extras, iptables*, iw,net-tools, tree, wireless-tools.<br />
<br />
===== ssh config =====<br />
The allowed users are not normal names since I want the names to be a little obfuscated. Not that it really matters, since this is a key driven setup<br><br />
AddressFamily inet<br><br />
ListenAddress 0.0.0.0<br><br />
HostKey /etc/ssh/ssh_host_rsa_key<br><br />
LogLevel INFO<br><br />
LoginGraceTime 30<br><br />
PermitRootLogin no<br><br />
StrictModes yes<br><br />
AllowUsers Som123X Extern4524User<br><br />
PubkeyAuthentication yes<br><br />
AuthorizedKeysFile /etc/ssh/authorized_keys<br><br />
HostbasedAuthentication yes<br><br />
IgnoreUserKnownHosts yes<br><br />
IgnoreRhosts yes<br><br />
PasswordAuthentication no<br><br />
ChallengeResponseAuthentication no<br><br />
AllowTcpForwarding yes<br><br />
GatewayPorts yes<br><br />
X11Forwarding no<br><br />
<br />
===== dnsmasq.conf =====<br />
/etc/dnsmasq.conf<br><br />
interface=br0<br><br />
except-interface=eth0<br><br />
dhcp-range=192.168.0.10,192.168.0.100,255.255.255.0,24h<br><br />
bind-interfaces<br><br />
#log-queries<br><br />
#log-dhcp<br><br />
<br />
===== hostapd.conf =====<br />
/etc/hostapd/hostapd.conf<br><br />
interface=wlan0<br><br />
bridge=br0<br><br />
hw_mode=g<br><br />
channel=7<br><br />
wmm_enabled=0<br><br />
macaddr_acl=0<br><br />
auth_algs=1<br><br />
ignore_broadcast_ssid=0<br><br />
wpa=2<br><br />
wpa_key_mgmt=WPA-PSK<br><br />
wpa_pairwise=TKIP<br><br />
rsn_pairwise=CCMP<br><br />
ssid=Whatever<br><br />
wpa_passphrase=YouMakeItUp<br><br />
<br />
===== interfaces =====<br />
/etc/network/interfaces<br><br />
auto lo<br><br />
iface lo inet loopback<br><br />
<br><br />
auto eth0<br><br />
iface eth0 inet dhcp<br><br />
hostname ANYNAME<br><br />
hwaddress ether FE:ED:BE:EF:33:DD<br><br />
<br><br />
iface eth1 inet manual<br><br />
iface wlan0 inet manual<br><br />
<br><br />
auto br0<br><br />
iface br0 inet static<br><br />
pre-up ifconfig eth1 up<br><br />
bridge-ports eth1 wlan0<br><br />
bridge-stp off<br><br />
address 192.168.0.3<br><br />
broadcaset 192.168.1.255<br><br />
netmask 255.255.255.0<br><br />
<br />
==== References ====<br />
apk notes:<br />
<br />
* Create and index and check dependencies on a list of apk files: apk index -o APKINDEX.unsigned.tar.gz *.apk<br />
* Install a package: apk add iw OR apk add /path/to/iw-5.4-r0.apk<br />
* remove a package: apk del iw<br />
* repository lists are in: /etc/apk/repositories<br />
* Local URL: /media/mmcblk0p1/apks<br />
* Remote URL: http://dl-cdn.alpinelinux.org/alpine/v3.12/main<br />
<br />
[https://en.wikipedia.org/wiki/File_Allocation_Table FAT16/32 limits]<br><br />
[https://udhcp.busybox.net/README.udhcpc udhcpc]<br><br />
[https://linux.die.net/man/8/ez-ipupdate ez-ipupdate]<br><br />
[[Alpine_Linux:FAQ#Dynamic_DNS|Dynamic_DNS]]<br><br />
[[Bridge|Alpine Linux Bridge]]<br><br />
[[Connecting_to_a_wireless_access_point|Connect to wireless AP]]<br><br />
[https://unix.stackexchange.com/questions/222264/how-do-i-limit-dnsmasq-listening-to-only-one-interface dnsmasq listen restrictions]<br><br />
[https://wiki.archlinux.org/index.php/IPv6#Disable_IPv6 Disable IPV6]<br><br />
[https://github.com/imp/dnsmasq/blob/master/dnsmasq.conf.example dnsmasq Docs]<br><br />
[https://man.openbsd.org/hostapd.conf.5 HostApd Docs]<br><br />
[rsync://rsync.alpinelinux.org/alpine Alpine Repos]<br><br />
[https://stevessmarthomeguide.com/home-network-dns-dnsmasq Set Static DNS names]<br><br />
[https://unix.stackexchange.com/questions/504100/how-to-create-ssh-reverse-tunnel-with-iptables-forwarding Reverse SSH tunnel]<br><br />
===== Pi Specific =====<br />
[https://raspberrypi.stackexchange.com/questions/89803/access-point-as-wifi-router-repeater-optional-with-bridge/89804 Pi Wifi Repeater]<br><br />
[https://raspberrypi.stackexchange.com/questions/81486/raspberry-pi-wifi-to-ethernet-bridge-for-a-server/81518 WiFi Bridge]<br><br />
[[Raspberry_Pi|Alpine Install]]<br><br />
[[Raspberry_Pi_Zero_W_-_Installation|PiZeroW Install]]<br><br />
[[Classic_install_or_sys_mode_on_Raspberry_Pi|Classic Sys Install on Pi]]<br><br />
<br />
==== Not Related, but Interesting ====<br />
[https://blog.thewalr.us/2017/09/26/raspberry-pi-zero-w-simultaneous-ap-and-managed-mode-wifi AP and Managed Mode]<br><br />
[https://www.instructables.com/Using-a-Raspberry-PI-Zero-W-As-an-Access-Point-and AP and MQTT]<br><br />
<br />
==== Package List ====<br />
Put these in the apks/armhf directory on the 256M Fat partition:<br><br />
<br />
iptables-1.8.4-r2.apk openssh-8.3_p1-r1.apk<br />
iptables-openrc-1.8.4-r2.apk openssh-client-8.3_p1-r1.apk<br />
abuild-3.6.0-r1.apk iw-5.4-r0.apk openssh-keygen-8.3_p1-r1.apk<br />
alpine-base-3.12.3-r0.apk kbd-bkeymaps-2.2.0-r2.apk openssh-server-8.3_p1-r1.apk<br />
alpine-baselayout-3.2.0-r7.apk libacl-2.2.53-r0.apk openssh-server-common-8.3_p1-r1.apk<br />
alpine-conf-3.9.0-r1.apk libattr-2.4.48-r0.apk openssh-sftp-server-8.3_p1-r1.apk<br />
alpine-keys-2.2-r0.apk libblkid-2.35.2-r0.apk openssl-1.1.1i-r0.apk<br />
alpine-mirrors-3.5.10-r0.apk libc-utils-0.7.2-r3.apk patch-2.7.6-r6.apk<br />
apk-tools-2.10.5-r1.apk libcap-2.27-r0.apk pcsc-lite-libs-1.8.26-r0.apk<br />
attr-2.4.48-r0.apk libcom_err-1.45.6-r0.apk pkgconf-1.7.2-r0.apk<br />
bash-5.0.17-r0.apk libcrypto1.1-1.1.1i-r0.apk ppp-atm-2.4.8-r2.apk<br />
bash-completion-2.10-r0.apk libcurl-7.69.1-r3.apk ppp-chat-2.4.8-r2.apk<br />
bonding-2.6-r4.apk libedit-20191231.3.1-r0.apk ppp-daemon-2.4.8-r2.apk<br />
bridge-1.5-r4.apk libev-4.33-r0.apk ppp-l2tp-2.4.8-r2.apk<br />
bridge-utils-1.6-r0.apk libgcc-9.3.0-r2.apk ppp-minconn-2.4.8-r2.apk<br />
busybox-1.31.1-r19.apk libmnl-1.0.4-r0.apk ppp-passprompt-2.4.8-r2.apk<br />
busybox-extras-1.31.1-r19.apk libnftnl-1.1.6-r0.apk ppp-passwordfd-2.4.8-r2.apk<br />
busybox-initscripts-3.2-r2.apk libnftnl-libs-1.1.6-r0.apk ppp-pppoe-2.4.8-r2.apk<br />
busybox-suid-1.31.1-r19.apk libnl3-3.5.0-r0.apk ppp-radius-2.4.8-r2.apk<br />
c-ares-1.16.1-r0.apk libpcap-1.9.1-r2.apk ppp-winbind-2.4.8-r2.apk<br />
ca-certificates-20191127-r4.apk libssl1.1-1.1.1i-r0.apk readline-8.0.4-r0.apk<br />
ca-certificates-bundle-20191127-r4.apk libstdc++-9.3.0-r2.apk scanelf-1.2.6-r0.apk<br />
chrony-3.5.1-r0.apk libtls-standalone-2.9.1-r1.apk signature.tar.gz<br />
chrony-openrc-3.5.1-r0.apk libusb-1.0.23-r0.apk ssl_client-1.31.1-r19.apk<br />
curl-7.69.1-r3.apk libuuid-2.35.2-r0.apk tar-1.32-r1.apk<br />
dbus-libs-1.12.18-r0.apk lzip-1.21-r0.apk tcpdump-4.9.3-r2.apk<br />
dnsmasq-2.81-r0.apk mii-tool-1.60_git20140218-r2.apk tree-1.8.0-r0.apk<br />
e2fsprogs-1.45.6-r0.apk musl-1.1.24-r10.apk tzdata-2020c-r1.apk<br />
e2fsprogs-libs-1.45.6-r0.apk musl-utils-1.1.24-r10.apk usb-modeswitch-2.6.0-r1.apk<br />
ethtool-5.6-r0.apk ncurses-libs-6.2_p20200523-r0.apk vlan-2.2-r0.apk<br />
ez-ipupdate-3.0.10-r9.apk ncurses-terminfo-base-6.2_p20200523-r0.apk wireless-tools-30_pre9-r1.apk<br />
fakeroot-1.24-r0.apk net-tools-1.60_git20140218-r2.apk wpa_supplicant-2.9-r5.apk<br />
haveged-1.9.8-r1.apk network-extras-1.2-r0.apk wpa_supplicant-openrc-2.9-r5.apk<br />
haveged-openrc-1.9.8-r1.apk nghttp2-1.41.0-r0.apk zlib-1.2.11-r3.apk<br />
hostapd-2.9-r2.apk nghttp2-libs-1.41.0-r0.apk<br />
hostapd-openrc-2.9-r2.apk openrc-0.42.1-r11.apk</div>Rickyrockrathttps://wiki.alpinelinux.org/w/index.php?title=How_to_set_up_Alpine_as_a_wireless_router&diff=18450How to set up Alpine as a wireless router2021-01-03T12:43:47Z<p>Rickyrockrat: </p>
<hr />
<div>=== Pi Zero W Wireless Router ===<br />
<br />
This is a page to describe building a Wireless Access Point with two wired ethernet ports for building a home router that connects to the internet with one wired port, and internal Lan with the second wired port and the on-board WiFi.<br><br />
<br />
The intent is to provide this:<br><br />
<pre><br />
|<-->eth1 <-->| <br />
Internet <--> eth0 <-->FireWall<-->br0 Internal<--> ssh,bind,dhcp, with ssh reverse ssh connections.<br />
|<-->wlan0<-->|<br />
</pre><br />
=== Overview ===<br />
I generally run Debian and when forced by Red Hot Irons, Red Hat. This is my first foray into Alpine. So far I am very impressed. I mirrored the 3.12 armhf repos so I had things local when I needed them. Word to the wise. That is 13G of apk files.<br><br />
One *really* nice feature of Alpine is apk, the yum/apt replacement:<br><br />
* It is simple, short, and to the point.<br />
* The same tool provides *repo* level dependency reporting!<br />
* Install of single packages without repo signing (I never did get the signing correct, but I can install).<br />
<br />
=== Install ===<br />
* Find a microsd (or HDD) you can wipe. We will assume it is /dev/sdc.<br />
* make a 256M fat16 partition (sudo mkfs.vfat -n ALPBOOT /dev/sdc1)<br />
* the rest of the device can be ext2 (ext3/4 on HDD) (sudo mke2fs -m1 -L alext3 /dev/sdc2).<br />
* untar the alpine-rpi-3.12.3-armhf.tar.gz and copy all files to the fat16 partition which is good for up to 2G. <br />
* make sure you have all the packages from the package list below installed on the SD card. This will save you lots of time.<br />
* install openssh, openssh-server, openssh-client, openssh-server-common,<br />
* install dnsmasq, ethtool, hostapd*, busybox extras, iptables*, iw,net-tools, tree, wireless-tools.<br />
<br />
===== ssh config =====<br />
The allowed users are not normal names since I want the names to be a little obfuscated. Not that it really matters, since this is a key driven setup<br><br />
AddressFamily inet<br><br />
ListenAddress 0.0.0.0<br><br />
HostKey /etc/ssh/ssh_host_rsa_key<br><br />
LogLevel INFO<br><br />
LoginGraceTime 30<br><br />
PermitRootLogin no<br><br />
StrictModes yes<br><br />
AllowUsers Som123X Extern4524User<br><br />
PubkeyAuthentication yes<br><br />
AuthorizedKeysFile /etc/ssh/authorized_keys<br><br />
HostbasedAuthentication yes<br><br />
IgnoreUserKnownHosts yes<br><br />
IgnoreRhosts yes<br><br />
PasswordAuthentication no<br><br />
ChallengeResponseAuthentication no<br><br />
AllowTcpForwarding yes<br><br />
GatewayPorts yes<br><br />
X11Forwarding no<br><br />
<br />
==== References ====<br />
apk notes:<br />
<br />
* Create and index and check dependencies on a list of apk files: apk index -o APKINDEX.unsigned.tar.gz *.apk<br />
* Install a package: apk add iw OR apk add /path/to/iw-5.4-r0.apk<br />
* remove a package: apk del iw<br />
* repository lists are in: /etc/apk/repositories<br />
* Local URL: /media/mmcblk0p1/apks<br />
* Remote URL: http://dl-cdn.alpinelinux.org/alpine/v3.12/main<br />
<br />
[https://en.wikipedia.org/wiki/File_Allocation_Table FAT16/32 limits]<br><br />
[https://udhcp.busybox.net/README.udhcpc udhcpc]<br><br />
[https://linux.die.net/man/8/ez-ipupdate ez-ipupdate]<br><br />
[[Alpine_Linux:FAQ#Dynamic_DNS|Dynamic_DNS]]<br><br />
[[Bridge|Alpine Linux Bridge]]<br><br />
[[Connecting_to_a_wireless_access_point|Connect to wireless AP]]<br><br />
[https://unix.stackexchange.com/questions/222264/how-do-i-limit-dnsmasq-listening-to-only-one-interface dnsmasq listen restrictions]<br><br />
[https://wiki.archlinux.org/index.php/IPv6#Disable_IPv6 Disable IPV6]<br><br />
[https://github.com/imp/dnsmasq/blob/master/dnsmasq.conf.example dnsmasq Docs]<br><br />
[https://man.openbsd.org/hostapd.conf.5 HostApd Docs]<br><br />
[rsync://rsync.alpinelinux.org/alpine Alpine Repos]<br><br />
[https://stevessmarthomeguide.com/home-network-dns-dnsmasq Set Static DNS names]<br><br />
[https://unix.stackexchange.com/questions/504100/how-to-create-ssh-reverse-tunnel-with-iptables-forwarding Reverse SSH tunnel]<br><br />
===== Pi Specific =====<br />
[https://raspberrypi.stackexchange.com/questions/89803/access-point-as-wifi-router-repeater-optional-with-bridge/89804 Pi Wifi Repeater]<br><br />
[https://raspberrypi.stackexchange.com/questions/81486/raspberry-pi-wifi-to-ethernet-bridge-for-a-server/81518 WiFi Bridge]<br><br />
[[Raspberry_Pi|Alpine Install]]<br><br />
[[Raspberry_Pi_Zero_W_-_Installation|PiZeroW Install]]<br><br />
[[Classic_install_or_sys_mode_on_Raspberry_Pi|Classic Sys Install on Pi]]<br><br />
<br />
==== Not Related, but Interesting ====<br />
[https://blog.thewalr.us/2017/09/26/raspberry-pi-zero-w-simultaneous-ap-and-managed-mode-wifi AP and Managed Mode]<br><br />
[https://www.instructables.com/Using-a-Raspberry-PI-Zero-W-As-an-Access-Point-and AP and MQTT]<br><br />
<br />
==== Package List ====<br />
Put these in the apks/armhf directory on the 256M Fat partition:<br><br />
<br />
iptables-1.8.4-r2.apk openssh-8.3_p1-r1.apk<br />
iptables-openrc-1.8.4-r2.apk openssh-client-8.3_p1-r1.apk<br />
abuild-3.6.0-r1.apk iw-5.4-r0.apk openssh-keygen-8.3_p1-r1.apk<br />
alpine-base-3.12.3-r0.apk kbd-bkeymaps-2.2.0-r2.apk openssh-server-8.3_p1-r1.apk<br />
alpine-baselayout-3.2.0-r7.apk libacl-2.2.53-r0.apk openssh-server-common-8.3_p1-r1.apk<br />
alpine-conf-3.9.0-r1.apk libattr-2.4.48-r0.apk openssh-sftp-server-8.3_p1-r1.apk<br />
alpine-keys-2.2-r0.apk libblkid-2.35.2-r0.apk openssl-1.1.1i-r0.apk<br />
alpine-mirrors-3.5.10-r0.apk libc-utils-0.7.2-r3.apk patch-2.7.6-r6.apk<br />
apk-tools-2.10.5-r1.apk libcap-2.27-r0.apk pcsc-lite-libs-1.8.26-r0.apk<br />
attr-2.4.48-r0.apk libcom_err-1.45.6-r0.apk pkgconf-1.7.2-r0.apk<br />
bash-5.0.17-r0.apk libcrypto1.1-1.1.1i-r0.apk ppp-atm-2.4.8-r2.apk<br />
bash-completion-2.10-r0.apk libcurl-7.69.1-r3.apk ppp-chat-2.4.8-r2.apk<br />
bonding-2.6-r4.apk libedit-20191231.3.1-r0.apk ppp-daemon-2.4.8-r2.apk<br />
bridge-1.5-r4.apk libev-4.33-r0.apk ppp-l2tp-2.4.8-r2.apk<br />
bridge-utils-1.6-r0.apk libgcc-9.3.0-r2.apk ppp-minconn-2.4.8-r2.apk<br />
busybox-1.31.1-r19.apk libmnl-1.0.4-r0.apk ppp-passprompt-2.4.8-r2.apk<br />
busybox-extras-1.31.1-r19.apk libnftnl-1.1.6-r0.apk ppp-passwordfd-2.4.8-r2.apk<br />
busybox-initscripts-3.2-r2.apk libnftnl-libs-1.1.6-r0.apk ppp-pppoe-2.4.8-r2.apk<br />
busybox-suid-1.31.1-r19.apk libnl3-3.5.0-r0.apk ppp-radius-2.4.8-r2.apk<br />
c-ares-1.16.1-r0.apk libpcap-1.9.1-r2.apk ppp-winbind-2.4.8-r2.apk<br />
ca-certificates-20191127-r4.apk libssl1.1-1.1.1i-r0.apk readline-8.0.4-r0.apk<br />
ca-certificates-bundle-20191127-r4.apk libstdc++-9.3.0-r2.apk scanelf-1.2.6-r0.apk<br />
chrony-3.5.1-r0.apk libtls-standalone-2.9.1-r1.apk signature.tar.gz<br />
chrony-openrc-3.5.1-r0.apk libusb-1.0.23-r0.apk ssl_client-1.31.1-r19.apk<br />
curl-7.69.1-r3.apk libuuid-2.35.2-r0.apk tar-1.32-r1.apk<br />
dbus-libs-1.12.18-r0.apk lzip-1.21-r0.apk tcpdump-4.9.3-r2.apk<br />
dnsmasq-2.81-r0.apk mii-tool-1.60_git20140218-r2.apk tree-1.8.0-r0.apk<br />
e2fsprogs-1.45.6-r0.apk musl-1.1.24-r10.apk tzdata-2020c-r1.apk<br />
e2fsprogs-libs-1.45.6-r0.apk musl-utils-1.1.24-r10.apk usb-modeswitch-2.6.0-r1.apk<br />
ethtool-5.6-r0.apk ncurses-libs-6.2_p20200523-r0.apk vlan-2.2-r0.apk<br />
ez-ipupdate-3.0.10-r9.apk ncurses-terminfo-base-6.2_p20200523-r0.apk wireless-tools-30_pre9-r1.apk<br />
fakeroot-1.24-r0.apk net-tools-1.60_git20140218-r2.apk wpa_supplicant-2.9-r5.apk<br />
haveged-1.9.8-r1.apk network-extras-1.2-r0.apk wpa_supplicant-openrc-2.9-r5.apk<br />
haveged-openrc-1.9.8-r1.apk nghttp2-1.41.0-r0.apk zlib-1.2.11-r3.apk<br />
hostapd-2.9-r2.apk nghttp2-libs-1.41.0-r0.apk<br />
hostapd-openrc-2.9-r2.apk openrc-0.42.1-r11.apk</div>Rickyrockrathttps://wiki.alpinelinux.org/w/index.php?title=How_to_set_up_Alpine_as_a_wireless_router&diff=18449How to set up Alpine as a wireless router2021-01-03T04:22:32Z<p>Rickyrockrat: </p>
<hr />
<div>=== Pi Zero W Wireless Router ===<br />
<br />
This is a page to describe building a Wireless Access Point with two wired ethernet ports for building a home router that connects to the internet with one wired port, and internal Lan with the second wired port and the on-board WiFi.<br><br />
<br />
The intent is to provide this:<br><br />
<pre><br />
|<-->eth1 <-->| <br />
Internet <--> eth0 <-->FireWall<-->br0 Internal<--> ssh,bind,dhcp, with ssh reverse ssh connections.<br />
|<-->wlan0<-->|<br />
</pre><br />
=== Overview ===<br />
I generally run Debian and when forced by Red Hot Irons, Red Hat. This is my first foray into Alpine. So far I am very impressed. I mirrored the 3.12 armhf repos so I had things local when I needed them. Word to the wise. That is 13G of apk files.<br><br />
One *really* nice feature of Alpine is apk, the yum/apt replacement:<br><br />
* It is simple, short, and to the point.<br />
* The same tool provides *repo* level dependency reporting!<br />
* Install of single packages without repo signing (I never did get the signing correct).<br />
<br />
=== Install ===<br />
* Find a microsd (or HDD) you can wipe. We will assume it is /dev/sdc.<br />
* make a 256M fat16/fat23 partition (sudo mkfs.vfat -n ALPBOOT /dev/sdc1)<br />
* the rest of the device can be ext2 (ext3/4 on HDD) (sudo mke2fs -m1 -L alext3 /dev/sdc2).<br />
* untar the alpine-rpi-3.12.3-armhf.tar.gz and copy all files to the fat16/32 partition 16 is good for up 2 2G. <br />
<br />
==== References ====<br />
apk notes:<br />
<br />
* Create and index and check dependencies on a list of apk files: apk index -o APKINDEX.unsigned.tar.gz *.apk<br />
* Install a package: apk add iw OR apk add /path/to/iw-5.4-r0.apk<br />
* remove a package: apk del iw<br />
* repositories are in: /etc/apk/repositories<br />
* Local URL: /media/mmcblk0p1/apks<br />
* Remote URL: http://dl-cdn.alpinelinux.org/alpine/v3.12/main<br />
<br />
[https://en.wikipedia.org/wiki/File_Allocation_Table FAT16/32 limits]<br><br />
[https://udhcp.busybox.net/README.udhcpc udhcpc]<br><br />
[https://linux.die.net/man/8/ez-ipupdate ez-ipupdate]<br><br />
[[Alpine_Linux:FAQ#Dynamic_DNS|Dynamic_DNS]]<br><br />
[[Bridge|Alpine Linux Bridge]]<br><br />
[[Connecting_to_a_wireless_access_point|Connect to wireless AP]]<br><br />
[https://unix.stackexchange.com/questions/222264/how-do-i-limit-dnsmasq-listening-to-only-one-interface dnsmasq listen restrictions]<br><br />
[https://wiki.archlinux.org/index.php/IPv6#Disable_IPv6 Disable IPV6]<br><br />
[https://github.com/imp/dnsmasq/blob/master/dnsmasq.conf.example dnsmasq Docs]<br><br />
[https://man.openbsd.org/hostapd.conf.5 HostApd Docs]<br><br />
[rsync://rsync.alpinelinux.org/alpine Alpine Repos]<br><br />
[https://stevessmarthomeguide.com/home-network-dns-dnsmasq Set Static DNS names]<br><br />
===== Pi Specific =====<br />
[https://raspberrypi.stackexchange.com/questions/89803/access-point-as-wifi-router-repeater-optional-with-bridge/89804 Pi Wifi Repeater]<br><br />
[https://raspberrypi.stackexchange.com/questions/81486/raspberry-pi-wifi-to-ethernet-bridge-for-a-server/81518 WiFi Bridge]<br><br />
[[Raspberry_Pi|Alpine Install]]<br><br />
[[Raspberry_Pi_Zero_W_-_Installation|PiZeroW Install]]<br><br />
[[Classic_install_or_sys_mode_on_Raspberry_Pi|Classic Sys Install on Pi]]<br><br />
<br />
==== Not Related, but Interesting ====<br />
[https://blog.thewalr.us/2017/09/26/raspberry-pi-zero-w-simultaneous-ap-and-managed-mode-wifi AP and Managed Mode]<br><br />
[https://www.instructables.com/Using-a-Raspberry-PI-Zero-W-As-an-Access-Point-and AP and MQTT]<br></div>Rickyrockrathttps://wiki.alpinelinux.org/w/index.php?title=How_to_set_up_Alpine_as_a_wireless_router&diff=18447How to set up Alpine as a wireless router2021-01-02T22:48:24Z<p>Rickyrockrat: </p>
<hr />
<div>=== Pi Zero W Wireless Router ===<br />
<br />
This is a page to describe building a Wireless Access Point with two wired ethernet ports for building a home router that connects to the internet with one wired port, and internal Lan with the second wired port and the on-board WiFi.<br><br />
<br />
The intent is to provide this:<br><br />
<pre><br />
|<-->eth1 <-->| <br />
Internet <--> eth0 <-->FireWall<-->br0 Internal<--> ssh,bind,dhcp, with ssh reverse ssh connections.<br />
|<-->wlan0<-->|<br />
</pre><br />
=== Overview ===<br />
I generally run Debian and when forced by Red Hot Irons, Red Hat. This is my first foray into Alpine. So far I am very impressed. I mirrored the 3.12 armhf repos so I had things local when I needed them. Word to the wise. That is 13G of apk files.<br><br />
One *really* nice feature of Alpine is apk, the yum/apt replacement:<br><br />
* It is simple, short, and to the point.<br />
* The same tool provides *repo* level dependency reporting!<br />
* Install of single packages without repo signing (I never did get the signing correct).<br />
<br />
=== Install ===<br />
<br />
==== References ====<br />
apk notes:<br />
<br />
* Create and index and check dependencies on a list of apk files: apk index -o APKINDEX.unsigned.tar.gz *.apk<br />
* Install a package: apk add iw OR apk add /path/to/iw-5.4-r0.apk<br />
* remove a package: apk del iw<br />
* repositories are in: /etc/apk/repositories<br />
* Local URL: /media/mmcblk0p1/apks<br />
* Remote URL: http://dl-cdn.alpinelinux.org/alpine/v3.12/main<br />
<br />
<br />
[https://udhcp.busybox.net/README.udhcpc udhcpc]<br><br />
[https://linux.die.net/man/8/ez-ipupdate ez-ipupdate]<br><br />
[[Alpine_Linux:FAQ#Dynamic_DNS|Dynamic_DNS]]<br><br />
[[Bridge|Alpine Linux Bridge]]<br><br />
[[Connecting_to_a_wireless_access_point|Connect to wireless AP]]<br><br />
[https://unix.stackexchange.com/questions/222264/how-do-i-limit-dnsmasq-listening-to-only-one-interface dnsmasq listen restrictions]<br><br />
[https://wiki.archlinux.org/index.php/IPv6#Disable_IPv6 Disable IPV6]<br><br />
[https://github.com/imp/dnsmasq/blob/master/dnsmasq.conf.example dnsmasq Docs]<br><br />
[https://man.openbsd.org/hostapd.conf.5 HostApd Docs]<br><br />
[rsync://rsync.alpinelinux.org/alpine Alpine Repos]<br><br />
<br />
===== Pi Specific =====<br />
[https://raspberrypi.stackexchange.com/questions/89803/access-point-as-wifi-router-repeater-optional-with-bridge/89804 Pi Wifi Repeater]<br><br />
[https://raspberrypi.stackexchange.com/questions/81486/raspberry-pi-wifi-to-ethernet-bridge-for-a-server/81518 WiFi Bridge]<br><br />
[[Raspberry_Pi|Alpine Install]]<br><br />
[[Raspberry_Pi_Zero_W_-_Installation|PiZeroW Install]]<br><br />
[[Classic_install_or_sys_mode_on_Raspberry_Pi|Classic Sys Install on Pi]]<br><br />
<br />
==== Not Related, but Interesting ====<br />
[https://blog.thewalr.us/2017/09/26/raspberry-pi-zero-w-simultaneous-ap-and-managed-mode-wifi AP and Managed Mode]<br><br />
[https://www.instructables.com/Using-a-Raspberry-PI-Zero-W-As-an-Access-Point-and AP and MQTT]<br></div>Rickyrockrathttps://wiki.alpinelinux.org/w/index.php?title=How_to_set_up_Alpine_as_a_wireless_router&diff=18446How to set up Alpine as a wireless router2021-01-02T22:36:44Z<p>Rickyrockrat: /* Pi Zero W Wireless Router */</p>
<hr />
<div>=== Pi Zero W Wireless Router ===<br />
<br />
This is a page to describe building a Wireless Access Point with two wired ethernet ports for building a home router that connects to the internet with one wired port, and internal Lan with the second wired port and the on-board WiFi.<br><br />
=== Overview ===<br />
I generally run Debian and when forced by red hot irons, Red Hat. This is my first foray into Alpine. So far I am very impressed. I mirrored the 3.12 armhf repos so I had things local when I needed them. Word to the wise. That is 13G of apk files.<br><br />
One *really* nice feature of Alpine is apk, the yum/apt replacement:<br><br />
It is simple, short, and to the point.<br />
=== Install ===<br />
<br />
==== References ====<br />
<br />
[https://udhcp.busybox.net/README.udhcpc udhcpc]<br><br />
[https://linux.die.net/man/8/ez-ipupdate ez-ipupdate]<br><br />
[[Alpine_Linux:FAQ#Dynamic_DNS|Dynamic_DNS]]<br><br />
[[Bridge|Alpine Linux Bridge]]<br><br />
[[Connecting_to_a_wireless_access_point|Connect to wireless AP]]<br><br />
[https://unix.stackexchange.com/questions/222264/how-do-i-limit-dnsmasq-listening-to-only-one-interface dnsmasq listen restrictions]<br><br />
[https://wiki.archlinux.org/index.php/IPv6#Disable_IPv6 Disable IPV6]<br><br />
[https://github.com/imp/dnsmasq/blob/master/dnsmasq.conf.example dnsmasq Docs]<br><br />
[https://man.openbsd.org/hostapd.conf.5 HostApd Docs]<br><br />
[rsync://rsync.alpinelinux.org/alpine Alpine Repos]<br><br />
<br />
===== Pi Specific =====<br />
[https://raspberrypi.stackexchange.com/questions/89803/access-point-as-wifi-router-repeater-optional-with-bridge/89804 Pi Wifi Repeater]<br><br />
[https://raspberrypi.stackexchange.com/questions/81486/raspberry-pi-wifi-to-ethernet-bridge-for-a-server/81518 WiFi Bridge]<br><br />
[[Raspberry_Pi|Alpine Install]]<br><br />
[[Raspberry_Pi_Zero_W_-_Installation|PiZeroW Install]]<br><br />
[[Classic_install_or_sys_mode_on_Raspberry_Pi|Classic Sys Install on Pi]]<br><br />
<br />
==== Not Related, but Interesting ====<br />
[https://blog.thewalr.us/2017/09/26/raspberry-pi-zero-w-simultaneous-ap-and-managed-mode-wifi AP and Managed Mode]<br><br />
[https://www.instructables.com/Using-a-Raspberry-PI-Zero-W-As-an-Access-Point-and AP and MQTT]<br></div>Rickyrockrathttps://wiki.alpinelinux.org/w/index.php?title=How_to_set_up_Alpine_as_a_wireless_router&diff=18445How to set up Alpine as a wireless router2021-01-02T22:27:37Z<p>Rickyrockrat: /* References */</p>
<hr />
<div>=== Pi Zero W Wireless Router ===<br />
<br />
This is a page to describe building a Wireless Access Point with two wired ethernet ports for building a home router that connects to the internet with one wired port, and internal Lan with the second wired port and the on-board WiFi.<br><br />
<br />
==== References ====<br />
<br />
[https://udhcp.busybox.net/README.udhcpc udhcpc]<br><br />
[https://linux.die.net/man/8/ez-ipupdate ez-ipupdate]<br><br />
[[Alpine_Linux:FAQ#Dynamic_DNS|Dynamic_DNS]]<br><br />
[[Bridge|Alpine Linux Bridge]]<br><br />
[[Connecting_to_a_wireless_access_point|Connect to wireless AP]]<br><br />
[https://unix.stackexchange.com/questions/222264/how-do-i-limit-dnsmasq-listening-to-only-one-interface dnsmasq listen restrictions]<br><br />
[https://wiki.archlinux.org/index.php/IPv6#Disable_IPv6 Disable IPV6]<br><br />
[https://github.com/imp/dnsmasq/blob/master/dnsmasq.conf.example dnsmasq Docs]<br><br />
[https://man.openbsd.org/hostapd.conf.5 HostApd Docs]<br><br />
<br />
===== Pi Specific =====<br />
[https://raspberrypi.stackexchange.com/questions/89803/access-point-as-wifi-router-repeater-optional-with-bridge/89804 Pi Wifi Repeater]<br><br />
[https://raspberrypi.stackexchange.com/questions/81486/raspberry-pi-wifi-to-ethernet-bridge-for-a-server/81518 WiFi Bridge]<br><br />
[[Raspberry_Pi|Alpine Install]]<br><br />
<br />
==== Not Related, but Interesting ====<br />
[https://blog.thewalr.us/2017/09/26/raspberry-pi-zero-w-simultaneous-ap-and-managed-mode-wifi AP and Managed Mode]<br><br />
[https://www.instructables.com/Using-a-Raspberry-PI-Zero-W-As-an-Access-Point-and AP and MQTT]<br></div>Rickyrockrathttps://wiki.alpinelinux.org/w/index.php?title=How_to_set_up_Alpine_as_a_wireless_router&diff=18444How to set up Alpine as a wireless router2021-01-02T22:22:40Z<p>Rickyrockrat: /* References */</p>
<hr />
<div>=== Pi Zero W Wireless Router ===<br />
<br />
This is a page to describe building a Wireless Access Point with two wired ethernet ports for building a home router that connects to the internet with one wired port, and internal Lan with the second wired port and the on-board WiFi.<br><br />
<br />
==== References ====<br />
<br />
[https://udhcp.busybox.net/README.udhcpc udhcpc]<br><br />
[https://linux.die.net/man/8/ez-ipupdate ez-ipupdate]<br><br />
[[Alpine_Linux:FAQ#Dynamic_DNS|Dynamic_DNS]]<br><br />
[[Bridge|Alpine Linux Bridge]]<br><br />
[[Connecting_to_a_wireless_access_point|Connect to wireless AP]]<br><br />
[https://unix.stackexchange.com/questions/222264/how-do-i-limit-dnsmasq-listening-to-only-one-interface dnsmasq listen restrictions]<br><br />
<br />
===== Pi Specific =====<br />
[https://raspberrypi.stackexchange.com/questions/89803/access-point-as-wifi-router-repeater-optional-with-bridge/89804 Pi Wifi Repeater]<br><br />
[https://raspberrypi.stackexchange.com/questions/81486/raspberry-pi-wifi-to-ethernet-bridge-for-a-server/81518 WiFi Bridge]<br><br />
<br />
==== Not Related, but Interesting ====<br />
[https://blog.thewalr.us/2017/09/26/raspberry-pi-zero-w-simultaneous-ap-and-managed-mode-wifi AP and Managed Mode]<br><br />
[https://www.instructables.com/Using-a-Raspberry-PI-Zero-W-As-an-Access-Point-and AP and MQTT]<br></div>Rickyrockrathttps://wiki.alpinelinux.org/w/index.php?title=How_to_set_up_Alpine_as_a_wireless_router&diff=18443How to set up Alpine as a wireless router2021-01-02T22:20:05Z<p>Rickyrockrat: /* References */</p>
<hr />
<div>=== Pi Zero W Wireless Router ===<br />
<br />
This is a page to describe building a Wireless Access Point with two wired ethernet ports for building a home router that connects to the internet with one wired port, and internal Lan with the second wired port and the on-board WiFi.<br><br />
<br />
==== References ====<br />
<br />
[https://udhcp.busybox.net/README.udhcpc udhcpc]<br><br />
[https://linux.die.net/man/8/ez-ipupdate ez-ipupdate]<br><br />
[[Alpine_Linux:FAQ#Dynamic_DNS|Dynamic_DNS]]<br><br />
[[Bridge|Alpine Linux Bridge]]<br><br />
[[Connecting_to_a_wireless_access_point|Connect to wireless AP]]<br><br />
<br />
===== Pi Specific =====<br />
[https://raspberrypi.stackexchange.com/questions/89803/access-point-as-wifi-router-repeater-optional-with-bridge/89804 Pi Wifi Repeater]<br><br />
==== Not Related, but Interesting ====<br />
[https://blog.thewalr.us/2017/09/26/raspberry-pi-zero-w-simultaneous-ap-and-managed-mode-wifi AP and Managed Mode]<br><br />
[https://www.instructables.com/Using-a-Raspberry-PI-Zero-W-As-an-Access-Point-and AP and MQTT]<br></div>Rickyrockrathttps://wiki.alpinelinux.org/w/index.php?title=How_to_set_up_Alpine_as_a_wireless_router&diff=18442How to set up Alpine as a wireless router2021-01-02T22:13:01Z<p>Rickyrockrat: /* References */</p>
<hr />
<div>=== Pi Zero W Wireless Router ===<br />
<br />
This is a page to describe building a Wireless Access Point with two wired ethernet ports for building a home router that connects to the internet with one wired port, and internal Lan with the second wired port and the on-board WiFi.<br><br />
<br />
==== References ====<br />
<br />
[[https://udhcp.busybox.net/README.udhcpc udhcpc]]<br />
[[https://linux.die.net/man/8/ez-ipupdate ez-ipupdate]]<br />
[[Alpine_Linux:FAQ#Dynamic_DNS|Dynamic_DNS]]<br />
[[Bridge|Alpine Linux Bridge]]</div>Rickyrockrathttps://wiki.alpinelinux.org/w/index.php?title=How_to_set_up_Alpine_as_a_wireless_router&diff=18441How to set up Alpine as a wireless router2021-01-02T22:12:36Z<p>Rickyrockrat: Created page with "=== Pi Zero W Wireless Router === This is a page to describe building a Wireless Access Point with two wired ethernet ports for building a home router that connects to the in..."</p>
<hr />
<div>=== Pi Zero W Wireless Router ===<br />
<br />
This is a page to describe building a Wireless Access Point with two wired ethernet ports for building a home router that connects to the internet with one wired port, and internal Lan with the second wired port and the on-board WiFi.<br><br />
<br />
==== References ====<br />
<br />
[https://udhcp.busybox.net/README.udhcpc udhcpc]<br />
[https://linux.die.net/man/8/ez-ipupdate ez-ipupdate]<br />
[[Alpine_Linux:FAQ#Dynamic_DNS|Dynamic_DNS]]<br />
[[Bridge|Alpine Linux Bridge]]</div>Rickyrockrathttps://wiki.alpinelinux.org/w/index.php?title=Tutorials_and_Howtos&diff=18440Tutorials and Howtos2021-01-02T21:47:26Z<p>Rickyrockrat: /* Networking */</p>
<hr />
<div>{{Todo|This material needs to be re-organized .. as '''Howtos are smaller articles''' and '''tutorials are more detailed document''' both need to be reordered as independent sections }}<br />
<br />
[[Image:package_edutainment.svg|right|link=]]<br />
{{TOC left}}<br />
'''Welcome to Tutorials and Howtos, a place of basic and advanced configuration tasks for your Alpine Linux.'''<br />
<br />
'''The tutorials are hands-on''' and the reader is expected to try and achieve the goals described in each step, possibly with the help of a good example. The output in one step is the starting point for the following step.<br />
<br />
'''Howtos are smaller articles''' explaining how to perform a particular task with Alpine Linux, that expects a minimal knowledge from reader to perform actions.<br />
<br />
'''IMPORTANT:''' contributions on those pages must be complete articles as well as requesting topics to be covered, don't override already made contributions. If you want to request a topic, please add your request in this page's [[Talk:Tutorials_and_Howtos|Discussion]].<br />
<br />
-----------------------------------------------------------------<br />
<br />
All of '''those linked pages here will help you make many things''' over the Alpine '''O'''perating '''S'''ystem or Alpine '''OS'''.<br />
<br />
Alpine are the main program named '''OS''' (means Operating System), that's runs on top of the '''machine/PC/laptop''', and subsequently over this '''OS''' run the programs such like the internet web browser ({{Pkg|firefox}}, {{Pkg|chromium}}), and the web pages like "facebook" runs over that internet web browser.<br />
<br />
{{Clear}}<br />
<br />
== New users and Newbies ==<br />
<br />
* [[Newbie Alpine Ecosystem]] (for overall information in funny sections)<br />
<br />
==== Installation: Use cases ====<br />
<br />
* [[Alpine newbie install manual]]<br />
** [[Alpine Install: from a disc to a new computer single only boot]]<br />
** [[Alpine Install: from a disc to a old computer single only boot]]<br />
** [[Alpine Install: from a disc to a virtualbox machine single only]]<br />
** [[Alpine Install: from a iso to a virtualbox machine with external disc]]<br />
* [[Alpine_newbie_install_manual#Ways_to_install_Alpine_listed_by_architectures|Ways to install listed by architectures]]<br />
** [[Alpine_newbie_install_manual#x86_64_x86_32_x86|x86_64 x86_32 x86 s390]]<br />
** [[Alpine_newbie_install_manual#armhf_armv7|armhf armv7 aarch64]]<br />
** [[Alpine_newbie_install_manual#ppc64le|ppc64le others PPC]]<br />
<br />
==== Postinstall: desktops and applications ====<br />
<br />
* [[Alpine newbie apk packages|Overall info and minimal packages common to any working desktop]]<br />
** [[Alpine newbie desktops|Alpine newbie desktops, (overall information only)]]<br />
** [[Alpine Newbies XFCE Desktop Environment]]<br />
** [[Alpine Newbies LXDE Desktop Environment]]<br />
** [[Alpine Newbies Openbox Window Manager|Alpine Newbies Xorg and Openbox Window Manager]]<br />
** [[MATE|Alpine Newbies MATE Desktop Environment]]<br />
* [[Alpine and UEFI|Alpine and UEFI Support Status and related topics]]<br />
<br />
==== Developers: compilers, IDE's and tools ====<br />
<br />
* [[Alpine newbie developer]]<br />
** [[Alpine_newbie_developer: gitea|Alpine_newbie_developer: Git management web frontend gitea]]<br />
** [[Alpine newbie developer: full stack web]]<br />
<br />
==== Servers: deploy in production ====<br />
<br />
* [[Alpine production deploy]]<br />
** [[Production Web server: Lighttpd]]<br />
** [[Production DataBases : mysql]]<br />
** [[Production LAMP system: Lighttpd + PHP + MySQL]]<br />
* Alpine production monitoring<br />
** [[Cacti: traffic analysis and monitoring network]]<br />
<br />
== Storage ==<br />
<br />
* [[Alpine local backup|Alpine local backup (lbu)]] ''(Permanently store your modifications in case your box needs reboot)'' <!-- Installation and Storage --><br />
** [[Back Up a Flash Memory Installation]] <!-- Installation and Storage --><br />
** [[Manually editing a existing apkovl]]<br />
<br />
* [[Setting up disks manually]] <!-- Installation and Storage --><br />
* [[Setting up a software RAID array]]<br />
<!-- ** [[Setting up a /var partition on software IDE raid1]] Obsolete, Installation and Storage --> <br />
* [[Raid Administration]]<br />
* [[Setting up encrypted volumes with LUKS]]<br />
* [[Setting up LVM on LUKS]]<br />
* [[Setting up Logical Volumes with LVM]]<br />
** [[Setting up LVM on GPT-labeled disks]]<br />
** [[Installing on GPT LVM]]<br />
* [[Filesystems|Formatting HD/Floppy/Other]] <!-- just a stub --><br />
<br />
* [[Setting up iSCSI]]<br />
** [[iSCSI Raid and Clustered File Systems]]<br />
* [[Setting up NBD]]<br />
* [[Setting up ZFS on LUKS]]<br />
* [[Setting up ZFS with native encryption]]<br />
* [[High performance SCST iSCSI Target on Linux software Raid]] ''(deprecated)'' <!-- solution --><br />
* [[Linux iSCSI Target (TCM)]]<br />
* [[Disk Replication with DRBD]] <!-- draft --><br />
<br />
* [[Burning ISOs]] <!-- just some links now --><br />
* [[Partitioning and Bootmanagers]]<br />
* [[Migrating data]]<br />
* [[Create a bootable SDHC from a Mac]]<br />
* [[Alpine on ARM]]<br />
<br />
== Networking ==<br />
<br />
* [[Configure Networking]]<br />
* [[Connecting to a wireless access point]]<br />
* [[Bonding]]<br />
* [[Vlan]]<br />
* [[Bridge]]<br />
* [[Bridge wlan0 to eth0]]<br />
* [[OpenVSwitch]]<br />
* [[How to configure static routes]]<br />
* [[Configure a Wireguard interface (wg)]]<br />
<br />
* [[Alpine Wall]] - [[How-To Alpine Wall]] - [[Alpine Wall User's Guide]] ''(a new firewall management framework)''<br />
<br />
* [[PXE boot]]<br />
<br />
* [[Using serial modem]]<br />
* [[Using HSDPA modem]]<br />
* [[Setting up Satellite Internet Connection]]<br />
* [[Using Alpine on Windows domain with IPSEC isolation]]<br />
<br />
* [[Setting up a ssh-server]] ''(Using ssh is a good way to administer your box remotely)'' <!-- Server and Networking --><br />
* [[How to setup a wireless access point]] ''(Setting up Secure Wireless AP w/ WPA encryption with bridge to wired network)''<br />
* [[How to set up Alpine as a wireless router]] ''(Setting up a firewalled, Wireless AP with wired network on a Pi Zero W)''<br />
* [[Setting up a OpenVPN server with Alpine]] ''(Allowing single users or devices to remotely connect to your network)''<br />
<!-- [[Using Racoon for Remote Sites]] is a different VPN tunnelling method, but that article is just a stub --><br />
* [[Experiences with OpenVPN-client on ALIX.2D3]] <!-- solution --><br />
<br />
* [[Generating SSL certs with ACF]] <!-- Generating SSL certs with ACF 1.9 --><br />
* [[Setting up unbound DNS server]]<br />
* [[Setting up nsd DNS server]]<br />
* [[TinyDNS Format]]<br />
* [[Fault Tolerant Routing with Alpine Linux]] <!-- solution --><br />
* [[Freeradius Active Directory Integration]]<br />
* [[Multi_ISP]] ''(Dual-ISP setup with load-balancing and automatic failover)''<br />
* [[OwnCloud]] ''(Installing OwnCloud)''<br />
<br />
* [[Seafile: setting up your own private cloud]]<br />
<br />
* [[GNUnet]]<br />
<br />
== Post-Install ==<br />
<!-- If you edit this, please coordinate with Installation and Developer_Documentation#Package_management. Note that these three sections are not exact duplicates. --><br />
<br />
* [[Alpine_newbie_apk_packages|Alpine newbie users post install and easy setups]]<br />
** [[Alpine_newbie_apk_packages#New_users:_hostname_and_network_wired_connection|First steps at post install]]<br />
** [[Alpine_newbie_apk_packages#New_users:_common_needed_package_to_install|Enable repositories]]<br />
** [[Alpine_newbie_apk_packages#New_users:_management_of_users_and_logins|Added the first user to use the system]]<br />
** [[Alpine_newbie_apk_packages#install_basic_tools|First packages to install]] (need the previous [[Alpine_newbie_apk_packages#New_users:_common_needed_package_to_install|Enable repositories]]) already done!<br />
<br />
* [[Setting up a new user]]<br />
* [[Enable Community Repository]] ''(Providing additional packages)''<br />
* [[Alpine Linux package management|Package Management (apk)]] ''(How to add/remove packages on your Alpine)''<br />
<!-- [[Alpine Linux package management#Local_Cache|How to enable APK caching]] --><br />
** [[Comparison with other distros]]<br />
* [[Alpine local backup|Alpine local backup (lbu)]] ''(Permanently store your modifications in case your box needs reboot)''<br />
** [[Back Up a Flash Memory Installation]] <!-- new --><br />
** [[Manually editing a existing apkovl]]<br />
* [[Alpine Linux Init System|Init System (OpenRC)]] ''(Configure a service to automatically boot at next reboot)''<br />
** [[Multiple Instances of Services]]<br />
<!-- [[Writing Init Scripts]] --><br />
* [[Alpine setup scripts#setup-xorg-base|Setting up Xorg]]<br />
* [[Upgrading Alpine]]<br />
<!-- Obsolete<br />
[[Upgrading Alpine - v1.9.x]]<br />
[[Upgrading Alpine - CD v1.8.x]]<br />
[[Upgrading Alpine - HD v1.8.x]]<br />
[[Upgrade to repository main|Upgrading to signed repositories]]<br />
--><br />
<br />
* [[Setting up a ssh-server]] ''(Using ssh is a good way to administer your box remotely)''<br />
* [[setup-acf]] ''(Configures ACF (webconfiguration) so you can manage your box through https)''<br />
* [[Changing passwords for ACF|Changing passwords]]<br />
* [[Ansible]] ''(Configuration management)''<br />
<br />
* [[Enable Serial Console on Boot]]<br />
<!-- Obsolete?<br />
* [[Error message on boot: Address space collision: host bridge window conflicts with Adaptor ROM]]<br />
--><br />
* [[How to get regular stuff working]] ''some notes on need-to-know topics''<br />
* [[Installing Oracle Java]]<br />
* [[Rsnapshot|Setting up periodic backups with <samp>rsnapshot</samp>]]<br />
<br />
== Virtualization==<br />
<br />
* [[Xen Dom0]] ''(Setting up Alpine as a dom0 for Xen hypervisor)''<br />
* [[Xen Dom0 on USB or SD]]<br />
* [[Create Alpine Linux PV DomU]]<br />
* [[Xen PCI Passthrough]]<br />
* [[Xen LiveCD]]<br />
* [[qemu]]<br />
* [[KVM]] ''(Setting up Alpine as a KVM hypervisor)''<br />
* [[LXC]] ''(Setting up a Linux container in Alpine Linux)''<br />
* [[Docker]]<br />
* [[Install_Alpine_on_VirtualBox]]<br />
* [[Install Alpine on VMWare]]<br />
<br />
== Desktop Environment ==<br />
<br />
* [[Awesome(wm) Setup]]<br />
* [[dwm]] ''(dynamic window manager for X)''<br />
* [[EyeOS]] ''(Cloud Computing Desktop)''<br />
* [[Gnome Setup]]<br />
* [[MATE|MATE Setup]]<br />
* [[Oneye]] ''(Cloud Computing Desktop - Dropbox Alternative)''<br />
* [[Owncloud]] ''(Cloud Computing Desktop - Dropbox Alternative)''<br />
** (to be merged with [[OwnCloud]] ''(Your personal Cloud for storing and sharing your data on-line)'')<br />
* [[Remote Desktop Server]]<br />
* [[Suspend on LID close]]<br />
* [[Sway]]<br />
* [[XFCE Setup]] and [[Xfce Desktop|Desktop Ideas]]<br />
* [[Installing Adobe flash player for Firefox]]<br />
* [[Sound Setup]]<br />
* [[Printer Setup]]<br />
* [[Default applications]]<br />
<br />
== Raspberry Pi ==<br />
<br />
* [[Raspberry Pi|Raspberry Pi (Installation)]]<br />
* [[Classic install or sys mode on Raspberry Pi]]<br />
* [[RPI Video Receiver]] ''(network video decoder using Rasperry Pi and omxplayer)''<br />
* [[Linux Router with VPN on a Raspberry Pi]]<br />
* [[Linux Router with VPN on a Raspberry Pi (IPv6)]]<br />
* [[Raspberry Pi 4 - Persistent system acting as a NAS and Time Machine]]<br />
* [[Raspberry Pi 3 - Configuring it as wireless access point -AP Mode]]<br />
* [[Raspberry Pi 3 - Setting Up Bluetooth]]<br />
* [[Raspberry Pi 3 - Browser Client]]<br />
* [[Raspberry Pi Zero W - Installation]]<br />
* [[Raspberry Pi - Headless Installation]]<br />
<br />
== PowerPC ==<br />
<br />
* [[Ppc64le|Powepc64le (Installation)]]<br />
<br />
== IBM Z (IBM z Systems) ==<br />
<br />
* [[s390x|s390x (Installation)]]<br />
<br />
== Applications ==<br />
<br />
=== Telephony ===<br />
* [[Setting up Zaptel/Asterisk on Alpine]]<br />
** [[Setting up Streaming an Asterisk Channel]]<br />
* [[Freepbx on Alpine Linux]]<br />
* [[FreePBX_V3]] ''(FreeSWITCH, Asterisk GUI web acces tool)''<br />
* [[2600hz]] ''(FreeSWITCH, Asterisk GUI web access tool)''<br />
* [[Kamailio]] ''(SIP Server, formerly OpenSER)''<br />
<br />
=== Mail ===<br />
* [[Hosting services on Alpine]] ''(Hosting mail, webservices and other services)''<br />
** [[Hosting Web/Email services on Alpine]]<br />
* [[ISP Mail Server HowTo]] <!-- solution, Mail --><br />
** [[ISP Mail Server Upgrade 2.x]]<br />
** [[ISP Mail Server 2.x HowTo]] ''(Beta, please test)''<br />
** [[ISP Mail Server 3.x HowTo]]<br />
* [[Roundcube]] ''(Webmail system)''<br />
* [[Setting up postfix with virtual domains]]<br />
* [[Protecting your email server with Alpine]]<br />
* [[Setting up clamsmtp]]<br />
* [[Setting up dovecot with imap and ssl]]<br />
* [[relay email to gmail (msmtp, mailx, sendmail]]<br />
<br />
=== HTTP ===<br />
* [[Lighttpd]]<br />
** [[Lighttpd Https access]]<br />
** [[Setting Up Lighttpd with PHP]]<br />
** [[Setting Up Lighttpd With FastCGI]]<br />
* [[Cherokee]]<br />
* [[Nginx]]<br />
** [[Nginx_with_PHP#Nginx_with_PHP|Nginx with PHP]]<br />
** [[Nginx as reverse proxy with acme (letsencrypt)]]<br />
* [[Apache]]<br />
** [[Apache with php-fpm]]<br />
** [[Setting Up Apache with PHP]]<br />
** [[Apache authentication: NTLM Single Signon]]<br />
<br />
* [[High Availability High Performance Web Cache]] ''(uCarp + HAProxy for High Availability Services such as Squid web proxy)'' <!-- solution, Server --><br />
<br />
* [[Setting up Transparent Squid Proxy]] <!-- draft --><br />
** [[SqStat]] ''(Script to look at active squid users connections)''<br />
** [[Obtaining user information via SNMP]] ''(Using squark-auth-snmp as a Squid authentication helper)'' <!-- Networking and Server, <== Using squark-auth-snmp --><br />
* [[Setting up Explicit Squid Proxy]]<br />
<br />
* [[Drupal]] ''(Content Management System (CMS) written in PHP)''<br />
* [[WordPress]] ''(Web software to create website or blog)''<br />
* [[MediaWiki]] ''(Free web-based wiki software application)''<br />
* [[DokuWiki]]<br />
* [[Darkhttpd]]<br />
* [[Tomcat]]<br />
<br />
=== Other Servers ===<br />
* [[Setting up a ssh-server]] ''(Using ssh is a good way to administer your box remotely)''<br />
<br />
* [[Setting up a nfs-server]]<br />
* [[Setting up a samba-server]] ''(standard file sharing)''<br />
* [[Setting up a samba-ad-dc]] ''(Active Directory compatible domain controller)''<br />
* [[Phpizabi]] ''(Social Networking Platform)''<br />
* [[Statusnet]] ''(Microblogging Platform)''<br />
* [[Pastebin]] ''(Pastebin software application)''<br />
* [[Setting up Transmission (bittorrent) with Clutch WebUI]]<br />
<br />
* [[Patchwork]] ''(Patch review management system)''<br />
* [[Redmine]] ''(Project management system)''<br />
* [[Request-Tracker]] ''(Ticket system)''<br />
* [[OsTicket]] ''(Ticket system)''<br />
* [[Setting up trac wiki|Trac]] ''(Enhanced wiki and issue tracking system for software development projects)''<br />
<br />
* [[Alpine_newbie_developer: gitea|Setting up Git management web frontend gitea]]<br />
* [[Cgit]]<br />
** [[Setting up a git repository server with gitolite and cgit]] <!-- doesn't exist yet --><br />
* [[Roundcube]] ''(Webmail system)''<br />
* [[Glpi]] ''(Manage inventory of technical resources)''<br />
<br />
* [[How to setup a Alpine Linux mirror]]<br />
* [[Cups]]<br />
* [[NgIRCd]] ''(Server for Internet Relay Chat/IRC)''<br />
* [[How To Setup Your Own IRC Network]] ''(Using {{Pkg|charybdis}} and {{Pkg|atheme-iris}})''<br />
* [[OpenVCP]] ''(VServer Control Panel)''<br />
* [[Mahara]] ''(E-portfolio and social networking system)''<br />
* [[Chrony and GPSD | Using chrony, gpsd, and a garmin LVC 18 as a Stratum 1 NTP source ]]<br />
* [[Sending SMS using gnokii]]<br />
* [[IPTV How To|Internet Protocol television (IPTV)]]<br />
* [[UniFi_Controller]]<br />
* [[DNSCrypt-Proxy]] ''Encrypt and authenticate DNS calls from your system''<br />
* [[Odoo]]<br />
<br />
=== Monitoring ===<br />
* Setting up [[collectd]]<br />
* [[Traffic monitoring]] <!-- Networking and Monitoring --><br />
* [[Setting up traffic monitoring using rrdtool (and snmp)]] <!-- Monitoring --><br />
* [[Setting up monitoring using rrdtool (and rrdcollect)]]<br />
* [[Cacti: traffic analysis and monitoring network]] ''(Front-end for rrdtool networking monitor)''<br />
* [[LTTng]] ''(Kernel and userspace tracing)''<br />
* [[Setting up Zabbix|Zabbix]] ''(Monitor and track the status of network services and hardware)''<br />
* [[Setting up A Network Monitoring and Inventory System]] ''(Nagios + OpenAudit and related components)'' <!-- draft, solution, Networking and Monitoring and Server --><br />
** [[Setting up NRPE daemon]] ''(Performs remote Nagios checks)'' <!-- Networking and Monitoring --><br />
* [[Setting up Smokeping|Smokeping]] ''(Network latency monitoring)'' <!-- Networking and Monitoring --><br />
** [[Setting up MRTG and Smokeping to Monitor Bandwidth Usage and Network Latency]]<br />
* [[Setting Up Fprobe And Ntop|Ntop]] ''(NetFlow collection and analysis using a remote fprobe instance)'' <!-- Networking and Monitoring --><br />
* [[Cvechecker]] ''(Compare installed packages for Common Vulnerabilities Exposure)'' <!-- Monitoring and Security --><br />
<br />
* [[IP Accounting]] <!-- Networking and Monitoring --><br />
* [[Obtaining user information via SNMP]] ''(Using squark-auth-snmp as a Squid authentication helper)'' <!-- Networking and Server, <== Using squark-auth-snmp --><br />
* [[SqStat]] ''(Script to look at active squid users connections)''<br />
<br />
* [[Piwik]] ''(A real time web analytics software program)''<br />
* [[Awstats]] ''(Free log file analyzer)''<br />
* [[Intrusion Detection using Snort]]<br />
** [[Intrusion Detection using Snort, Sguil, Barnyard and more]]<br />
* [[Dglog]] ''(Log analyzer for the web content filter DansGuardian)''<br />
<br />
* [[Webmin]] ''(A web-based interface for Linux system)''<br />
* [[PhpPgAdmin]] ''(Web-based administration tool for PostgreSQL)''<br />
* [[PhpMyAdmin]] ''(Web-based administration tool for MYSQL)''<br />
* [[PhpSysInfo]] ''(A simple application that displays information about the host it's running on)''<br />
* [[Linfo]]<br />
<br />
* [[Setting up lm_sensors]]<br />
<br />
* [[ZoneMinder video camera security and surveillance]]<br />
<br />
== Misc ==<br />
<br />
* [[:Category:Shell]]<br />
* [[:Category:Programming]]<br />
* [[Running glibc programs]]<br />
* [[:Category:Drivers]]<br />
* [[:Category:Multimedia]]<br />
* [[Kernel Modesetting]]<br />
* [[CPU frequency scaling]]<br />
<br />
== Complete Solutions ==<br />
* [[DIY Fully working Alpine Linux for Allwinner and Other ARM SOCs]]<br />
* [[Replacing non-Alpine Linux with Alpine remotely]]<br />
* [[High performance SCST iSCSI Target on Linux software Raid]]<br />
* [[Fault Tolerant Routing with Alpine Linux]]<br />
* [[Experiences with OpenVPN-client on ALIX.2D3]]<br />
* [[Building a cloud with Alpine Linux]]<br />
<br />
* [[ISP Mail Server HowTo]] ''(Postfix+PostfixAdmin+DoveCot+Roundcube+ClamAV+Spamd - A full-serivce ISP mail server)''<br />
** [[ISP Mail Server Upgrade 2.x]]<br />
** [[ISP Mail Server 2.x HowTo]] ''(Beta, please test)''<br />
* [[High Availability High Performance Web Cache]] ''(uCarp + HAProxy for High Availability Services such as Squid web proxy)''<br />
* [[Setting up A Network Monitoring and Inventory System]] ''(Nagios + OpenAudit and related components)'' <!-- draft --><br />
* [[Streaming Security Camera Video with VLC]]<br />
* [[Dynamic Multipoint VPN (DMVPN)]] combined with [[Small_Office_Services]]<br />
<br />
<br />
<!--<br />
This does not attempt to be complete. Is it useful to have these listed here? I find them more accessible if grouped with their topics; also, an up-to-date list of all Draft or Obsolete pages can be found at [[Project:Wiki maintenance]].<br />
<br />
== Drafts ==<br />
Currently unfinished/works-in-progress.<br />
* [[Using Racoon for Remote Sites]]<br />
* [[Setting up Transparent Squid Proxy]] ''(Covers Squid proxy and URL Filtering system)''<br />
** [[Obtaining user information via SNMP]] ''(Using the Squark Squid authentication helper)'' [!-- no longer a draft --]<br />
* [[Setting up Streaming an Asterisk Channel]]<br />
* [[Setting up A Network Monitoring and Inventory System]] ''(Nagios + OpenAudit and related components)''<br />
* [[Intrusion Detection using Snort]] ''(Installing and configuring Snort and related applications on Alpine 2.0.x)''<br />
* [[IP Accounting]] ''(Installing and configuring pmacct for IP Accounting, Netflow/sFlow collector)''<br />
* [[Disk Replication with DRBD]]<br />
--><br />
<br />
<br />
[[Category:Newbie]]</div>Rickyrockrathttps://wiki.alpinelinux.org/w/index.php?title=Udhcpc&diff=18439Udhcpc2021-01-02T21:43:19Z<p>Rickyrockrat: </p>
<hr />
<div>{{Expand|Please help us expand this article by contributing.}}<br />
<br />
You may want to customize the behavior of the default DHCP client (udhcpc from busybox), which is called by /sbin/ifup by having "dhcp" in /etc/network/interfaces.<br />
<br />
The default behavior is driven by the script /usr/share/udhcpc/default.script <br />
<br />
Entries in /etc/network/interfaces for dhcp interfaces will drive the udhcpc command line. For example:<br><br />
<br />
<pre> <br />
auto eth0<br />
iface eth0 inet dhcp<br />
hostname myhostname<br />
</pre> <br />
Will set these parameters on the command line:<br><br />
<br />
<b>-i eth0 -x hostname:myhostname</b><br><br />
<br />
The hostname will send the DHCP option to the server to tell the server the name of this client. <br />
<br />
The documentation resides [https://udhcp.busybox.net/README.udhcpc Here]<br><br />
<br />
Its default configuration may be overwritten by /etc/udhcpc/udhcpc.conf<br />
<br />
Authorized key:value pairs are:<br />
<br />
{| cellpadding="15" border="1" class="wikitable"<br />
|-<br />
! key<br />
| default value<br />
| possible values<br />
|-<br />
| NO_GATEWAY<br />
| -<br />
| <list of iface names><br />
|-<br />
| IF_METRIC<br />
| -<br />
| <metric value><br />
|-<br />
| IF_PEER_DNS<br />
| yes<br />
| <anything but yes><br />
|-<br />
| RESOLV_CONF<br />
| /etc/resolv.conf<br />
| no ; NO ; -<br />
|-<br />
| NO_DNS<br />
| -<br />
| <list of iface names><br />
|}<br />
<br />
Example /etc/udhcpc/udhcpc.conf:<br />
<br />
RESOLV_CONF="no" # Prevents overwriting of /etc/resolv.conf<br />
<br />
Custom scripts can be added as /etc/udhcpc/pre-* and /etc/udhcpc/post-* to be run before/after deconfig/renew/bound DHCP events - they must be marked as '''executable''' by root, e.g. chmod 744<br />
<br />
As an example, /etc/udhcpc/post-bound/mtu could contain, to change the interface MTU from the default (1500) to 1492, which is useful if [https://en.wikipedia.org/wiki/Maximum_transmission_unit on ADSL] (which uses 8 bytes):<br />
<br />
r=$(/sbin/ip route | grep ^default | head -n 1)<br />
# Needs iproute2 package, rather than busybox's "ip", to change mtu<br />
/sbin/ip route replace $r mtu 1492<br><br />
<b>hack alert</b><br />
I needed to restart my firewall (which replaces the iptables script from Alpine) when the client binds to a new IP, so I added the following line in the function bound(), right after 'resolvconf':<br><br />
/etc/init.d/iptables reload<br><br />
<br><br />
The reload drops all firewall rules, re-acquires the Internal and external IPs, and re-writes the rules. I'm sure there is a better way.<br />
<br />
[[Category:Networking]]<br />
[[Category:Embedded Systems]]</div>Rickyrockrathttps://wiki.alpinelinux.org/w/index.php?title=Udhcpc&diff=18438Udhcpc2021-01-02T21:35:30Z<p>Rickyrockrat: </p>
<hr />
<div>{{Expand|Please help us expand this article by contributing.}}<br />
<br />
You may want to customize the behavior of the default DHCP client (udhcpc from busybox), which is called by /sbin/ifup by having "dhcp" in /etc/network/interfaces.<br />
<br />
The default behavior is driven by the script /usr/share/udhcpc/default.script <br />
<br />
Entries in /etc/network/interfaces for dhcp interfaces will drive the udhcpc command line. For example:<br><br />
<br />
<pre> <br />
auto eth0<br />
iface eth0 inet dhcp<br />
hostname myhostname<br />
</pre> <br />
Will set these parameters on the command line:<br><br />
<br />
<b>-i eth0 -x hostname:myhostname</b><br><br />
<br />
The hostname will send the DHCP option to the server to tell the server the name of this client. <br />
<br />
<br />
Its default configuration may be overwritten by /etc/udhcpc/udhcpc.conf<br />
<br />
Authorized key:value pairs are:<br />
<br />
{| cellpadding="15" border="1" class="wikitable"<br />
|-<br />
! key<br />
| default value<br />
| possible values<br />
|-<br />
| NO_GATEWAY<br />
| -<br />
| <list of iface names><br />
|-<br />
| IF_METRIC<br />
| -<br />
| <metric value><br />
|-<br />
| IF_PEER_DNS<br />
| yes<br />
| <anything but yes><br />
|-<br />
| RESOLV_CONF<br />
| /etc/resolv.conf<br />
| no ; NO ; -<br />
|-<br />
| NO_DNS<br />
| -<br />
| <list of iface names><br />
|}<br />
<br />
Example /etc/udhcpc/udhcpc.conf:<br />
<br />
RESOLV_CONF="no" # Prevents overwriting of /etc/resolv.conf<br />
<br />
Custom scripts can be added as /etc/udhcpc/pre-* and /etc/udhcpc/post-* to be run before/after deconfig/renew/bound DHCP events - they must be marked as '''executable''' by root, e.g. chmod 744<br />
<br />
As an example, /etc/udhcpc/post-bound/mtu could contain, to change the interface MTU from the default (1500) to 1492, which is useful if [https://en.wikipedia.org/wiki/Maximum_transmission_unit on ADSL] (which uses 8 bytes):<br />
<br />
r=$(/sbin/ip route | grep ^default | head -n 1)<br />
# Needs iproute2 package, rather than busybox's "ip", to change mtu<br />
/sbin/ip route replace $r mtu 1492<br />
<br />
[[Category:Networking]]<br />
[[Category:Embedded Systems]]</div>Rickyrockrathttps://wiki.alpinelinux.org/w/index.php?title=Udhcpc&diff=18437Udhcpc2021-01-02T21:35:18Z<p>Rickyrockrat: </p>
<hr />
<div>{{Expand|Please help us expand this article by contributing.}}<br />
<br />
You may want to customize the behavior of the default DHCP client (udhcpc from busybox), which is called by /sbin/ifup by having "dhcp" in /etc/network/interfaces.<br />
<br />
The default behavior is driven by the script /usr/share/udhcpc/default.script <br />
<br />
Entries in /etc/network/interfaces for dhcp interfaces will drive the udhcpc command line. For example:<br><br />
<br />
<pre> <br />
auto eth0<br />
iface eth0 inet dhcp<br />
hostname myhostname<br />
</pre> <br />
Will set these parameters on the command line:<br><br />
<br />
<b>-i eth0 -x hostname:myhostname<b><br><br />
<br />
The hostname will send the DHCP option to the server to tell the server the name of this client. <br />
<br />
<br />
Its default configuration may be overwritten by /etc/udhcpc/udhcpc.conf<br />
<br />
Authorized key:value pairs are:<br />
<br />
{| cellpadding="15" border="1" class="wikitable"<br />
|-<br />
! key<br />
| default value<br />
| possible values<br />
|-<br />
| NO_GATEWAY<br />
| -<br />
| <list of iface names><br />
|-<br />
| IF_METRIC<br />
| -<br />
| <metric value><br />
|-<br />
| IF_PEER_DNS<br />
| yes<br />
| <anything but yes><br />
|-<br />
| RESOLV_CONF<br />
| /etc/resolv.conf<br />
| no ; NO ; -<br />
|-<br />
| NO_DNS<br />
| -<br />
| <list of iface names><br />
|}<br />
<br />
Example /etc/udhcpc/udhcpc.conf:<br />
<br />
RESOLV_CONF="no" # Prevents overwriting of /etc/resolv.conf<br />
<br />
Custom scripts can be added as /etc/udhcpc/pre-* and /etc/udhcpc/post-* to be run before/after deconfig/renew/bound DHCP events - they must be marked as '''executable''' by root, e.g. chmod 744<br />
<br />
As an example, /etc/udhcpc/post-bound/mtu could contain, to change the interface MTU from the default (1500) to 1492, which is useful if [https://en.wikipedia.org/wiki/Maximum_transmission_unit on ADSL] (which uses 8 bytes):<br />
<br />
r=$(/sbin/ip route | grep ^default | head -n 1)<br />
# Needs iproute2 package, rather than busybox's "ip", to change mtu<br />
/sbin/ip route replace $r mtu 1492<br />
<br />
[[Category:Networking]]<br />
[[Category:Embedded Systems]]</div>Rickyrockrathttps://wiki.alpinelinux.org/w/index.php?title=Udhcpc&diff=18436Udhcpc2021-01-02T21:34:45Z<p>Rickyrockrat: </p>
<hr />
<div>{{Expand|Please help us expand this article by contributing.}}<br />
<br />
You may want to customize the behavior of the default DHCP client (udhcpc from busybox), which is called by /sbin/ifup by having "dhcp" in /etc/network/interfaces.<br />
<br />
The default behavior is driven by the script /usr/share/udhcpc/default.script <br />
<br />
Entries in /etc/network/interfaces for dhcp interfaces will drive the udhcpc command line. For example:<br><br />
<br />
<pre> <br />
auto eth0<br />
iface eth0 inet dhcp<br />
hostname myhostname<br />
</pre> <br />
Will set these parameters on the command line: <br />
-i eth0 -x hostname:myhostname <br />
<br />
The hostname will send the DHCP option to the server to tell the server the name of this client. <br />
<br />
<br />
Its default configuration may be overwritten by /etc/udhcpc/udhcpc.conf<br />
<br />
Authorized key:value pairs are:<br />
<br />
{| cellpadding="15" border="1" class="wikitable"<br />
|-<br />
! key<br />
| default value<br />
| possible values<br />
|-<br />
| NO_GATEWAY<br />
| -<br />
| <list of iface names><br />
|-<br />
| IF_METRIC<br />
| -<br />
| <metric value><br />
|-<br />
| IF_PEER_DNS<br />
| yes<br />
| <anything but yes><br />
|-<br />
| RESOLV_CONF<br />
| /etc/resolv.conf<br />
| no ; NO ; -<br />
|-<br />
| NO_DNS<br />
| -<br />
| <list of iface names><br />
|}<br />
<br />
Example /etc/udhcpc/udhcpc.conf:<br />
<br />
RESOLV_CONF="no" # Prevents overwriting of /etc/resolv.conf<br />
<br />
Custom scripts can be added as /etc/udhcpc/pre-* and /etc/udhcpc/post-* to be run before/after deconfig/renew/bound DHCP events - they must be marked as '''executable''' by root, e.g. chmod 744<br />
<br />
As an example, /etc/udhcpc/post-bound/mtu could contain, to change the interface MTU from the default (1500) to 1492, which is useful if [https://en.wikipedia.org/wiki/Maximum_transmission_unit on ADSL] (which uses 8 bytes):<br />
<br />
r=$(/sbin/ip route | grep ^default | head -n 1)<br />
# Needs iproute2 package, rather than busybox's "ip", to change mtu<br />
/sbin/ip route replace $r mtu 1492<br />
<br />
[[Category:Networking]]<br />
[[Category:Embedded Systems]]</div>Rickyrockrathttps://wiki.alpinelinux.org/w/index.php?title=Udhcpc&diff=18435Udhcpc2021-01-02T21:33:06Z<p>Rickyrockrat: </p>
<hr />
<div>{{Expand|Please help us expand this article by contributing.}}<br />
<br />
You may want to customize the behavior of the default DHCP client (udhcpc from busybox), which is called by /sbin/ifup by having "dhcp" in /etc/network/interfaces.<br />
<br />
The default behavior is driven by the script /usr/share/udhcpc/default.script <br />
<br />
Entries in /etc/network/interfaces for dhcp interfaces will drive the udhcpc command line. For example: <br />
<br />
auto eth0<br />
iface eth0 inet dhcp<br />
hostname myhostname<br />
<br />
Will set these parameters on the command line: <br />
-i eth0 -x hostname:myhostname <br />
<br />
The hostname will send the DHCP option to the server to tell the server the name of this client. <br />
<br />
<br />
Its default configuration may be overwritten by /etc/udhcpc/udhcpc.conf<br />
<br />
Authorized key:value pairs are:<br />
<br />
{| cellpadding="15" border="1" class="wikitable"<br />
|-<br />
! key<br />
| default value<br />
| possible values<br />
|-<br />
| NO_GATEWAY<br />
| -<br />
| <list of iface names><br />
|-<br />
| IF_METRIC<br />
| -<br />
| <metric value><br />
|-<br />
| IF_PEER_DNS<br />
| yes<br />
| <anything but yes><br />
|-<br />
| RESOLV_CONF<br />
| /etc/resolv.conf<br />
| no ; NO ; -<br />
|-<br />
| NO_DNS<br />
| -<br />
| <list of iface names><br />
|}<br />
<br />
Example /etc/udhcpc/udhcpc.conf:<br />
<br />
RESOLV_CONF="no" # Prevents overwriting of /etc/resolv.conf<br />
<br />
Custom scripts can be added as /etc/udhcpc/pre-* and /etc/udhcpc/post-* to be run before/after deconfig/renew/bound DHCP events - they must be marked as '''executable''' by root, e.g. chmod 744<br />
<br />
As an example, /etc/udhcpc/post-bound/mtu could contain, to change the interface MTU from the default (1500) to 1492, which is useful if [https://en.wikipedia.org/wiki/Maximum_transmission_unit on ADSL] (which uses 8 bytes):<br />
<br />
r=$(/sbin/ip route | grep ^default | head -n 1)<br />
# Needs iproute2 package, rather than busybox's "ip", to change mtu<br />
/sbin/ip route replace $r mtu 1492<br />
<br />
[[Category:Networking]]<br />
[[Category:Embedded Systems]]</div>Rickyrockrathttps://wiki.alpinelinux.org/w/index.php?title=Udhcpc&diff=18434Udhcpc2021-01-02T21:31:20Z<p>Rickyrockrat: Added options from interfaces file.</p>
<hr />
<div>{{Expand|Please help us expand this article by contributing.}}<br />
<br />
You may want to customize the behavior of the default DHCP client (udhcpc from busybox), which is called by /sbin/ifup by having "dhcp" in /etc/network/interfaces.<br />
<br />
The default behavior is driven by the script /usr/share/udhcpc/default.script <br />
<br />
Entries in /etc/network/interfaces for dhcp interfaces will drive the udhcpc command line. For example: <br />
'''<br />
auto eth0<br />
iface eth0 inet dhcp<br />
hostname myhostname<br />
'''<br />
Will set these parameters on the command line: <br />
-i eth0 -x hostname:myhostname <br />
<br />
The hostname will send the DHCP option to the server to tell the server the name of this client. <br />
<br />
<br />
Its default configuration may be overwritten by /etc/udhcpc/udhcpc.conf<br />
<br />
Authorized key:value pairs are:<br />
<br />
{| cellpadding="15" border="1" class="wikitable"<br />
|-<br />
! key<br />
| default value<br />
| possible values<br />
|-<br />
| NO_GATEWAY<br />
| -<br />
| <list of iface names><br />
|-<br />
| IF_METRIC<br />
| -<br />
| <metric value><br />
|-<br />
| IF_PEER_DNS<br />
| yes<br />
| <anything but yes><br />
|-<br />
| RESOLV_CONF<br />
| /etc/resolv.conf<br />
| no ; NO ; -<br />
|-<br />
| NO_DNS<br />
| -<br />
| <list of iface names><br />
|}<br />
<br />
Example /etc/udhcpc/udhcpc.conf:<br />
<br />
RESOLV_CONF="no" # Prevents overwriting of /etc/resolv.conf<br />
<br />
Custom scripts can be added as /etc/udhcpc/pre-* and /etc/udhcpc/post-* to be run before/after deconfig/renew/bound DHCP events - they must be marked as '''executable''' by root, e.g. chmod 744<br />
<br />
As an example, /etc/udhcpc/post-bound/mtu could contain, to change the interface MTU from the default (1500) to 1492, which is useful if [https://en.wikipedia.org/wiki/Maximum_transmission_unit on ADSL] (which uses 8 bytes):<br />
<br />
r=$(/sbin/ip route | grep ^default | head -n 1)<br />
# Needs iproute2 package, rather than busybox's "ip", to change mtu<br />
/sbin/ip route replace $r mtu 1492<br />
<br />
[[Category:Networking]]<br />
[[Category:Embedded Systems]]</div>Rickyrockrat