mirror of
https://github.com/pi-hole/docs.git
synced 2026-02-15 07:26:03 +00:00
Remove markdown-include and use snippets instead
Signed-off-by: yubiuser <github@yubiuser.dev>
This commit is contained in:
yubiuser
@@ -418,4 +418,3 @@ Session-based authentication, while convenient and widely used, does have severa
|
||||
|
||||
Remember, no security measure is foolproof, but by understanding the potential risks and the multiple layers of defense your Pi-hole implemented against these risks, you can make an informed decision about how to use the Pi-hole API securely in the context of your own scripts. Always use the secure transmission method (HTTPS) offered by your Pi-hole to access the API. The strong encryption will prevent attackers from eavesdropping on your requests and makes stealing your session ID basically impossible.
|
||||
|
||||
{!abbreviations.md!}
|
||||
|
||||
@@ -200,4 +200,3 @@ Code | Description | Interpretation
|
||||
|
||||
We recommend writing code that gracefully handles all possible API exceptions. The Pi-hole API is designed to support this by standardized error messages and human-readable hints for errors.
|
||||
|
||||
{!abbreviations.md!}
|
||||
|
||||
@@ -1,4 +1,6 @@
|
||||
{!guides/vpn/openvpn/deprecation_notice.md!}
|
||||
--8<--
|
||||
docs/guides/vpn/openvpn/deprecation_notice.md
|
||||
--8<--
|
||||
|
||||
- Install the official OpenVPN App from the [App Store](https://play.google.com/store/apps/details?id=net.openvpn.openvpn)
|
||||
|
||||
|
||||
@@ -1,4 +1,6 @@
|
||||
{!guides/vpn/openvpn/deprecation_notice.md!}
|
||||
--8<--
|
||||
docs/guides/vpn/openvpn/deprecation_notice.md
|
||||
--8<--
|
||||
|
||||
## Create a client config file (`.ovpn`)
|
||||
|
||||
|
||||
@@ -1,4 +1,6 @@
|
||||
{!guides/vpn/openvpn/deprecation_notice.md!}
|
||||
--8<--
|
||||
docs/guides/vpn/openvpn/deprecation_notice.md
|
||||
--8<--
|
||||
|
||||
### Dual VPN Setup - Separate DNS and VPN Traffic
|
||||
|
||||
|
||||
@@ -1,4 +1,6 @@
|
||||
{!guides/vpn/openvpn/deprecation_notice.md!}
|
||||
--8<--
|
||||
docs/guides/vpn/openvpn/deprecation_notice.md
|
||||
--8<--
|
||||
|
||||
**Up until now, this wiki has been about a server set up on a cloud host, available on the public Internet. This section is aimed at a server set up in a private network like on a Raspberry Pi.**
|
||||
|
||||
|
||||
@@ -1,4 +1,6 @@
|
||||
{!guides/vpn/openvpn/deprecation_notice.md!}
|
||||
--8<--
|
||||
docs/guides/vpn/openvpn/deprecation_notice.md
|
||||
--8<--
|
||||
|
||||
If you operate your Pi-hole + OpenVPN at home, you are likely sitting behind a NAT / dynamically changing IP address. In this case, you should set up a dynamic DNS record, which allows you to reach your server. You can exchange the address that has been configured during the setup of OpenVPN like this:
|
||||
|
||||
|
||||
@@ -1,4 +1,6 @@
|
||||
{!guides/vpn/openvpn/deprecation_notice.md!}
|
||||
--8<--
|
||||
docs/guides/vpn/openvpn/deprecation_notice.md
|
||||
--8<--
|
||||
|
||||
### (optional) Secure the server with firewall rules (`iptables`)
|
||||
|
||||
|
||||
@@ -1,4 +1,6 @@
|
||||
{!guides/vpn/openvpn/deprecation_notice.md!}
|
||||
--8<--
|
||||
docs/guides/vpn/openvpn/deprecation_notice.md
|
||||
--8<--
|
||||
|
||||
This tutorial is tailored for setting up OpenVPN on a cloud-hosted virtual server. If you wish to have this working on your home network, you will need to tailor Pi-hole to listen on `eth0` (or similar), which we explain in [this section of the tutorial](dual-operation.md).
|
||||
|
||||
|
||||
@@ -1,4 +1,6 @@
|
||||
{!guides/vpn/openvpn/deprecation_notice.md!}
|
||||
--8<--
|
||||
docs/guides/vpn/openvpn/deprecation_notice.md
|
||||
--8<--
|
||||
|
||||
## Install an operating system
|
||||
|
||||
|
||||
@@ -1,4 +1,6 @@
|
||||
{!guides/vpn/openvpn/deprecation_notice.md!}
|
||||
--8<--
|
||||
docs/guides/vpn/openvpn/deprecation_notice.md
|
||||
--8<--
|
||||
|
||||
### Optional: Only route DNS via VPN
|
||||
|
||||
|
||||
@@ -1,4 +1,6 @@
|
||||
{!guides/vpn/openvpn/deprecation_notice.md!}
|
||||
--8<--
|
||||
docs/guides/vpn/openvpn/deprecation_notice.md
|
||||
--8<--
|
||||
|
||||
### Change OpenVPN's resolvers
|
||||
|
||||
|
||||
@@ -1,4 +1,6 @@
|
||||
{!guides/vpn/openvpn/deprecation_notice.md!}
|
||||
--8<--
|
||||
docs/guides/vpn/openvpn/deprecation_notice.md
|
||||
--8<--
|
||||
|
||||
### CRL expired
|
||||
|
||||
|
||||
@@ -85,15 +85,11 @@ markdown_extensions:
|
||||
# Adds the ability to define abbreviations (https://squidfunk.github.io/mkdocs-material/reference/tooltips/)
|
||||
- abbr
|
||||
- attr_list
|
||||
# Include files in other documents like {!some/dir/in/docs/filename.md!}
|
||||
- markdown_include.include:
|
||||
base_path: docs
|
||||
- pymdownx.snippets:
|
||||
# auto_append abbreviations.md to every file
|
||||
# https://squidfunk.github.io/mkdocs-material/reference/tooltips/#adding-a-glossary
|
||||
auto_append:
|
||||
- docs/abbreviations.md
|
||||
# Include files in other documents like {!some/dir/in/docs/filename.md!}
|
||||
# Metadata support in pages
|
||||
# (https://squidfunk.github.io/mkdocs-material/extensions/metadata/)
|
||||
- meta
|
||||
|
||||
@@ -1,4 +1,3 @@
|
||||
zensical==0.0.8
|
||||
mkdocs-git-revision-date-localized-plugin==1.5.0
|
||||
mkdocs-redirects==1.2.2
|
||||
markdown-include==0.8.1
|
||||
|
||||
Reference in New Issue
Block a user