From 055c6cf0fa3d73ed46145c1ac21ef4c2fd8f5b57 Mon Sep 17 00:00:00 2001 From: Stefan Prodan Date: Sun, 12 Nov 2023 22:55:58 +0200 Subject: [PATCH] Add local cache to install docs Signed-off-by: Stefan Prodan --- docs/install.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/docs/install.md b/docs/install.md index 45fd7777..a3e00cc4 100644 --- a/docs/install.md +++ b/docs/install.md @@ -155,6 +155,17 @@ Configure your shell to load timoni completions: mv _timoni ~/.zprezto/modules/completion/external/src/ # zprezto ``` +## Local cache + +Timoni maintains a local cache of modules pulled from remote container registries. +Cashing is meant to reduce network traffic for sequential pull operations and speeds up +applying bundles which refer to modules with identical layers. + +The default cache location is `$HOME/.timoni/cache` and be changed with the `--cache-dir` global flag. + +If the home directory is not writable, caching can be disabled by +setting the `TIMONI_CACHING=false` environment variable. + ## SLSA Provenance & SBOMs The build, release and provenance portions of Timoni's supply chain meet the