Skip to content

Commit

Permalink
Relay API spec: update output of /help remote
Browse files Browse the repository at this point in the history
  • Loading branch information
flashcode committed Apr 7, 2024
1 parent ca0dd5e commit 1778b54
Showing 1 changed file with 5 additions and 7 deletions.
12 changes: 5 additions & 7 deletions specs/2023-005-relay-http-rest-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -1300,20 +1300,18 @@ Each remote is defined by:
control of remote relay servers
list: list remote relay servers
list: list remote relay servers (without argument, this list is displayed)
listfull: list remote relay servers (verbose)
add: add a remote relay server
name: name of remote relay server, for internal and display use; this name is used to connect to the server and to set server options: relay.remote.name.xxx
url: URL of the remote, format is https://example.com:9000 or http://example.com:9000 (plain-text connection, not recommended)
option: set option for remote: proxy, password or totp_secret
name: name of remote relay server, for internal and display use; this name is used to connect to the remote relay and to set remote relay options: relay.remote.name.xxx
url: URL of the remote relay, format is https://example.com:9000 or http://example.com:9000 (plain-text connection, not recommended)
option: set option for remote relay: proxy, password or totp_secret
connect: connect to a remote relay server
send: send JSON data to a remote
send: send JSON data to a remote relay server
disconnect: disconnect from a remote relay server
rename: rename a remote relay server
del: delete a remote relay server
Without argument, this command opens buffer with list of relay clients.
Examples:
/remote add example https://localhost:9000 -password=my_secret_password -totp_secret=secrettotp
/remote connect example
Expand Down

0 comments on commit 1778b54

Please sign in to comment.