jeremy/matrix-send
1
Fork 0
Code Releases Activity

Remove need for Client-Server API addresses in docs

Browse source
This commit is contained in:
Jeremy Baxter 2023-01-09 12:48:51 +13:00
parent 8c4b17b9a2
commit f006c27174
4 changed files with 7 additions and 14 deletions
Download patch file Download diff file Expand all files Collapse all files

2
README.md
View file

@ -24,7 +24,7 @@ Now edit the file ~/.config/matrix-send/config.lua. You will first see the `logi
```lua ```lua
-- This is a comment -- This is a comment
login = { login = {
server = "matrix-client.matrix.org", -- matrix.org server = "matrix.org",
username = "user", username = "user",
password = "password" password = "password"
} }

2
config.lua
View file

@ -1,6 +1,6 @@
login = { login = {
-- The Matrix server to use. -- The Matrix server to use.
server = "matrix-client.matrix.org", -- matrix.org server = "matrix.org",
-- The user to log in to. -- The user to log in to.
username = "user", username = "user",

6
matrix-send-config.5
View file

@ -20,7 +20,7 @@ The following configuration options are available:
.Bl -tag -width 11n .Bl -tag -width 11n
.Bl -tag -width login.server .Bl -tag -width login.server
.It Ic login.server Ar 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 .It Ic login.username Ar username
The username of the account being used. The username of the account being used.
.It Ic login.password Ar password .It Ic login.password Ar password
@ -50,11 +50,11 @@ default cache directory
.El .El
.Sh EXAMPLES .Sh EXAMPLES
The following example logs into the user 'john' of the server 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. and sets the default event type to m.notice.
.Bd -literal -offset indent .Bd -literal -offset indent
login = { login = {
server = "matrix-client.matrix.org", server = "matrix.org",
username = "john", username = "john",
password = "supersecretpassword" password = "supersecretpassword"
} }

11
matrix-send.1
View file

@ -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: is supersecretpassword. Your configuration could look like this:
.Bd -literal -offset indent .Bd -literal -offset indent
login = { login = {
server = "matrix.envs.net", server = "envs.net",
username = "john", username = "john",
password = "supersecretpassword" password = "supersecretpassword"
} }
@ -59,18 +59,11 @@ login = {
.Pp .Pp
It could also look like this: It could also look like this:
.Bd -literal -offset indent .Bd -literal -offset indent
login.server = "matrix.envs.net" login.server = "envs.net"
login.username = "john" login.username = "john"
login.password = "supersecretpassword" login.password = "supersecretpassword"
.Ed .Ed
.Pp .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 More information on configuration options can be found in
.Xr matrix-send-config 5 . .Xr matrix-send-config 5 .
.Pp .Pp