Merge pull request #1444 from pi-hole/readme/altbranches
Add instructions for rebuilding the image with a custom component branch
This commit is contained in:
commit
938f3a2ed0
11
README.md
11
README.md
|
@ -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.
|
||||
|
||||
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.
|
||||
|
|
Loading…
Reference in New Issue