votum.ngrok

ansible Rolle für ngrok

Build Status

Diese Rolle wird die ngrok-Binärdatei herunterladen und installieren sowie eine benutzerdefinierte Tunnelkonfiguration hinzufügen.

Anforderungen

Keine

Rollenvariablen

Name Standard Beschreibung
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 erforderlich, muss in den Playbook-Variablen gesetzt werden
ngrok_console_ui false
ngrok_region eu
ngrok_tunnels []
ngrok_user optional, standardmäßig, wenn nicht gesetzt: ansible_ssh_user
ngrok_start_tunnel --all Tunnel, der im Dienst ausgeführt werden soll (optional), standardmäßig werden alle Tunnel gestartet
ngrok_install_as_service false erstellt ein Init-Skript
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

Beispiel für eine Tunnelkonfiguration:

ngrok_tunnels:
  - name:       "benutzerdefinierter-name-für-tunnel"
    hostname:   "mein-benutzerdefinierter-host.ngrok.io"  # optional
    subdomain:  "mein-benutzerdefinierter-subdomain"      # Subdomain für ngrok.io (optional), wird nur verwendet, wenn der Hostname nicht definiert ist.
                                                       # Wenn auch die Subdomain nicht definiert ist, verwendet ngrok den Tunnel-Namen als Subdomain
    address:    "meine.lokale.adresse:80"
    proto:      "http"                                     # optional, Standard: http
    bind_tls:   both                                       # optional, Standard: both (false: nur http, true: nur https, both: http & https)
    auth:
      username: "ngrokuser"
      password: "geheimpassword"

Abhängigkeiten

Keine

Beispiel-Playbook

Ein Beispiel, wie man deine Rolle verwendet (zum Beispiel mit als Parameter übergebenen Variablen), ist immer nett für die Benutzer:

- hosts: server
  roles:
     - { role: "votum.ngrok" }

Lizenz

Dieses Projekt steht unter der MIT-Lizenz. Siehe die LICENSE-Datei für den vollständigen Lizenztext.

Autoreninformation

Bernd Alter / VOTUM GmbH

Über das Projekt

Role for ngrok installation and tunnel configuration

Installieren
ansible-galaxy install votum.ngrok
GitHub Repository
Lizenz
mit
Downloads
7.2k
Besitzer