NAME

config.lua — configuration file for matrix-send(1)

DESCRIPTION

matrix-send(1) sends messages to Matrix rooms. In order to send a message however, it needs credentials for the account sending the message. These credentials are provided in the config.lua configuration file, as well as other options if you need them.

The configuration file is in Lua format, meaning you can write whatever Lua code you wish inside.

The following configuration options are available:

login.server server

The address of the Matrix server being used.

login.username username

The username of the account being used.

login.password password

The password for the account being used.

login.token token

Instead of authenticating via username and password to obtain an access token, use token as the access token.

cache.location location

Use location as the cache location.

cache.disable

Don't cache anything.

advanced.event type

Modify the default event type from the default (m.text) to type. Supported types are m.text, and m.notice.

FILES

~/.config/matrix-send/config.lua

matrix-send(1) configuration file

~/.cache/matrix-send

default cache directory

EXAMPLES

The following example logs into the user 'john' of the server matrix.org, and the password 'supersecretpassword', and sets the default event type to m.notice.

login = {
	server = "matrix.org",
	username = "john",
	password = "supersecretpassword"
}

advanced.event = "m.notice"

SEE ALSO

matrix-send(1)