Search $LIMA_HOME/_templates before /usr/local/share/lima/templates

Signed-off-by: Jan Dubois <[email protected]>

Author: jandubois

pkg/templatestore/templatestore.go

@@ -15,6 +15,7 @@ import (
 	"unicode"
 
 	securejoin "github.com/cyphar/filepath-securejoin"
+	"github.com/lima-vm/lima/pkg/store/dirnames"
 	"github.com/lima-vm/lima/pkg/usrlocalsharelima"
 )
 
@@ -24,17 +25,21 @@ type Template struct {
 }
 
 func TemplatesPaths() ([]string, error) {
-	var paths []string
 	if tmplPath := os.Getenv("LIMA_TEMPLATES_PATH"); tmplPath != "" {
-		paths = strings.Split(tmplPath, string(filepath.ListSeparator))
-	} else {
-		dir, err := usrlocalsharelima.Dir()
-		if err != nil {
-			return nil, err
-		}
-		paths = []string{filepath.Join(dir, "templates")}
+		return strings.Split(tmplPath, string(filepath.ListSeparator)), nil
+	}
+	limaDir, err := dirnames.LimaDir()
+	if err != nil {
+		return nil, err
 	}
-	return paths, nil
+	shareDir, err := usrlocalsharelima.Dir()
+	if err != nil {
+		return nil, err
+	}
+	return []string{
+		filepath.Join(limaDir, "_templates"),
+		filepath.Join(shareDir, "templates"),
+	}, nil
 }
 
 func Read(name string) ([]byte, error) {
@@ -70,6 +75,9 @@ func Templates() ([]Template, error) {
 
 	templates := make(map[string]string)
 	for _, templatesDir := range paths {
+		if _, err := os.Stat(templatesDir); os.IsNotExist(err) {
+			continue
+		}
 		walkDirFn := func(p string, _ fs.DirEntry, err error) error {
 			if err != nil {
 				return err

website/content/en/docs/config/environment-variables.md

@@ -30,7 +30,7 @@ This page documents the environment variables used in Lima.
 ### `LIMA_TEMPLATES_PATH`
 
 - **Description**: Specifies the directories used to resolve `template://` URLs.
-- **Default**: `/usr/local/share/lima/templates`
+- **Default**: `$LIMA_HOME/_templates:/usr/local/share/lima/templates`
 - **Usage**:
   ```sh
   export LIMA_TEMPLATES_PATH="$HOME/.config/lima/templates:/usr/local/share/lima/templates"

website/content/en/docs/dev/internals.md

@@ -107,6 +107,12 @@ When using `vmType: vz` (Virtualization.framework), on boot, any qcow2 (default)
 
 `ls` will also only show the full/virtual size of the disks. To see the allocated space, `du -h disk_path` or `qemu-img info disk_path` can be used instead. See [#1405](https://github.com/lima-vm/lima/pull/1405) for more details.
 
+## Templates directory (`${LIMA_HOME}/_templates`)
+
+The templates directory can store additional template files that can be referenced with the `template://` schema.
+
+If the template directory exists (and `$LIMA_TEMPLATES_PATH` is not set), then this directory will be searched before the `/usr/local/share/lima/templates` default directory that contains all the templates bundled with Lima itself.
+
 ## Lima cache directory (`~/Library/Caches/lima`)
 
 Currently hard-coded to `~/Library/Caches/lima` on macOS.