From 59b9ba67b7b3ed8e31d23ee30ef3d942189ca6d9 Mon Sep 17 00:00:00 2001 From: Jeremy Date: Mon, 9 Jan 2023 12:48:51 +1300 Subject: [PATCH] Remove need for Client-Server API addresses in docs --- README.md | 2 +- config.lua | 2 +- matrix-send-config.5 | 6 +++--- matrix-send.1 | 11 ++--------- 4 files changed, 7 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 7fbe876..27fdd89 100644 --- a/README.md +++ b/README.md @@ -24,7 +24,7 @@ Now edit the file ~/.config/matrix-send/config.lua. You will first see the `logi ```lua -- This is a comment login = { - server = "matrix-client.matrix.org", -- matrix.org + server = "matrix.org", username = "user", password = "password" } diff --git a/config.lua b/config.lua index f271a49..87ce0c4 100644 --- a/config.lua +++ b/config.lua @@ -1,6 +1,6 @@ login = { -- The Matrix server to use. - server = "matrix-client.matrix.org", -- matrix.org + server = "matrix.org", -- The user to log in to. username = "user", diff --git a/matrix-send-config.5 b/matrix-send-config.5 index b2c468c..717a286 100644 --- a/matrix-send-config.5 +++ b/matrix-send-config.5 @@ -20,7 +20,7 @@ The following configuration options are available: .Bl -tag -width 11n .Bl -tag -width login.server .It Ic login.server Ar server -The Client-Server API address of the Matrix server being used. +The address of the Matrix server being used. .It Ic login.username Ar username The username of the account being used. .It Ic login.password Ar password @@ -50,11 +50,11 @@ default cache directory .El .Sh EXAMPLES The following example logs into the user 'john' of the server -matrix-client.matrix.org, and the password 'supersecretpassword', +matrix.org, and the password 'supersecretpassword', and sets the default event type to m.notice. .Bd -literal -offset indent login = { - server = "matrix-client.matrix.org", + server = "matrix.org", username = "john", password = "supersecretpassword" } diff --git a/matrix-send.1 b/matrix-send.1 index e4aebc8..3a4f4a0 100644 --- a/matrix-send.1 +++ b/matrix-send.1 @@ -51,7 +51,7 @@ Let's say your Matrix server is envs.net, your username is john, and your passwo is supersecretpassword. Your configuration could look like this: .Bd -literal -offset indent login = { - server = "matrix.envs.net", + server = "envs.net", username = "john", password = "supersecretpassword" } @@ -59,18 +59,11 @@ login = { .Pp It could also look like this: .Bd -literal -offset indent -login.server = "matrix.envs.net" +login.server = "envs.net" login.username = "john" login.password = "supersecretpassword" .Ed .Pp -In those examples, we used matrix.envs.net instead of envs.net. This is because -matrix.envs.net is the address in which the Client-Server API is listening on. -You can find this address in Element by entering in your server into the -Homeserver dialogue in the sign-in screen, then hovering -over it once entered. Your server's Client-Server API URL should appear once -you hover over it. If it doesn't appear, you should already have it. -.Pp More information on configuration options can be found in .Xr matrix-send-config 5 . .Pp