Local APK cache: Difference between revisions

From Alpine Linux
(...sorry, not shorter but organized. Using "the" etc. also makes it easier to read and understand.)
(adj title depth to suite apk page)
Line 13: Line 13:
The cache can be stored on any writable media, or in the same location as the .apkovl file from the [[Alpine_local_backup| local backup utility <code>lbu</code>]].
The cache can be stored on any writable media, or in the same location as the .apkovl file from the [[Alpine_local_backup| local backup utility <code>lbu</code>]].


= Enabling Local Cache =
== Enabling Local Cache ==


== Enabling Local Cache with current releases ==
=== Enabling Local Cache with current releases ===


Execute the script {{Cmd|setup-apkcache}} and it will assist in enabling a local cache.
Execute the script {{Cmd|setup-apkcache}} and it will assist in enabling a local cache.
Line 22: Line 22:




= Cache maintenance =
== Cache maintenance ==


== Removing older packages ==
=== Removing older packages ===


When newer packages are added to the cache over time, the older versions of the packages default to remain in the cache directory.   
When newer packages are added to the cache over time, the older versions of the packages default to remain in the cache directory.   
Line 30: Line 30:
The older versions of packages can be removed with the '''clean''' command.  {{cmd|apk cache clean}} Or to see what is deleted include the verbose switch: {{cmd|apk -v cache clean}}
The older versions of packages can be removed with the '''clean''' command.  {{cmd|apk cache clean}} Or to see what is deleted include the verbose switch: {{cmd|apk -v cache clean}}


== Download missing packages ==
=== Download missing packages ===
If you accidentally delete packages from the cache directory, you can make sure they are there with the '''download''' command, {{cmd|apk cache download}}
If you accidentally delete packages from the cache directory, you can make sure they are there with the '''download''' command, {{cmd|apk cache download}}


== Delete and download in one step ==
=== Delete and download in one step ===
You can combine the two steps into one with the '''sync''' command - this cleans out old packages and downloads missing packages. {{cmd|apk cache -v sync}}
You can combine the two steps into one with the '''sync''' command - this cleans out old packages and downloads missing packages. {{cmd|apk cache -v sync}}


