Webmesh Project
GitHubToggle Dark/Light/Auto modeToggle Dark/Light/Auto modeToggle Dark/Light/Auto modeBack to homepage

Wmctl Connect

wmctl connect

Connect to a webmesh network as an ephemeral node

wmctl connect [flags]

Options

      --disable-ipv4                                 Disable IPv4
      --disable-ipv6                                 Disable IPv6
      --discovery.bootstrap-servers strings          list of bootstrap servers to use for the DHT
      --discovery.connect-timeout duration           timeout for connecting to a peer (default 5s)
      --discovery.discover                           use the libp2p kademlia DHT for discovery
      --discovery.local-addrs strings                list of local addresses to announce to the discovery service
      --discovery.rendezvous string                  pre-shared key to use as a rendezvous point for peer discovery
  -h, --help                                         help for connect
      --log-format string                            Log format for the connection, text or json (default "text")
      --log-level string                             Log level for the connection (default "info")
      --timeout duration                             Timeout for connecting to the mesh (default 30s)
      --use-mesh-dns                                 Configure the system to use MeshDNS
      --wireguard.disable-full-tunnel                Ignore routes for a default gateway. (default true)
      --wireguard.endpoints strings                  Additional WireGuard endpoints to broadcast when joining.
      --wireguard.force-interface-name               Force the use of the given name by deleting any pre-existing interface with the same name.
      --wireguard.force-tun                          Force the use of a TUN interface.
      --wireguard.interface-name string              The name of the interface. (default "webmesh0")
      --wireguard.key-file string                    The path to the WireGuard private key. If it does not exist it will be created.
      --wireguard.key-rotation-interval duration     The interval to rotate wireguard keys. Set this to 0 to disable key rotation. (default 168h0m0s)
      --wireguard.listen-port int                    The port to listen on. (default 51820)
      --wireguard.masquerade                         Enable masquerading of traffic from the wireguard interface.
      --wireguard.modprobe                           Attempt to load the wireguard kernel module on linux systems.
      --wireguard.mtu int                            The MTU to use for the interface. (default 1420)
      --wireguard.persistent-keepalive duration      The interval at which to send keepalive packets to peers.
      --wireguard.record-metrics                     Record WireGuard metrics. These are only exposed if the metrics server is enabled.
      --wireguard.record-metrics-interval duration   The interval at which to update WireGuard metrics. (default 10s)

Options inherited from parent commands

      --basic-auth-password func     The password for basic authentication
      --basic-auth-username func     The username for basic authentication
      --certificate-authority func   The path to the CA certificate for the cluster connection
      --client-certificate func      The path to the client certificate for the user
      --client-key func              The path to the client key for the user
  -c, --config string                Path to the CLI configuration file
      --context string               The name of the context to use (default "flags")
      --id-auth-key func             The path to the ID authentication key for the user
      --insecure                     Whether TLS should be disabled for the cluster connection
      --ldap-password func           The password for LDAP authentication
      --ldap-username func           The username for LDAP authentication
      --prefer-leader                Whether to prefer the leader node for the cluster connection
      --server string                The URL of the node to connect to
      --tls-skip-verify              Whether TLS verification should be skipped for the cluster connection

SEE ALSO

  • wmctl - wmctl is a CLI tool for managing a webmesh
Auto generated by spf13/cobra on 7-Nov-2023