TWinsnes / galaxy-role-pihole

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Pi-hole

Role to deploy and configures everything required to run Pi-hole on a Raspberry Pi in your network.

Requirements

  • Ansible 2.9 or newer

Role Variables

variable name default description
raspberry_user pi The user that will be running Pi-hole.
dns_server1 8.8.8.8 The IP for the primary DNS server Pi-hole will forward requests to.
dns_server2 8.8.4.4 The IP for the secondary DNS server Pi-hole will forward request to if the primary DNS server is not available.

Use the value "no" to disable the secondary DNS
pihole_admin_password random Administrator password for the web ui for Pi-hole.

It is recommended that you set this to something else, or you will have to dig through the logs on the host to find the automatically generated password.

Dependencies

  • geerlingguy.docker
  • geerlingguy.pip

How to use

First install the role on your management node / local machine, which should download all the required dependencies.

ansible-galaxy install twinsnes.pihole

Then either add the role with required configuration to your playbook for your Pi, or make a new one like the one below.

Playbook file:

- hosts: all
  roles:
  - name: twinsnes.pihole
    vars:
      pihole_admin_password: "SomeSecretPassword"

Using an inventory file makes it a lot easier to manage hosts and will alow you to store configuration for your host in a file for later. So when you need to run this again in 6 months, you don't have to remember the settings.

Inventory file:

all:
  vars:
    ansible_connection: ssh
    ansible_ssh_user: pi
    ansible_ssh_pass: raspberry
  hosts:
    raspberry:
      ansible_host: "192.168.1.100"

Once you have both your playbook and your inventory file set up. Execute your playbook

ansible-playbook playbook.yaml -i inventory.yaml

License

Apache-2.0

About

License:Apache License 2.0