Alpine Linux:FAQ: Difference between revisions

From Alpine Linux
(→‎Why don't I have man pages or where is the 'man' command?: clarified the concept of documentation sub-packages and docs meta-package)
(11 intermediate revisions by 5 users not shown)
Line 14: Line 14:
A broader overview may be found on the official [https://alpinelinux.org/about About] page and at the [[Alpine Linux:Overview|wiki overview]].
A broader overview may be found on the official [https://alpinelinux.org/about About] page and at the [[Alpine Linux:Overview|wiki overview]].


Please note that testing is safer on your own virtual machine or on a public [https://distrotest.net/AlpineLinux/ DistroTest.net].
Please note that testing is safer on your own virtual machine.


== I have found a bug, where can I report it? ==
== I have found a bug, where can I report it? ==
Line 29: Line 29:
* Flag packages as outdated in the [https://pkgs.alpinelinux.org/packages package database], or even better enable release monitoring in [https://release-monitoring.org/ Anitya] for them.
* Flag packages as outdated in the [https://pkgs.alpinelinux.org/packages package database], or even better enable release monitoring in [https://release-monitoring.org/ Anitya] for them.
* In many other ways.
* In many other ways.
Please visit [[Contribute|Contribute page]] to read more about this topic.
Please visit the [[Contribute|Contribute page]] to read more about this topic.


== Why don't I have man pages or where is the 'man' command? ==
== Why don't I have man pages or where is the 'man' command? ==
The <code>man</code> command and '''man pages''' are not installed by default.


The <code>man</code> command and '''man pages''' are not installed by default. In addition to man pages, documentation in all other forms are also not installed by default.
All such documentation are however available as sub-packages in the format '''packagename-doc'''. For eg. documentation sub-package for {{pkg|busybox}} is named as {{pkg|busybox-doc}}.
=== Documentation for all packages ===
The {{pkg|docs}} meta package installs the documentation sub-package for all the currently installed packages along with necessary tools like {{pkg|mandoc}} and {{pkg|man-pages}}.
{{cmd|# apk add docs}}
This {{pkg|docs}} meta package ensures that documentation sub-packages are installed or removed automatically for any packages that you may add/remove in future.
Keep in mind not all packages have a corresponding documentation package and even when it has one it may not be in the form '''man pages'''.
=== Documentation for specific packages ===
To install man pages for specific packages only, for example during installation or configuration, follow the two steps:
==== Mandatory tools for using documentation sub-packages ====
Install the <code>man</code> command:
Install the <code>man</code> command:
{{cmd|# apk add mandoc}}
{{cmd|# apk add {{pkg|mandoc}}}}
Install basic manual pages.  {{pkg|man-pages}} package provides the system's ''core'' manual pages:
Install basic manual pages.  {{pkg|man-pages}} package provides the system's ''core'' manual pages:
{{cmd|# apk add man-pages}}
{{cmd|# apk add man-pages}}
==== Installing documentation for a specific package ====
Once the above tools are installed, add documentation for the speific package which you need.  For example, say you installed {{pkg|nftables}} and you now require its '''man pages''':
{{cmd|# apk add {{pkg|nftables-doc}}}}
=== Advanced tools for using documentation sub-packages ===
Install the <code>apropos</code> command to search in '''man pages''':
Install the <code>apropos</code> command to search in '''man pages''':
{{cmd|# apk add mandoc-apropos}}
{{cmd|# apk add {{pkg|mandoc-apropos}}}}
Once installed, add documentation for the package where you need it.  For example, say you installed {{pkg|nftables}} and you now require its '''man pages''':
{{cmd|# apk add nftables-doc}}
To always install the documentation companion package add the {{pkg|docs}} meta package.  Keep in mind not all packages have a corresponding documentation package and even when it has one it may not include '''man pages''':
{{cmd|# apk add docs}}


== What is the difference between edge and stable releases? ==
== What is the difference between edge and stable releases? ==
Line 49: Line 68:


[[Repositories#Edge|Edge]] is more of a rolling-release, with the latest and greatest packages available in the online repositories.<br />
[[Repositories#Edge|Edge]] is more of a rolling-release, with the latest and greatest packages available in the online repositories.<br />
Occasionally, snapshot ISO images of the then-current state of [[Repositories#Edge|edge]] are made and are available for download.<br />
Occasionally, snapshot ISO images of the then-current state of edge are made and are available for download.<br />
Typically these are made when there are major kernel upgrades or package upgrades that require initramfs rebuilds.
Typically these are made when there are major kernel upgrades or package upgrades that require initramfs rebuilds.


Line 58: Line 77:
* '''s390x''': IBM mainframes using the z/Architecture (z196 minimum)
* '''s390x''': IBM mainframes using the z/Architecture (z196 minimum)
* '''ppc64le''': 64-bit little-endian POWER devices (e.g. Raptor Talos II) (POWER8 minimum)
* '''ppc64le''': 64-bit little-endian POWER devices (e.g. Raptor Talos II) (POWER8 minimum)
* '''x86''': 32-bit Intel and AMD processors commonly found in older personal computers (e.g. Pentium M+). Can also run on x86_64 machines (not recommended). Requires SSE2.
* '''x86''': 32-bit Intel and AMD processors commonly found in older personal computers (e.g. Pentium M+). Can also run on x86_64 machines (not recommended). Requires SSE2 and CMOV.
* '''x86_64''': 64-bit Intel and AMD processors commonly found in personal computers (e.g. Core i7, Ryzen 7)
* '''x86_64''': 64-bit Intel and AMD processors commonly found in personal computers (e.g. Core i7, Ryzen 7)
'''Please check [https://alpinelinux.org/downloads Download] page for media availability on each one''' and check [https://alpinelinux.org/releases/ Release Branches] page for latest.
'''Please check [https://alpinelinux.org/downloads Download] page for media availability on each one''' and check [https://alpinelinux.org/releases/ Release Branches] page for latest.
Line 81: Line 100:


To upgrade to a new stable release or edge:
To upgrade to a new stable release or edge:
<code>apk upgrade --available</code>
{{ic|apk upgrade --available}}


==Why don't my cron jobs run?==
==Why don't my cron jobs run?==


Start service ''crond'' and add it to runlevel:
Start service ''crond'' and add it to the default runlevel:


: {{cmd|rc-service crond start && rc-update add crond}}
: {{cmd|rc-service crond start && rc-update add crond}}
Line 121: Line 140:
It means that the package you tried to install does not exist in the repositories you have configured.  
It means that the package you tried to install does not exist in the repositories you have configured.  


Maybe you forgot to add community, testing or unmaintained to ''/etc/apk/repositories''?  
Maybe you forgot to add community or testing to {{path|/etc/apk/repositories}}?  


Or is the package in a [[Alpine_Linux_package_management#Repository_pinning|pinned repository]] and you forgot to suffix the package with the repo tag? Example:
Or is the package in a [[Alpine Package Keeper#Repository pinning|pinned repository]] and you forgot to suffix the package with the repo tag? Example:


{{cmd|apk add experimental-package@testing}}
{{cmd|apk add experimental-package@testing}}
Line 171: Line 190:


{{cmd|apk add less}}
{{cmd|apk add less}}
Additionally, for colorized diff while using verbose commit (<tt>git commit -v</tt>), add this to shell init scripts (e.g.: {{Path|~/.profile}}):
{{Cat|~/.profile|<nowiki>export GIT_EDITOR=vim</nowiki>}}


== Fix lacking lsusb / lspci output ==
== Fix lacking lsusb / lspci output ==


If you launch <code>lsusb</code> or <code>lspci</code> on a minimal installation, there's no device descriptions, and the latter doesn't exist.
If you launch {{ic|lsusb}} or {{ic|lspci}} on a minimal installation, there's no device descriptions, and the latter doesn't exist.
This can be fixed by installing the hwdata tables, '''hwdata-uwb''' or '''hwdata-pci''' respectively. For <code>lspci</code>, add '''pciutils'''.
This can be fixed by installing the hwdata tables, '''{{pkg|hwdata-usb}}''' or '''{{pkg|hwdata-pci}}''' respectively. For {{ic|lspci}}, add '''{{pkg|pciutils}}'''.


= Old questions, no longer frequently asked =
= Old questions, no longer frequently asked =

Revision as of 15:15, 10 August 2024

This is a list of frequently asked questions about Alpine Linux.
If your question is not answered on this page, use the search box above to find work in progress pages not linked here, or in case of no answer, edit this page and write down your question.

Tip: Prepare your question. Think it through. Make it simple and understandable.

General

Alpine Linux is used heavily in containers (e.g. Docker images) on servers, so many of its main packages are focused on server services.

Where to start?

The Installation page and the Post Installation section on that page, provide a basic orientation.

A broader overview may be found on the official About page and at the wiki overview.

Please note that testing is safer on your own virtual machine.

I have found a bug, where can I report it?

You can report it on the bugtracker, but search it first to see if the issue has already been reported.

Are there any details about the releases available?

Yes, please check the releases page.

How can I contribute?

You can contribute by:

Please visit the Contribute page to read more about this topic.

Why don't I have man pages or where is the 'man' command?

The man command and man pages are not installed by default. In addition to man pages, documentation in all other forms are also not installed by default.

All such documentation are however available as sub-packages in the format packagename-doc. For eg. documentation sub-package for busybox is named as busybox-doc.

Documentation for all packages

The docs meta package installs the documentation sub-package for all the currently installed packages along with necessary tools like mandoc and man-pages.

# apk add docs

This docs meta package ensures that documentation sub-packages are installed or removed automatically for any packages that you may add/remove in future.

Keep in mind not all packages have a corresponding documentation package and even when it has one it may not be in the form man pages.

Documentation for specific packages

To install man pages for specific packages only, for example during installation or configuration, follow the two steps:

Mandatory tools for using documentation sub-packages

Install the man command:

# apk add mandoc

Install basic manual pages. man-pages package provides the system's core manual pages:

# apk add man-pages

Installing documentation for a specific package

Once the above tools are installed, add documentation for the speific package which you need. For example, say you installed nftables and you now require its man pages:

# apk add nftables-doc

Advanced tools for using documentation sub-packages

Install the apropos command to search in man pages:

# apk add mandoc-apropos

What is the difference between edge and stable releases?

Stable releases are just what they sound like: initially a point-in-time snapshot of the package archives, but then maintained with bugfixes only in order to keep a stable environment.

Edge is more of a rolling-release, with the latest and greatest packages available in the online repositories.
Occasionally, snapshot ISO images of the then-current state of edge are made and are available for download.
Typically these are made when there are major kernel upgrades or package upgrades that require initramfs rebuilds.

What architectures does Alpine Linux support?

  • aarch64: 64-bit ARM processors (e.g. Raspberry Pi 4)
  • armhf: 32-bit ARMv6 processors with a floating point unit (e.g. Raspberry Pi 1) (armv6hf)
  • armv7: 32-bit ARMv7 processors with a floating point unit (armv7hf)
  • s390x: IBM mainframes using the z/Architecture (z196 minimum)
  • ppc64le: 64-bit little-endian POWER devices (e.g. Raptor Talos II) (POWER8 minimum)
  • x86: 32-bit Intel and AMD processors commonly found in older personal computers (e.g. Pentium M+). Can also run on x86_64 machines (not recommended). Requires SSE2 and CMOV.
  • x86_64: 64-bit Intel and AMD processors commonly found in personal computers (e.g. Core i7, Ryzen 7)

Please check Download page for media availability on each one and check Release Branches page for latest.

What kinds of release of Alpine Linux are available?

Please check the Release Branches page for more information.

Setup

What is the difference between sys, data, and diskless when running setup-alpine or setup-disk?

sys: This mode is a traditional disk install. The following partitions will be created on the disk: /boot/, / (filesystem root) and swap. This mode may be used for development boxes, desktops, virtual servers, etc.

data: This mode uses your disk(s) for data storage, not for the operating system. Runs from the media and only a /var/ is created on disk. The system itself will run from a tmpfs (RAM). Use this mode if you only want to use the disk(s) for data, like mailspool, databases, logs, etc.

diskless: No disks are to be used. Alpine local backup may still be used in this mode.

These modes are explained further on the Installation page.

How do I upgrade Alpine?

To upgrade to a new stable release or edge: apk upgrade --available

Why don't my cron jobs run?

Start service crond and add it to the default runlevel:

rc-service crond start && rc-update add crond

After that the cron daemon is started automatically on system boot and executes the scripts placed in the folders under /etc/periodic/ - there are folders for 15min, hourly, daily, weekly and monthly scripts.

To check whether your scripts are likely to run, use the run-parts command, for example:

run-parts --test /etc/periodic/15min

This command will tell you what should run but will not actually execute the scripts.

If the results of the test are not as expected, check the following:

  • Make sure the script is executable - if unsure, issue the command

    chmod +x /etc/periodic/[path/scriptname]

  • Make sure the first line of your script is #!/bin/sh
  • Do not use periods on your script file names - this stops them from working; for example: /etc/periodic/daily/myscript will run, but /etc/periodic/daily/myscript.sh won't.

Time and timezones

How do I set the local timezone?

If you wish to edit the timezone (TZ) after installation, run the setup-timezone script.

Packages

Can you build an APK package for ...?

Please create an issue in the bugtracker. Prefix it with "package request:" in the title and include a short description (one-line), a URL for the home page, why you need it, and a URL for the source package.

How can I build my own package?

Please see the Creating an Alpine package page.

What does "required by: world[$pkgname]" mean?

It means that the package you tried to install does not exist in the repositories you have configured.

Maybe you forgot to add community or testing to /etc/apk/repositories?

Or is the package in a pinned repository and you forgot to suffix the package with the repo tag? Example:

apk add experimental-package@testing

How can I find out if a certain package exists in Alpine?

If you want to only search repositories you have configured in /etc/apk/repositories, then apk search $pkgname should get you sorted. If you want to search all repositories have a look at the online pkg oracle

WARNING: Ignoring APKINDEX.xxxx.tar.gz

If you get WARNING: Ignoring APKINDEX.xxxx.tar.gz: No such file or directory while running package related tools, check your /etc/apk/repositories file.

To check the content of the repositories file

cat /etc/apk/repositories

or

setup-apkrepos

Dynamic DNS

How do I schedule a regular dynamic DNS update?

You'll want to install the ez-ipupdate package:

apk add ez-ipupdate

After that, create a new file at /etc/ez-ipupdate.conf with contents similar to:

service-type=dyndns
user=myusername:mypassword
interface=eth1
host=myhostname.dyndns.org

Make the new ip cache directory:

mkdir /var/cache/ez-ipupdate lbu add /var/cache/ez-ipupdate

Then schedule a new cron job with this command:

echo >> /var/log/ez-ipupdate && \
/bin/date >> /var/log/ez-ipupdate && \
ez-ipupdate --config-file /etc/ez-ipupdate.conf -f -F /var/run/ez-ipupdate.pid \
--cache-file /var/cache/ez-ipupdate/ipcache --quiet >> /var/log/ez-ipupdate 2>&1

Don't forget to backup your settings!

lbu ci

Terminal

How to enable/fix colors for git?

The problem is not in git itself or terminal, but in the less command. Busybox’s less doesn’t support -r (--raw-control-chars) and -R (--RAW-CONTROL-CHARS) options.

The simplest (yet not ideal) solution is to install GNU less:

apk add less

Additionally, for colorized diff while using verbose commit (git commit -v), add this to shell init scripts (e.g.: ~/.profile):

Contents of ~/.profile

export GIT_EDITOR=vim

Fix lacking lsusb / lspci output

If you launch lsusb or lspci on a minimal installation, there's no device descriptions, and the latter doesn't exist. This can be fixed by installing the hwdata tables, hwdata-usb or hwdata-pci respectively. For lspci, add pciutils.

Old questions, no longer frequently asked

Alpine freezes during boot from Compact Flash, how can I fix?

Most Compact Flash card readers do not support proper DMA.
You should append nodma to the append line in syslinux.cfg.

How do I remove the CD-ROM?

Since the modloop loopback device is on CD-ROM you cannot just run eject. You need to unmount the modloop first.
Unmounting both the modloop and the CDROM in one step can be done by executing:

/etc/init.d/modloop stop

Then it's possible to eject the CD-ROM:

eject

How can I install custom firmware in a diskless system?

The modules and firmware are both special images which are mounted as read-only.
To fix this issue you can copy the firmware directory to your writeable media (cf/usb) and copy your custom firmware to it.
After reboot Alpine should automatically use the directory on your local storage instead of the loopback device.

OpenNTPD reports an error with "adjtime"

Your log contains something like:

reply from 85.214.86.126: offset 865033148.784255 delay 0.055466, next query 32s
reply from 202.150.212.24: offset 865033148.779314 delay 0.400771, next query 3s
adjusting local clock by 865033148.779835s                                      
adjtime failed: Invalid argument    

openntpd is supposed to make small adjustments in the time without causing time jumps.
If the adjustment is too big then something is clearly wrong and ntpd gives up. (its actually adjtime(3) that has a limit on how big adjustments are allowed)

You can make ntpd set the time at startup by adding -s option to ntpd. This is done by setting NTPD_OPTS="-s" in /etc/conf.d/ntpd.

Using a cron job to keep the time in sync

Add the following to /etc/periodic/daily (or use another folder under the /etc/periodic hierarchy if you want to run the script more/less frequently)

Example: file called do-ntp

#!/bin/sh
ntpd -d -q -n -p uk.pool.ntp.org

This queries the uk time server pool - you can modify this to suit your localisation, or just use pool.ntp.org. More info here: https://www.pool.ntp.org/zone/@

Windows clients reports an error when trying to sync

openntpd needs to run for a while before it is satisfied it is in sync. Until then it will set a flag "clock not synchronized" and Windows will report an error while trying to sync with your openntpd server.

Only thing to do is wait, do something else for 15-20mins and then check.