votum.ngrok
ansibleロール for ngrok
このロールは、ngrokのバイナリをダウンロードしてインストールし、カスタムトンネルの設定を追加します。
要件
なし
ロール変数
| 名前 | デフォルト | 説明 |
|---|---|---|
| ngrok_download | https://bin.equinox.io/c/4VmDzA7iaHb/ngrok-stable-linux-amd64.zip | |
| ngrok_path_download_tmp | /tmp | |
| ngrok_path_install | /opt/ngrok | |
| ngrok_path_bin | /usr/bin/ngrok | |
| ngrok_path_init | /etc/init.d | |
| ngrok_path_systemd | /lib/systemd/system | |
| ngrok_auth_token | 必須、プレイブックの変数で設定する必要があります | |
| ngrok_console_ui | false | |
| ngrok_region | eu | |
| ngrok_tunnels | [] | |
| ngrok_user | オプション、設定されていない場合のデフォルト: ansible_ssh_user | |
| ngrok_start_tunnel | --all | サービスで実行するトンネル（オプション）、デフォルトではすべてのトンネルが開始されます |
| ngrok_install_as_service | false | 初期化スクリプトを作成します |
| ngrok_service_name | ngrok | |
| ngrok_daemon | {{ ngrok_path_bin }} | |
| ngrok_daemon_opts | start {{ ngrok_start_tunnel }} --config /home/{{ ngrok_user }}/.ngrok2/ngrok.yml | |
| ngrok_pidfile | /var/run/ngrok.pid |
トンネル設定の例:
ngrok_tunnels:
- name: "トンネルのカスタム名"
hostname: "my-custom-host.ngrok.io" # オプション
subdomain: "my-custom-subdomain" # ngrok.ioのサブドメイン（オプション）、ホスト名が定義されていない場合のみ使用されます。
# サブドメインが定義されていない場合、ngrokはトンネル名をサブドメインとして使用します。
address: "my.local.address:80"
proto: "http" # オプション、デフォルト: http
bind_tls: both # オプション、デフォルト: both （false: httpのみ、true: httpsのみ、both: http & https）
auth:
username: "ngrokuser"
password: "secretpassword"
依存関係
なし
例プレイブック
ユーザーのために、役割を使用する方法の例（パラメーターとして引き渡された変数を含む）があると良いでしょう：
- hosts: servers
roles:
- { role: "votum.ngrok" }
ライセンス
このプロジェクトはMITライセンスの下にあります。完全なライセンス文はLICENSEファイルを参照してください。