Pi-hole v6.0 documentation

.devcontainer/Dockerfile

@@ -0,0 +1,11 @@
+FROM node:21-alpine3.19
+RUN apk add --no-cache \
+                git \
+                nano\
+                openssh \
+                py3-pip
+ENV USER node
+USER $USER
+# python packages (as mkdocs) are installed in the user's home directory
+# but we need them to be accessible from $PATH
+ENV PATH="$PATH:/home/$USER/.local/bin"

.devcontainer/devcontainer.json

@@ -0,0 +1,26 @@
+{
+  "name": "Pi-hole doc devcontainer",
+  "dockerFile": "Dockerfile",
+    // Use 'postCreateCommand' to run commands after the container is created.
+    "postCreateCommand": "sh .devcontainer/post-create.sh",
+    "customizations": {
+      // Configure properties specific to VS Code.
+        "vscode": {
+          "settings": {},
+          "extensions": [
+            "eamodio.gitlens",
+            "EditorConfig.EditorConfig",
+            "github.vscode-github-actions",
+            "DavidAnson.vscode-markdownlint"
+
+          ]
+        }
+    },
+  "containerEnv": {
+    "GIT_EDITOR": "nano"
+  },
+  "mounts": [
+    "type=bind,source=/home/${localEnv:USER}/.ssh,target=/home/node/.ssh,readonly"
+  ],
+  "forwardPorts": [8000]
+}

.devcontainer/post-create.sh

@@ -0,0 +1,3 @@
+#! /bin/sh
+npm install
+pip3 install -r requirements.txt --break-system-packages --no-warn-script-location

.github/workflows/ci.yml

@@ -22,14 +22,14 @@ jobs:
           fetch-depth: 0
 
       - name: Set up Python
-        uses: actions/setup-python@v5.1.0
+        uses: actions/setup-python@v5.1.1
         with:
           python-version: "${{ env.PYTHON_VERSION }}"
           architecture: "x64"
           cache: pip
 
       - name: Set up Node.js
-        uses: actions/setup-node@v4.0.2
+        uses: actions/setup-node@v4.0.3
         with:
           node-version: "${{ env.NODE }}"
           cache: npm

.github/workflows/codespell.yml

@@ -16,4 +16,4 @@ jobs:
       uses: codespell-project/actions-codespell@master
       with:
         ignore_words_file: .codespellignore
-        skip: ./docs/routers/fritzbox-de.md,./mkdocs.yml,./package.json,./package-lock.json,./.markdownlint.json,./requirements.txt
+        skip: ./docs/routers/fritzbox-de.md,./mkdocs.yml,./package.json,./package-lock.json,./.markdownlint.json,./requirements.txt, ./MathJax-es5/*

LICENSE

@@ -33,7 +33,7 @@ exhaustive, and do not form part of our licenses.
      material not subject to the license. This includes other CC-
      licensed material, or material used under an exception or
      limitation to copyright. More considerations for licensors:
-	wiki.creativecommons.org/Considerations_for_licensors
+    wiki.creativecommons.org/Considerations_for_licensors
 
      Considerations for the public: By using one of our public
      licenses, a licensor grants the public permission to use the
@@ -50,7 +50,7 @@ exhaustive, and do not form part of our licenses.
      Although not required by our licenses, you are encouraged to
      respect those requests where reasonable. More_considerations
      for the public:
-	wiki.creativecommons.org/Considerations_for_licensees
+    wiki.creativecommons.org/Considerations_for_licensees
 
 =======================================================================
 

docs/abbreviations.md

@@ -1,15 +1,18 @@
 
+*[2FA]: Two-factor authentication
+*[API]: Application Programming Interface (a set of subroutine definitions, protocols, and tools for building application software)
+*[CSRF]: Cross-site request forgery
 *[DNS]: Domain Name Service (decentralized naming system for computers, services, or other resources connected to the Internet)
-*[FTL]: Pi-hole's Faster Than Light daemon
+*[DnyDNS]: Dynamic DNS record pointing to a frequently changing IP address
 *[DHCP]: Dynamic Host Configuration Protocol (network management protocol for configuring Internet Protocol version 4 (IPv4) hosts with IP addresses)
 *[DHCPv6]: Dynamic Host Configuration Protocol version 6 (a network protocol for configuring Internet Protocol version 6 (IPv6) hosts with IP addresses)
+*[FTL]: Pi-hole's Faster Than Light daemon
 *[IPv4]: Internet Protocol version 4 (addresses like 192.168.0.1)
 *[IPv6]: Internet Protocol version 6 (addresses like 2001:db8::ff00:42:8329)
 *[HTTP]: Hypertext Transfer Protocol (HTTP), an application protocol for distributed, collaborative, and hypermedia information systems
 *[HTTPS]: HTTP Secure (HTTPS), an extension of the Hypertext Transfer Protocol (HTTP) for secure communication over a computer network
 *[TCP]: Transmission Control Protocol (protocol providing reliable, ordered, and error-checked delivery of data between applications running on hosts communicating via an IP network)
 *[UDP]: User Datagram Protocol (a network communications method for sending messages as datagrams)
-*[API]: Application Programming Interface (a set of subroutine definitions, protocols, and tools for building application software)
 *[PE]: Privacy Extension
 *[PID]: Process identifier (a number used to identify a process)
 *[HOSTS]: The computer file /etc/hosts is an operating system file that maps hostnames to IP addresses
@@ -34,9 +37,14 @@
 *[Regex]: Regular expression
 *[regex]: Regular expression
 *[SQLite3]: Database engine that handles SQL databases in a file
+*[SID]: Session ID
 *[ID]: Identifier
 *[SSH]: Secure Shell is a cryptographic network protocol for operating network services securely over an unsecured network
 *[TFTP]: Trivial File Transfer Protocol is a simple lockstep File Transfer Protocol which allows a client to get a file from or put a file onto a remote host
 *[TTL]: Time-To-Live is a mechanism that limits the lifespan or lifetime of data in a computer or network
+*[TOTP]: Time-based One-Time Password
 *[NAT]: Network address translation
-*[DnyDNS]: Dynamic DNS record pointing to a frequently changing IP address
+*[UTF-8]: 8-bit Unicode Transformation Format - a character encoding format capable of encoding all known 1,112,064 valid Unicode characters
+*[URL]: Uniform Resource Locator, commonly known as "web address"
+*[REST]: Representational State Transfer - a software architecture for distributed systems like the World Wide Web (WWW)
+*[XSS]: Cross-site scripting