From b76f62523b36fb9356e625992b5367e9306b7522 Mon Sep 17 00:00:00 2001 From: qoijjj Date: Thu, 14 Sep 2023 18:16:18 -0700 Subject: [PATCH] fix: add additional clarity to the location of files for the files module --- README.md | 2 +- config/recipe.yml | 11 +++++++---- 2 files changed, 8 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 418d1613f9..68a1de9969 100644 --- a/README.md +++ b/README.md @@ -29,7 +29,7 @@ After setup, it is recommended you update this README to describe your custom im The easiest way to start customizing is by looking at and modifying `config/recipe.yml`. It's documented using comments and should be pretty easy to understand. -If you want to add custom configuration files, you can just add them in the `/usr/etc/` directory, which is the official OSTree "configuration template" directory and will be applied to `/etc/` on boot. `usr` is copied into your image by default. If you need to add other directories in the root of your image, that can be done in the Containerfile. Writing to `/var/` in the image builds of OSTree-based distros isn't supported and will not work, as that is a local user-managed directory! +If you want to add custom configuration files, you can just add them in the `/usr/etc/` directory, which is the official OSTree "configuration template" directory and will be applied to `/etc/` on boot. `config/files/usr` is copied into your image's `/usr` by default. If you need to add other directories in the root of your image, that can be done in the Containerfile. Writing to `/var/` in the image builds of OSTree-based distros isn't supported and will not work, as that is a local user-managed directory! For more information about customization, see [the README in the config directory](config/README.md) diff --git a/config/recipe.yml b/config/recipe.yml index 90d4cb16fa..c71eae8e0d 100644 --- a/config/recipe.yml +++ b/config/recipe.yml @@ -13,10 +13,13 @@ modules: - type: files files: - - usr: /usr # copy static configurations - # configuration you wish to end up in /etc/ on the booted system should be - # added into /usr/etc/ as that is the proper "distro" config directory on ostree - # read more in the files module's README + - usr: /usr # copy static configurations + # + # copies config/files/usr into your image's /usr + # + # configuration you wish to end up in /etc/ on the booted system + # should be added into /usr/etc/ as that is the proper "distro" + # config directory on ostree read more in the files module's README - type: rpm-ostree repos: