diff --git a/docs/assets/images/lsio-branding1.png b/docs/assets/images/lsio-branding1.png new file mode 100644 index 0000000000..2402f8b638 Binary files /dev/null and b/docs/assets/images/lsio-branding1.png differ diff --git a/docs/assets/images/lsio-branding2.png b/docs/assets/images/lsio-branding2.png new file mode 100644 index 0000000000..adb87b3707 Binary files /dev/null and b/docs/assets/images/lsio-branding2.png differ diff --git a/docs/assets/images/lsio-branding3.png b/docs/assets/images/lsio-branding3.png new file mode 100644 index 0000000000..9d8f947f20 Binary files /dev/null and b/docs/assets/images/lsio-branding3.png differ diff --git a/docs/general/.pages b/docs/general/.pages index 8d432e8f1a..0fa23a6e38 100644 --- a/docs/general/.pages +++ b/docs/general/.pages @@ -1,13 +1,14 @@ nav: - - container-execution.md - containers-101.md - - running-our-containers.md + - container-branding.md - container-customization.md + - container-execution.md - docker-compose.md + - fleet.md + - how-to-get-support.md + - running-our-containers.md + - split-dns.md + - swag.md - understanding-puid-and-pgid.md - updating-our-containers.md - volumes.md - - fleet.md - - swag.md - - how-to-get-support.md - - split-dns.md diff --git a/docs/general/container-branding.md b/docs/general/container-branding.md new file mode 100644 index 0000000000..5d6a2bda87 --- /dev/null +++ b/docs/general/container-branding.md @@ -0,0 +1,19 @@ +# Container Branding + +If you use our base images for your own projects, or fork our downstream images to modify them, you're probably aware that we ask you to change the branding that appears in the container init logs to make it clear that your image is not associated with us. This is for your benefit as much as ours: we aren't well-equipped to provide your users with support, and you don't want them crediting us for your work. + +Iif you build from one of our base images and don't change anything, your init logs will look something like this: + +![Default Container Branding](../assets/images/lsio-branding1.png) + +If you want to add your own branding, when using our base images or a forked downstream one, just place a file called `branding` containing the text you want to use into the `/etc/s6-overlay/s6-rc.d/init-adduser` folder of your image. The branding file will replace the highlighted section of the init: + +![Default Container Branding with Hightlights](../assets/images/lsio-branding2.png) + +On start-up, the base image will automatically load the branding into its init, allowing you to inflict whatever ASCII art you like on your users: + +![Custom Container Branding](../assets/images/lsio-branding2.png) + +Hopefully this makes it simpler for everyone to manage the branding of your images when using our bases. + +A final note: if you've previously overridden the `init-adduser` run file to do custom branding, we recommend switching to the above approach so that you don't miss out on any future changes to that init step.