jeremy/matrix-send
1
Fork 0
Code Releases Activity

Updated documentation

Browse source
This commit is contained in:
Jeremy Baxter 2022-07-28 20:41:32 +12:00
parent 98396c27cb
commit 81a02d9cfe
2 changed files with 21 additions and 21 deletions
Download patch file Download diff file Expand all files Collapse all files

24
README.md
View file

@ -29,9 +29,9 @@ You will see three "directives"; configuration options that take an argument. Di
Directive Argument Directive Argument
Modify the `Homeserver` directive to match your homeserver's Matrix URL. If you're using matrix.org you can leave it as default. Modify the `Server` directive to match your server's Matrix URL. If you're using matrix.org you can leave it as default.
If you're not using matrix.org, one way you can find your homeserver's Matrix URL is by typing your homeserver's address into Element. Click Continue, and hover over your homeserver's address that popped up. The Matrix URL should be showing. If you're not using matrix.org, one way you can find your server's Matrix URL is by typing your server's address into Element. Click Continue, and hover over your server's address that popped up. The Matrix URL should be showing.
Set the `Username` directive to your username, and the `Password` directive to your password. Set the `Username` directive to your username, and the `Password` directive to your password.
@ -43,9 +43,9 @@ This will open `gpg` to decrypt a file with your password inside. You will need
After you've finished changing these, your configuration should look like this (without the comments): After you've finished changing these, your configuration should look like this (without the comments):
Homeserver matrix-client.matrix.org # or your homeserver Server matrix-client.matrix.org # or your server
Username jeremy # or your name Username jeremy # your name
Password mysupersecurepassword # or your password Password mysupersecurepassword # your password
After you have these three directives set, you're ready to start. After you have these three directives set, you're ready to start.
@ -53,18 +53,16 @@ Additional directives can be found in [config.md](https://github.com/jtbx/matrix
--- ---
To install, run `sudo make install` in the cloned repository's directory. To install, run `make install` as root, in the cloned repository's directory.
sudo make install make install
Now, using your Matrix client, make a room, and find the Room ID. On Element, right click your room, and click Advanced. Your Room ID is under "Internal Room ID". Now, using your Matrix client, make a room, and find the Room ID. On Element, right click your room, and click Advanced. Your Room ID is under "Internal Room ID".
Your Room ID will start with a '!'. Remove this symbol from the start and copy the new ID. To send a message to your chosen room, type `matrix-send` followed by your message (in speech marks) and then your Room ID. You may need to escape the exclamation mark(s). For example:
To send a message to your chosen room, type `matrix-send` followed by your message (in speech marks) and then your Room ID. For example: matrix-send "Hi\!" \!asdfasdfasdfasdf:matrix.org
matrix-send "Hi\!" asdfasdfasdfasdf:matrix.org That will send the message "Hi!" to the Matrix room !asdfasdfasdfasdf:matrix.org.
And that will send the message "Hi!" to the Matrix room asdfasdfasdfasdf:matrix.org. For a more detailed guide, see the manual page `man matrix-send`.
Also, if you type exclamation marks '!' in a message, some shells misinterpret that as an event. To fix this, I put a backslash `\` before the exclamation mark.

18
config.md
View file

@ -7,16 +7,18 @@ Comments can be made in the file with a hashtag (`#`).
## Directives ## Directives
Options you can modify with an argument. Options that take an argument.
* `Homeserver`: The homeserver to log into * `Server`: The server to log into
* `Username`: The user's name used to log in * `Username`: The user's name used to log in
* `Password`: The user's password used to log in * `Password`: The user's password used to log in
* `AccessToken`: A custom access token to use for logging in, instead of generating a new one from login credentials * `AccessToken`: A custom access token to use for logging in (overrides username+password)
* `CacheLocation`: A custom location to cache access tokens in. Defaults to $HOME/.cache * `CacheLocation`: A custom location to cache access tokens in. Defaults to $HOME/.cache
## Statements ## Statements
Options that say one thing and nothing else. You can't change these. Options that do not take an argument.
* `NoCache`: Don't cache access tokens * `NoCache`: Don't cache access tokens
For more information, take a look at the manual page (`man matrix-send.conf`).