relay create

ockam relay create [OPTIONS] [RELAY_NAME]

Create a Relay. If no arguments are passed in, and you are enrolled in Orchestrator, then it creates a Relay at the default Orchestrator project, to the local default node.

Arguments

  • [RELAY_NAME] (optional)
    Name of the relay. If not provided, 'default' will be used

Options

  • --to [NODE_NAME] (optional)
    Node for which to create the relay

  • --at [ROUTE] (optional)
    Route to the node at which to create the relay

  • --authorized [AUTHORIZED] (optional)
    Authorized identity for secure channel connection

  • --relay-address [RELAY_ADDRESS] (optional)
    Relay address to use. By default, inherits the relay name

  • --project-relay (optional)
    [DEPRECATED] Whether the relay will be used to relay messages at a project. By default, this information will be inferred from the --at argument

  • --no-connection-wait (optional)
    Create the Relay without waiting for the connection to be established

  • --retry-count [RETRY_COUNT] (optional)
    Number of times to retry the command

  • --retry-delay [RETRY_DELAY] (optional)
    Delay between retries

  • --no-retry (optional)
    Disable retry for the command, no matter if it's enabled via arguments or environment variables

Examples:

$ ockam relay create r --at n1 --to n2

Learn More:

Use 'ockam --help' for more information about a subcommand. Where might be: 'node', 'status', 'enroll', etc. Learn more about Command: https://command.ockam.io/manual/ Learn more about Ockam: https://docs.ockam.io/reference/command

Feedback:

If you have questions, as you explore, join us on the contributors discord channel https://discord.ockam.io