hackfedd/examples/config.example.yaml at drafts/base · hackfed/hackfedd · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
# General configuration for HackFed deployment.
# Required.
general:
  # Unique identifier for this organization.
  # Required.
  org_id: "acme"

  # Root URL of the HackFed directory service.
  # Optional, defaults to "https://directory.hackfed.org".
  directory: "https://directory.hackfed.org"

  # Directory refresh interval in seconds.
  # Optional, defaults to 900 (15 minutes).
  directory_refresh_interval: 900

  # List of organization IDs to avoid peering with.
  # Optional, defaults to empty list.
  ignored_orgs:
    - "bad-guys-inc"

# WireGuard service configuration.
# Optional. Disabled if not present.
wireguard:
  # Name of the WireGuard interface to be created.
  # Optional. Defaults to "hackfed0".
  interface_name: hackfed0

  # Port on which the WireGuard interface will listen for incoming connections.
  # Optional. Disables listening if not present.
  listen_port: 31337

  # Private key for the WireGuard interface.
  # Required.
  private_key: PrivateKeyHere==

  # Way to provide a custom Eta template for the WireGuard configuration file.
  # Optional. If not present, a default template will be used.
  # template_path: /data/wireguard/hackfed0.conf.template

  # IPv6 address of this node inside the tunnel.
  # Required.
  address: "fd79:7636:1f08:883d::1"

  # Output configuration for WireGuard service.
  # Required
  output:

    # Type of WireGuard service integration.
    # Required.
    type: wgquick

    # wg-quick output configuration.
    # Required if type is "wgquick".
    wgquick:
      # Path to which hackfedd will render the WireGuard configuration file.
      # Optional. Defaults to "/etc/wireguard/hackfed0.conf".
      path: /data/wireguard/hackfed0.conf

      # Lifecycle strategy for applying the rendered WireGuard configuration.
      #  - "cmd": use wg-quick down/up at startup and wg-quick strip + wg syncconf for updates.
      #  - "systemctl": restart wg-quick@<interface_name>.service at startup and after updates;
      #    wg-quick systemd units do not provide a reload operation.
      # Optional. Default to "cmd".
      strategy: cmd

# Telephony service configuration.
# Optional, disabled if not present.
telephony:

  # This exchange ID within the organization.
  # Optional, defaults to "primary".
  org_exchange_id: primary

  # Output configuration for telephony service.
  # Optional. If not present, telephony service is disabled.
  output:
    # Type of telephony service integration.
    # Required.
    type: asterisk

    # Asterisk output configuration.
    # Required if type is "asterisk".
    asterisk:
      # Directory to which hackfedd will render configuration templates.
      # Optional. Defaults to "/data/asterisk-configs".
      # for freepbx, use /etc/asterisk/hackfed
      directory: /data/asterisk-configs

      # Way to reload Asterisk configuration after rendering templates.
      # Optional. If not present, no reload will be performed.
      reload:
        # Method to reload Asterisk configuration.
        # Required.
        type: ami+http

        # AMI+HTTP reload configuration.
        # Required if type is "ami+http".
        ami:
          # URL to AMI over built-in web server
          # Optional, defaults to "http://asterisk:8088/manager".
          # /rawman is also supported.
          uri: http://asterisk:8088/manager

          # AMI username.
          # Optional, defaults to "hackfedd".
          username: hackfedd

          # AMI secret. Required; use a strong, unique value.
          secret: replace-with-a-strong-generated-secret