Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add instructions for rebuilding the image with a custom component branch #1444

Merged
merged 2 commits into from
Oct 8, 2023
Merged

Add instructions for rebuilding the image with a custom component branch #1444

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7011839
Add some information about building a custom image with an alternativ…
PromoFaux Sep 27, 2023
4c2d0ab
Add valid args
PromoFaux Sep 27, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -207,6 +207,17 @@ 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

Occasionally 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.
yubiuser marked this conversation as resolved.
Show resolved Hide resolved

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)

Valid args are:
- `CORE_BRANCH`
- `WEB_BRANCH`
- `FTL_BRANCH`

### 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.
Expand Down