From 37aa4a9894e0cedd7a86fcdea3e842a2050d8452 Mon Sep 17 00:00:00 2001 From: "Jorge O. Castro" Date: Sun, 16 Nov 2025 01:48:53 -0500 Subject: [PATCH 1/2] docs: document OCI usage patterns and directory contents Add comprehensive usage examples showing how to consume this OCI layer in Containerfiles. Documents three patterns: - Copy all system files - Copy only /etc configuration - Copy only /usr configuration Also documents major components in each directory without listing individual files. Assisted-by: Claude 3.5 Sonnet via GitHub Copilot --- README.md | 59 +++++++++++++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 57 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 75187a0..a541533 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,60 @@ -# common -OCI layer for things that need to be on every bluefin +# bluefin-common + +Shared OCI layer containing common configuration files used across all Bluefin variants (bluefin, bluefin-dx, bluefin-lts). + +## What's Inside + +This layer contains two main configuration directories: + +### `/etc/ublue-os/` - System Configuration +- **Bling configuration** - CLI theming settings +- **Fastfetch settings** - System information display configuration +- **Setup configuration** - First-boot and system setup parameters + +### `/usr/share/ublue-os/` - User-Space Configuration +- **Firefox defaults** - Pre-configured Firefox settings +- **Flatpak overrides** - Application-specific Flatpak configurations +- **Just recipes** - Additional command recipes for system management +- **MOTD templates** - Message of the day and tips +- **Setup hooks** - Scripts for privileged, system, and user setup stages + +## Usage in Containerfile + +Reference this layer as a build stage and copy the directories you need: + +### Copy everything: +```dockerfile +FROM ghcr.io/ublue-os/bluefin-common:latest AS bluefin-common + +# Copy all system files +COPY --from=bluefin-common /system_files / +``` + +### Copy only system configuration: +```dockerfile +FROM ghcr.io/ublue-os/bluefin-common:latest AS bluefin-common + +# Copy only /etc configuration +COPY --from=bluefin-common /system_files/etc /etc +``` + +### Copy only user-space configuration: +```dockerfile +FROM ghcr.io/ublue-os/bluefin-common:latest AS bluefin-common + +# Copy only /usr/share configuration +COPY --from=bluefin-common /system_files/usr /usr +``` + +## Building Locally + +```bash +just build +``` + +## Contributing + +See [AGENTS.md](AGENTS.md) for development guidelines and instructions. ## TODO From 4998b27b06eb0bc0ccdb46c585ee442c3747a8f8 Mon Sep 17 00:00:00 2001 From: "Jorge O. Castro" Date: Sun, 16 Nov 2025 01:52:12 -0500 Subject: [PATCH 2/2] Refactor README.md for better readability Removed unnecessary bullet points and improved formatting for clarity. --- README.md | 29 ++++++++++++----------------- 1 file changed, 12 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index a541533..c8585c5 100644 --- a/README.md +++ b/README.md @@ -7,16 +7,16 @@ Shared OCI layer containing common configuration files used across all Bluefin v This layer contains two main configuration directories: ### `/etc/ublue-os/` - System Configuration -- **Bling configuration** - CLI theming settings -- **Fastfetch settings** - System information display configuration -- **Setup configuration** - First-boot and system setup parameters +- Bling - CLI theming settings +- Fastfetch settings - System information display configuration +- Setup configuration - First-boot and system setup parameters ### `/usr/share/ublue-os/` - User-Space Configuration -- **Firefox defaults** - Pre-configured Firefox settings -- **Flatpak overrides** - Application-specific Flatpak configurations -- **Just recipes** - Additional command recipes for system management -- **MOTD templates** - Message of the day and tips -- **Setup hooks** - Scripts for privileged, system, and user setup stages +- Firefox defaults - Pre-configured Firefox settings +- Flatpak overrides - Application-specific Flatpak configurations +- Just recipes - Additional command recipes for system management +- MOTD templates - Message of the day and tips +- Setup hooks - Scripts for privileged, system, and user setup stages ## Usage in Containerfile @@ -31,6 +31,9 @@ COPY --from=bluefin-common /system_files / ``` ### Copy only system configuration: + +This is what Aurora should use, gives shares the common set of files and keeps the images opinions seperate. + ```dockerfile FROM ghcr.io/ublue-os/bluefin-common:latest AS bluefin-common @@ -38,7 +41,7 @@ FROM ghcr.io/ublue-os/bluefin-common:latest AS bluefin-common COPY --from=bluefin-common /system_files/etc /etc ``` -### Copy only user-space configuration: +### Copy only the image opinion: ```dockerfile FROM ghcr.io/ublue-os/bluefin-common:latest AS bluefin-common @@ -51,11 +54,3 @@ COPY --from=bluefin-common /system_files/usr /usr ```bash just build ``` - -## Contributing - -See [AGENTS.md](AGENTS.md) for development guidelines and instructions. - -## TODO - -Split this repo into common and bluefin specific so Aurora can copy out what is image agnostic, that way we can share config.