particle-os-modules/modules/files/README.md
xyny 4e79916835
docs: enhacements to module documentation (#54)
* docs: chore: rn ":" from "Example configuration"

* docs: correct title casing for fonts module title

* docs: document OS_VERSION in example,...
non-copr example for rpmrepos

* docs: remove bling fonts option from bling example

* docs: start yafti README the same way as others
"The yafti module..."
2023-10-01 08:41:01 -07:00

16 lines
952 B
Markdown

# `files` Module for Startingpoint
The `files` module simplifies the process of copying files to the image during the build time. These files are sourced from the `config/files` directory, which is located at `/tmp/config/files` inside the image.
> **Warning**
> If you want to place anything in `/etc` of the final image, you MUST place them in `/usr/etc` in your repo, so that they're written to `/usr/etc` on the final system. That is the proper directory for "system" configuration templates on immutable Fedora distros, whereas the normal `/etc` is meant for manual overrides and editing by the machine's admin AFTER installation! See issue https://github.com/ublue-os/startingpoint/issues/28.
## Example Configuration
```yaml
type: files
files:
- usr: /usr
```
In the example above, `usr` represents the directory located inside the `config/files` in the repository, while `/usr` designates the corresponding destination within the image.