You've already forked matrix-bot
mirror of
https://github.com/t2linux/matrix-bot.git
synced 2026-04-30 13:54:23 -07:00
Noa Himesaka
43 lines
1.2 KiB
Markdown
43 lines
1.2 KiB
Markdown
# Matrix Wiki Link Bot
|
|
|
|
A simple Matrix bot that listens for commands starting with `.wiki` and responds with links from a configured JSON store.
|
|
|
|
## Configuration
|
|
|
|
The bot is configured via environment variables.
|
|
|
|
| Variable | Description | Default |
|
|
|----------|-------------|---------|
|
|
| `MATRIX_HOMESERVER` | The URL of your Matrix homeserver (e.g., `https://matrix.org`). | |
|
|
| `MATRIX_USERNAME` | The bot's Matrix username. | |
|
|
| `MATRIX_PASSWORD` | The bot's Matrix password. | |
|
|
| `IGNORE_BRIDGE_USERS`| If set to `true`, the bot will ignore messages from senders whose MXID starts with `@discord_`. | `false` |
|
|
|
|
## Usage
|
|
|
|
### Docker
|
|
|
|
1. Copy `docker-compose.example.yml` to `docker-compose.yml` and `links.json` to a local file.
|
|
2. Update the environment variables in `docker-compose.yml`.
|
|
3. Populate `links.json` with your key-value pairs.
|
|
4. Run the bot:
|
|
|
|
```bash
|
|
docker-compose up -d
|
|
```
|
|
|
|
### Local Development
|
|
|
|
1. Copy `.env.example` to `.env`.
|
|
2. Update `.env` with your credentials.
|
|
3. Run the bot:
|
|
|
|
```bash
|
|
cargo run
|
|
```
|
|
|
|
## Commands
|
|
|
|
- `.wiki list`: Lists all available wiki keys.
|
|
- `.wiki <term>`: Fetches the link associated with `<term>` from the `links.json` file.
|