== Automatically Cleaning Cache on Reboot ==
=== Automatically Cleaning Cache on Reboot ===
To automatically attempt to validate your cache on reboot, you can add the above command to a {{Path|/etc/local.d/*.stop}} file:
To automatically attempt to validate your cache on reboot, you can add the above command to a {{Path|/etc/local.d/*.stop}} file:


Line 56: Line 56:




= Special Caching Cases =
== Special Caching Cases ==


== Enabling Local Cache on HDD installs ==
=== Enabling Local Cache on HDD installs ===


Note that HDD 'sys' installs don't need an apk cache to maintain their state, it allows to serve packages over the network, though, e.g. to get installed by other local machines.
Note that HDD 'sys' installs don't need an apk cache to maintain their state, it allows to serve packages over the network, though, e.g. to get installed by other local machines.
Line 66: Line 66:
ln -s /var/cache/apk /etc/apk/cache}}
ln -s /var/cache/apk /etc/apk/cache}}


== Manually Enabling Local Cache (required with releases prior to v2.3) ==
=== Manually Enabling Local Cache (required with releases prior to v2.3) ===


# Create a '''cache''' directory on the storage device where you keep the lbu backups (typically, <code>/dev/sda1</code>.)  {{Cmd| mkdir /media/sda1/cache }}
# Create a '''cache''' directory on the storage device where you keep the lbu backups (typically, <code>/dev/sda1</code>.)  {{Cmd| mkdir /media/sda1/cache }}
Line 77: Line 77:




== Local Cache on tmpfs volumes ==
=== Local Cache on tmpfs volumes ===


In some circumstances it might be useful to have the cache reside on tmpfs, for example if you only wish for it to last as long as the system is up.
In some circumstances it might be useful to have the cache reside on tmpfs, for example if you only wish for it to last as long as the system is up.

Revision as of 11:36, 9 May 2020

This page seems to be a redundant copy, taken out of context from Alpine_Linux_package_management#Local_Cache

Please check to fully including this in Alpine_Linux_package_management#Local_Cache, and avoid/remove the redundant duplication at Local_APK_cache.



Alpine Linux can automatically (re-)install packages from local media into RAM when booting, even before there is a network connection.

To have the packages available during boot, apk can keep a cache of installed packages on a local disk.

The cache can be stored on any writable media, or in the same location as the .apkovl file from the local backup utility lbu.

Enabling Local Cache

Enabling Local Cache with current releases

Execute the script

setup-apkcache

and it will assist in enabling a local cache.

The script creates a symlink named /etc/apk/cache that points to the cache directory.


Cache maintenance

Removing older packages

When newer packages are added to the cache over time, the older versions of the packages default to remain in the cache directory.

The older versions of packages can be removed with the clean command.

apk cache clean

Or to see what is deleted include the verbose switch:

apk -v cache clean

Download missing packages

If you accidentally delete packages from the cache directory, you can make sure they are there with the download command,

apk cache download

Delete and download in one step

You can combine the two steps into one with the sync command - this cleans out old packages and downloads missing packages.

apk cache -v sync

Automatically Cleaning Cache on Reboot

To automatically attempt to validate your cache on reboot, you can add the above command to a /etc/local.d/*.stop file:

Contents of /etc/local.d/cache.stop

#!/bin/sh # verify the local cache on shutdown apk cache -v sync # We should always return 0 return 0
Tip: Usually the only time you need to reboot is when things have gone horribly wrong; so this is a "best effort" to cover forgetting to sync the cache; It is much better to run sync immediately after adding or upgrading packages.
Note: Custom shutdown commands were formerly added to a /etc/conf.d/local; but that method is now deprecated.



Special Caching Cases

Enabling Local Cache on HDD installs

Note that HDD 'sys' installs don't need an apk cache to maintain their state, it allows to serve packages over the network, though, e.g. to get installed by other local machines.

Manually create a cache dir and then symlink it to /etc/apk/cache:

mkdir -p /var/cache/apk ln -s /var/cache/apk /etc/apk/cache

Manually Enabling Local Cache (required with releases prior to v2.3)

  1. Create a cache directory on the storage device where you keep the lbu backups (typically, /dev/sda1.)

    mkdir /media/sda1/cache

Tip: If you get an error that says "mkdir: can't create directory '/media/usbdisk/cache': Read-only file system", then you probably need to remount your disk read-write temporarily. Try

mount -o remount,rw /media/sda1

and then don't forget to run

mount -o remount,ro /media/sda1

when you are done with the following commands
  1. Create a symlink to this directory from /etc/apk/cache.

    ln -s /media/sda1/cache /etc/apk/cache

  2. Run an lbu commit to save the change (/etc/apk/cache is in /etc and is automatically backed up.)

    lbu commit

Tip: If you needed to remount your disk read-write before, run

mount -o remount,ro /media/sda1

now that you are done with saving the changes

Now whenever you run an apk command that pulls a new package from a remote repository, the package is stored on your local media. On startup, Alpine Linux will check the local cache for new packages, and will install them if available.


Local Cache on tmpfs volumes

In some circumstances it might be useful to have the cache reside on tmpfs, for example if you only wish for it to last as long as the system is up.

NOTE: apk is coded to ignore tmpfs caches, and this is correct behaviour in most instances. Using tmpfs as a package cache can consume large amounts of system memory if you install a lot of packages, possibly resulting in a crashed system. You can limit this by restricting the size of your cache to a small number (128M in the example below).

To do it, you need to create an image inside which your cache can live. We do this by creating an image file, formatting it with ext2, and mounting it at /etc/apk/cache.

  • apk add e2fsprogs
  • dd if=/dev/zero of=/apkcache.img bs=1M count=128
  • mkfs.ext2 -F /apkcache.img
  • mkdir -p /etc/apk/cache
  • mount -t ext2 /apkcache.img /etc/apk/cache
  • apk update

As per usual, if you want to download currently installed packages into the cache, use apk cache sync.