From 70118390268033bce98d9219f8292423a2f26ce2 Mon Sep 17 00:00:00 2001 From: Adam Warner Date: Wed, 27 Sep 2023 18:08:51 +0100 Subject: [PATCH] Add some information about building a custom image with an alternative component branch Signed-off-by: Adam Warner --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index 3e6ae4e..a1f788f 100644 --- a/README.md +++ b/README.md @@ -207,6 +207,12 @@ Why is this style of upgrading good? A couple reasons: Everyone is starting fro To reconfigure Pi-hole you'll either need to use an existing container environment variables or if there is no a variable for what you need, use the web UI or CLI commands. +### Building an image with alternative component branches + +Occaisionally you may need to try an alternative branch of one of the components (`core`,`web`,`ftl`). On bare metal you would run, for example, `pihole checkout core custombranchname`, however in Docker world we have disabled this command as it can cause unpredictable results. + +The preferred method is to clone this repository and rebuild the image with the custom branch name passed in as an arg, e.g `docker buildx build src/. --tag pihole_custom --build-arg CORE_BRANCH=custombranchname --no-cache`, and then redeploy your stack with this new image (In this case you should have a local image named `pihole_custom`, but you can call it whatever you want) + ### Pi-hole features Here are some relevant wiki pages from [Pi-hole's documentation](https://github.com/pi-hole/pi-hole/blob/master/README.md#get-help-or-connect-with-us-on-the-web). The web interface or command line tools can be used to implement changes to pihole.