Ansibleロール: AdGuard Home

Ansibleを使用して、AdGuard Homeのプライバシー保護および広告ブロックDNSサーバーをインストールします。

要件

• Ansible >= 2.9（以前のバージョンでも動作する可能性があります）

対応オペレーティングシステム

以下でテストされています：

• Ubuntu 16.04および18.04
• Debian stretchおよびbuster
• EL 7および8派生ディストリビューション

上記リストにない他のDebianおよびRHEL派生ディストリビューションやバージョンでもおそらく動作します。

ロール変数

設定可能なロール変数はすべてdefaults/main.ymlに定義されています：

# インストールするAdGuard Homeのバージョン（"v"プレフィックスなし）。"latest"に設定すると、
# GitHub APIを通じて最新のリリースを確認します。
adguardhome_version: "latest"

# 希望のバージョンが"latest"の場合、GitHubのAPIを使って最新のリリースを調べる際に
# GITHUB_TOKEN環境変数を使用します。GitHub APIからレート制限エラーが発生した場合は、
# これを有効にし、GITHUB_TOKEN環境変数を"repo"と"user"スコープを持つ
# パーソナルアクセストークンに設定します。
adguardhome_use_github_token: false

# AdGuard Homeを実行するユーザー。初期はディスクに設定ファイルがない場合は"root"である必要があります。
# セットアップウィザードを経過するか、手動で設定ファイルを追加した後は、
# "adguard"などの別のユーザーに設定できます。
adguardhome_user: root
adguardhome_group: "{{ adguardhome_user }}"

# adguardhome_userを"root"以外の何かに設定する場合、ユーザーがシステムユーザーとして作成されるかどうかを決定します。
# 人間がログインするユーザーであれば、システムユーザーではない可能性が高いというルールがあります。
adguardhome_system_user: true

# デフォルトパス。
adguardhome_bin_dir: "/opt/{{ adguardhome_service_name }}/bin"
adguardhome_config_dir: "/opt/{{ adguardhome_service_name }}/config"
adguardhome_config_name: AdGuardHome.yml
adguardhome_data_dir: "/opt/{{ adguardhome_service_name }}"
adguardhome_tmp_dir: /tmp

# systemdサービスユニットを有効にして開始しますか？
adguardhome_service_name: "adguardhome"
adguardhome_service_enable: true
adguardhome_service_start: true

# systemd-resolvedサービスが実行中のとき、DNSStubResolverを無効にします。
adguardhome_disable_systemd_dnsstubresolver: true

例プレイブック

以下の例は、最新のAdGuard Homeリリースをインストールします：

- hosts: all
  roles:
    - { role: jimeh.adguardhome }

まだ設定ファイルがない場合は、AdGuard Homeがポート3000でセットアップウィザードを実行中になります。セットアップウィザードを通過すると、管理インターフェースにはポート80および443でアクセスできるようになります。

非ルートユーザー

設定ファイルがある場合、非ルートユーザーとしてAdGuard Homeを実行できます。設定ファイルがない場合、rootとして実行しない限り、単に起動を拒否します。

他のAdGuard Homeインストールから設定ファイルがない場合、最良のアプローチは次の通りです：

1. adguardhome_userをrootに設定してロールを実行します。
2. ポート3000で利用可能なセットアップウィザードを通過します。
3. 再度ロールを実行し、今度はadguardhome_userを非ルートユーザーに設定します。指定したユーザーが存在しない場合は、自動的に作成されます。

個人的には、adguardというユーザーでAdGuard Homeを実行しています。

ライセンス

このプロジェクトはMITライセンスのもとでライセンスされています。

作者情報

Jim Myhrberg