Pi-hole#

Pi-hole provides network-wide ad blocking via your own Linux hardware.

amd64
arm64
armv7

Information#

Docker Image: !!! LINK TO DOCKER IMAGE/ DOCKER HUB !!!
Current Image Version: latest

SETUP#

Enabling pihole#

Command:#

vlab set pihole.enable True

File alteration:#

set the appropriate service settings in settings/config.yml to true

eg.

pihole
enable: True

Finalising changes:#

run: vlab update_one service=pihole

FIRST RUN#

!!! DEVELOPERS: make sure that you include any information that the user requires to get started, below. !!!
!!! Below are some examples with headings, and with some example instructions !!!

ADMINISTRATOR SETUP#

Login with the default password you set.

SMTP/ MAIL#

  1. run vlab decrypt to decrypt the vault.yml file
  2. make some changes

SMTP Settings#

smtp:
host:
port:
user:
pass:
from_email:
from_name:
  1. run vlab update_one service=pihole to complete the changes

ACCESS#

pihole (HTTPS) link: https://pihole.vivumlab.xyz/ pihole (HTTP) link: http://pihole.vivumlab.xyz/

OPTIONS#

HTTPS_ONLY#

Default: False
Options: True/False

Command:#

vlab set pihole.https_only True

File alteration:#

set the appropriate service settings in settings/config.yml to true

eg.

pihole
https_only: True
Finalising changes:#

run: vlab update_one service=pihole

AUTH#

Default: False
Options: True/False

Command:#

vlab set pihole.auth True

File alteration:#

set the appropriate service settings in settings/config.yml to true

eg.

pihole
auth: True
Finalising changes:#

run: vlab update_one service=pihole

DOMAIN#

Default: False
NOTE: include the sitename and top level domain suffix. eg. name.com, site.net

Command:#

vlab set pihole.domain pihole.com

File alteration:#

set the appropriate service settings in settings/config.yml to true

eg.

pihole
domain: pihole.com
Finalising changes:#

run: vlab update_one service=pihole

SUBDOMAIN#

Default: pihole
NOTE: Periods/ delimiters are not required. eg. 'media' will set the full URL as 'media.vivumlab.xyz'

Command:#

vlab set pihole.subdomain media

File alteration:#

set the appropriate service settings in settings/config.yml to true

eg.

pihole
subdomain: media
Finalising changes:#

run: vlab update_one service=pihole

VERSION#

Default: latest
NOTE: Ensure that the version exists

Command:#

vlab set pihole.version 2.7

File alteration:#

set the appropriate service settings in settings/config.yml to true

eg.

pihole
version: 2.7
Finalising changes:#

run: vlab update_one service=pihole

Need more help?#

Further information regarding services can be found.
General Information can be found in the documentation.
Additional assistance can be found on our Contact Us page.