Local APK cache - Revision history

Prabuanand: reworded link

2025-12-08T09:12:33Z

reworded link

← Older revision		Revision as of 09:12, 8 December 2025
Line 18:		Line 18:
	== Managing local cache ==		== Managing local cache ==

	[[Alpine Package Keeper#Local Cache\|~~Alpine Package Keeper(APK)~~]] ~~page lists the commands~~ for managing local cache.		[[Alpine Package Keeper#Local Cache\|apk cache]] command provides various options for managing local cache.

	== Automatically cleaning cache on reboot ==		== Automatically cleaning cache on reboot ==

Prabuanand: added wikilink

2025-12-07T05:15:08Z

added wikilink

← Older revision		Revision as of 05:15, 7 December 2025
Line 15:		Line 15:

	On a [[Installation#Diskless_Mode\|diskless]] installation, to make the disk where the cache directory is present be automatically mounted at boot create an empty file {{Path\|.boot_repository}} inside the cache directory.		On a [[Installation#Diskless_Mode\|diskless]] installation, to make the disk where the cache directory is present be automatically mounted at boot create an empty file {{Path\|.boot_repository}} inside the cache directory.

			== Managing local cache ==

			[[Alpine Package Keeper#Local Cache\|Alpine Package Keeper(APK)]] page lists the commands for managing local cache.

	== Automatically cleaning cache on reboot ==		== Automatically cleaning cache on reboot ==

Fossdd: /* Enabling cocal cache */ fix typo

2025-02-18T21:54:40Z

Enabling cocal cache: fix typo

← Older revision		Revision as of 21:54, 18 February 2025
Line 5:		Line 5:
	HDD or [[Installation#System_Disk_Mode\|sys mode]] installs don't need an apk cache to maintain their state, it still allows to serve packages over the network, though, e.g. to get installed by other local machines.		HDD or [[Installation#System_Disk_Mode\|sys mode]] installs don't need an apk cache to maintain their state, it still allows to serve packages over the network, though, e.g. to get installed by other local machines.

	== Enabling ~~cocal~~ cache ==		== Enabling local cache ==

	Execute the script <code>setup-apkcache</code> will assist in enabling a local cache. The script creates a symlink named {{Path\|/etc/apk/cache}} that points to the cache directory.		Execute the script <code>setup-apkcache</code> will assist in enabling a local cache. The script creates a symlink named {{Path\|/etc/apk/cache}} that points to the cache directory.

Prabuanand: moved apk commands from this page to Alpine Package Keeper

2025-02-10T14:54:34Z

moved apk commands from this page to Alpine Package Keeper

← Older revision		Revision as of 14:54, 10 February 2025
Line 1:		Line 1:
	~~<!-- NOTE This page (~~[[~~Local_APK_cache]]~~) ~~also gets included at [[Alpine_Linux_package_management#Local_Cache~~]] ~~to avoid duplication. -->~~		[[Alpine Package Keeper\|Alpine Package Keeper(APK)]] can keep a cache of installed packages on a local disk.
	~~=== Overview ===~~

	~~APK~~ can keep a cache of installed packages on a local disk.

	In [[Installation#Diskless_Mode\|diskless]] installations, since these packages are available during boot, packages can then be automatically (re-)installed from local media into RAM when booting, without requiring, and even before there is a network connection. The cache can be stored on any writable media, or at the same location as the .apkovl file from the [[Alpine_local_backup\| local backup utility <code>lbu</code>]].		In [[Installation#Diskless_Mode\|diskless]] installations, since these packages are available during boot, packages can then be automatically (re-)installed from local media into RAM when booting, without requiring, and even before there is a network connection. The cache can be stored on any writable media, or at the same location as the .apkovl file from the [[Alpine_local_backup\| local backup utility <code>lbu</code>]].
Line 8:		Line 5:
	HDD or [[Installation#System_Disk_Mode\|sys mode]] installs don't need an apk cache to maintain their state, it still allows to serve packages over the network, though, e.g. to get installed by other local machines.		HDD or [[Installation#System_Disk_Mode\|sys mode]] installs don't need an apk cache to maintain their state, it still allows to serve packages over the network, though, e.g. to get installed by other local machines.

	=== Enabling ~~Local Cache =~~==		== Enabling cocal cache ==

	Execute the script <code>setup-apkcache</code> will assist in enabling a local cache. The script creates a symlink named {{Path\|/etc/apk/cache}} that points to the cache directory.		Execute the script <code>setup-apkcache</code> will assist in enabling a local cache. The script creates a symlink named {{Path\|/etc/apk/cache}} that points to the cache directory.
Line 19:		Line 16:
	On a [[Installation#Diskless_Mode\|diskless]] installation, to make the disk where the cache directory is present be automatically mounted at boot create an empty file {{Path\|.boot_repository}} inside the cache directory.		On a [[Installation#Diskless_Mode\|diskless]] installation, to make the disk where the cache directory is present be automatically mounted at boot create an empty file {{Path\|.boot_repository}} inside the cache directory.

	==~~= Cache maintenance ===~~		== Automatically cleaning cache on reboot ==

	~~==== 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. {{cmd\|apk cache clean}} Or to see what is deleted include the verbose switch: {{cmd\|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, {{cmd\|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. {{cmd\|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 {{Path\|/etc/local.d/*.stop}} file:~~

	~~{{Cat\|/etc/local.d/cache.stop\|#!/bin/sh~~

			To automatically attempt to validate your cache on reboot, you can add the above command to a {{Path\|/etc/local.d/*.stop}} file:{{Cat\|/etc/local.d/cache.stop\|#!/bin/sh
	# verify the local cache on shutdown		# verify the local cache on shutdown
	apk cache -v sync		apk cache -v sync

	# We should always return 0		# We should always return 0
	return 0		return 0
Line 47:		Line 27:
	{{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.}}		{{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.}}

	=== 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.
Line 62:		Line 42:

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

			== See also ==

			* [[Alpine local backup\|Local backup utility(LBU)]]
			* [[Alpine Package Keeper\|Alpine Package Keeper(APK)]]

	[[Category:Package Manager]]		[[Category:Package Manager]]
			[[Category:Diskless]]

Prabuanand: cleaned up headlines organized content. removed information related to older versions ( already commented out)

2024-10-12T10:45:25Z

cleaned up headlines organized content. removed information related to older versions ( already commented out)

@@ Line 1: / Line 1: @@
 <!-- NOTE This page ([[Local_APK_cache]]) also gets included at [[Alpine_Linux_package_management#Local_Cache]] to avoid duplication. -->
 === Overview ===
-To have the packages available during boot, apk can keep a cache of installed packages on a local disk.
+APK can keep a cache of installed packages on a local disk.
-Added packages can then be automatically (re-)installed from local media into RAM when booting, without requiring, and even before there is a network connection.
+In [[Installation#Diskless_Mode|diskless]] installations, since these packages are available during boot, packages can then be automatically (re-)installed from local media into RAM when booting, without requiring, and even before there is a network connection. The cache can be stored on any writable media, or at 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 at the same location as the .apkovl file from the [[Alpine_local_backup| local backup utility <code>lbu</code>]].
+HDD or [[Installation#System_Disk_Mode|sys mode]] installs don't need an apk cache to maintain their state, it still allows to serve packages over the network, though, e.g. to get installed by other local machines.
-=== Enabling Local Cache with current releases ===
+Execute the script <code>setup-apkcache</code> will assist in enabling a local cache. The script creates a symlink named {{Path|/etc/apk/cache}} that points to the cache directory.
-Execute the script {{Cmd|setup-apkcache}} and it will assist in enabling a local cache.
+Cache can also be manually enabled by creating a cache dir and then symlink it to {{Path|/etc/apk/cache}}:
-The script creates a symlink named {{Path|/etc/apk/cache}} that points to the cache directory.
+On a [[Installation#Diskless_Mode|diskless]] installation, to make the disk where the cache directory is present be automatically mounted at boot create an empty file {{Path|.boot_repository}} inside the cache directory.
 === Cache maintenance ===
@@ Line 37: / Line 37: @@
 {{Cat|/etc/local.d/cache.stop|#!/bin/sh
 # verify the local cache on shutdown
@@ Line 48: / Line 47: @@
 {{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 {{Path|/etc/conf.d/local}}; but that method is now deprecated.}}
+=== 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.
@@ Line 78: / Line 62: @@
 As usual, if you want to download currently installed packages into the cache, use ''apk cache sync''.
 [[Category:Package Manager]]

Sertonix: use path template

2023-07-02T21:50:36Z

use path template

Sertonix: use Cmd template

2023-07-02T21:31:29Z

use Cmd template

← Older revision		Revision as of 21:31, 2 July 2023
Line 70:		Line 70:

	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''.		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		{{Cmd\|<nowiki>apk add e2fsprogs
	* dd if=/dev/zero of=/apkcache.img bs=1M count=128		dd if=/dev/zero of=/apkcache.img bs=1M count=128
	* mkfs.ext2 -F /apkcache.img		mkfs.ext2 -F /apkcache.img
	* mkdir -p /etc/apk/cache		mkdir -p /etc/apk/cache
	* mount -t ext2 /apkcache.img /etc/apk/cache		mount -t ext2 /apkcache.img /etc/apk/cache
	* apk update		apk update</nowiki>}}

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

Dnpr at 16:07, 30 April 2023

2023-04-30T16:07:12Z

← Older revision		Revision as of 16:07, 30 April 2023
Line 17:		Line 17:
	The script creates a symlink named ''/etc/apk/cache'' that points to the cache directory.		The script creates a symlink named ''/etc/apk/cache'' that points to the cache directory.

			{{Tip\|On a diskless installation, to make the disk where the cache directory is present be automatically mounted at boot you can create an empty file ''.boot_repository'' inside the cache directory.}}

	=== Cache maintenance ===		=== Cache maintenance ===

Sb1 at 14:49, 12 May 2021

2021-05-12T14:49:19Z

← Older revision		Revision as of 14:49, 12 May 2021
Line 2:		Line 2:
	<!-- NOTE This page ([[Local_APK_cache]]) also gets included at [[Alpine_Linux_package_management#Local_Cache]] to avoid duplication. -->		<!-- NOTE This page ([[Local_APK_cache]]) also gets included at [[Alpine_Linux_package_management#Local_Cache]] to avoid duplication. -->

	=== ~~General~~ ===		=== Overview ===

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

Sb1 at 14:48, 12 May 2021

2021-05-12T14:48:10Z

← Older revision		Revision as of 14:48, 12 May 2021
Line 2:		Line 2:
	<!-- NOTE This page ([[Local_APK_cache]]) also gets included at [[Alpine_Linux_package_management#Local_Cache]] to avoid duplication. -->		<!-- NOTE This page ([[Local_APK_cache]]) also gets included at [[Alpine_Linux_package_management#Local_Cache]] to avoid duplication. -->

			=== General ===

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

← Older revision		Revision as of 21:50, 2 July 2023
Line 15:		Line 15:
	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.

	The script creates a symlink named ''/etc/apk/cache'' that points to the cache directory.		The script creates a symlink named {{Path\|/etc/apk/cache}} that points to the cache directory.

	{{Tip\|On a diskless installation, to make the disk where the cache directory is present be automatically mounted at boot you can create an empty file ''.boot_repository'' inside the cache directory.}}		{{Tip\|On a diskless installation, to make the disk where the cache directory is present be automatically mounted at boot you can create an empty file {{Path\|.boot_repository}} inside the cache directory.}}

	=== Cache maintenance ===		=== Cache maintenance ===
Line 59:		Line 59:
	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.

	Manually create a cache dir and then symlink it to ''/etc/apk/cache'':		Manually create a cache dir and then symlink it to {{Path\|/etc/apk/cache}}:
	{{Cmd\|mkdir -p /var/cache/apk		{{Cmd\|mkdir -p /var/cache/apk
	ln -s /var/cache/apk /etc/apk/cache}}		ln -s /var/cache/apk /etc/apk/cache}}
Line 69:		Line 69:
	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).		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''.		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 {{Path\|/etc/apk/cache}}.
	{{Cmd\|<nowiki>apk add e2fsprogs		{{Cmd\|<nowiki>apk add e2fsprogs
	dd if=/dev/zero of=/apkcache.img bs=1M count=128		dd if=/dev/zero of=/apkcache.img bs=1M count=128
Line 82:		Line 82:
	==== Manually Enabling Local Cache (required for releases prior to v2.3) ====		==== Manually Enabling Local Cache (required for 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, {{Path\|/dev/sda1}}.) {{Cmd\| 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 {{Cmd\|mount -o remount,rw /media/sda1}} and then don't forget to run {{Cmd\|mount -o remount,ro /media/sda1}} when you are done with the following commands}}		{{Tip\|If you get an error that says "mkdir: can't create directory {{Path\|/media/usbdisk/cache}}: Read-only file system", then you probably need to remount your disk read-write temporarily. Try {{Cmd\|mount -o remount,rw /media/sda1}} and then don't forget to run {{Cmd\|mount -o remount,ro /media/sda1}} when you are done with the following commands}}
	# Create a symlink to this directory from ~~<code>~~/etc/apk/cache~~</code>~~. {{Cmd\|ln -s /media/sda1/cache /etc/apk/cache}}		# Create a symlink to this directory from {{Path\|/etc/apk/cache}}. {{Cmd\|ln -s /media/sda1/cache /etc/apk/cache}}
	# Run an lbu commit to save the change (~~<code>~~/etc/apk/cache~~</code>~~ is in ~~<code>~~/etc~~</code>~~ and is automatically backed up.) {{Cmd\|lbu commit}}		# Run an lbu commit to save the change ({{Path\|/etc/apk/cache}} is in {{Path\|/etc}} and is automatically backed up.) {{Cmd\|lbu commit}}
	{{Tip\|If you needed to remount your disk read-write before, run {{Cmd\|mount -o remount,ro /media/sda1}} now that you are done with saving the changes}}		{{Tip\|If you needed to remount your disk read-write before, run {{Cmd\|mount -o remount,ro /media/sda1}} now that you are done with saving the changes}}