{"id":21945086,"url":"https://github.com/gurkengewuerz/matrix-bot","last_synced_at":"2026-05-14T13:40:27.067Z","repository":{"id":143577449,"uuid":"353811675","full_name":"Gurkengewuerz/matrix-bot","owner":"Gurkengewuerz","description":"Matrix bot system with plugin support written in Go","archived":false,"fork":false,"pushed_at":"2021-04-06T13:08:06.000Z","size":93,"stargazers_count":4,"open_issues_count":1,"forks_count":0,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-02-03T17:48:00.737Z","etag":null,"topics":["chatbot","goja","golang","javascript","matrix","matrix-org","plugin"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Gurkengewuerz.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-04-01T19:55:35.000Z","updated_at":"2023-04-21T03:53:37.000Z","dependencies_parsed_at":null,"dependency_job_id":"fa7b48cd-7ff4-4dcd-920b-136d94d0be52","html_url":"https://github.com/Gurkengewuerz/matrix-bot","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Gurkengewuerz%2Fmatrix-bot","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Gurkengewuerz%2Fmatrix-bot/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Gurkengewuerz%2Fmatrix-bot/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Gurkengewuerz%2Fmatrix-bot/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Gurkengewuerz","download_url":"https://codeload.github.com/Gurkengewuerz/matrix-bot/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244982060,"owners_count":20542301,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["chatbot","goja","golang","javascript","matrix","matrix-org","plugin"],"created_at":"2024-11-29T04:17:44.645Z","updated_at":"2025-10-19T11:02:39.619Z","avatar_url":"https://github.com/Gurkengewuerz.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# matrix-bot\n\nA plugin-based Matrix bot system written in Go.\n\n# Current Plugins 🕹\n\n- [github.js](https://github.com/Gurkengewuerz/matrix-bot/blob/main/plugins/github.js) responds to GitHub Event Webhooks\n  like pipeline events or push events.\n- [teamcity.js](https://github.com/Gurkengewuerz/matrix-bot/blob/main/plugins/teamcity.js) responds\n  to [tcWebHooks](https://github.com/tcplugins/tcWebHooks) `Legacy Webhook (JSON)` requests\n- [dice.js](https://github.com/Gurkengewuerz/matrix-bot/blob/main/plugins/dice.js) a simple dice rolling bot\n\n# Configuration ✒\n\nRegister a new client (*preferably* using\nthe [Matrix admin API](https://github.com/matrix-org/synapse/tree/master/docs/admin_api)). These credentials has to be\nset in the `config.yaml` afterwards. Note: to use the bot, you have to invite it into your room. It will join\nautomatically. You can configure a room whitelist inside the `config.yaml`.\n\n1. Create a new user `useradd -m matrix` and enter its home directory `cd /home/matrix`\n2. Create a directory `mkdir matrix-bot` and enter it `cd matrix-bot`\n3. Copy the build binaries and the `plugins/` directory into the folder\n4. Copy `config.yaml.sample` to `config.yaml` and update to your liking\n5. Make the binary executable `chmod +x matrix-bot`\n6. Make sure every file has `matrix-bot` as the owner\n\n--------\n\n7. Set-Up a reverse proxy with Let's Encrypt\n8. Install the `matrix-bot.service` systemd file to `/etc/systemd/system/`\n9. Set-Up Pantalaimon for encryption support\n\nAfter that one more step is requered for the device id: Run the binary with the required arguments. The bot will\nregister it self and generates a device id. Enter the device id inside your configuration file and start the bot.\n\n# Commandline arguments 💻\n\n- `-help` print help\n- `-config` relative or absolute path of the `config.yaml`. Default: `${binary_dir}/config.yaml`\n- `-plugin` relative or absolute path of the `plugins/` folder. Default: `${binary_dir}/plugins/`\n\n# How to build ⚙\n\n1. Clone the repo:\n\n```\ngit clone --recurse-submodules git@github.com:Gurkengewuerz/matrix-bot.git\ncd matrix-bot\n```\n\n2. Build repository `go build`\n\n⚠ Because we are using go-sqlite3 CGO is needed!\n\nFor cross-compiling from a newer Linux Distro (i.e. Windows WSL) to an older linux distro you can\ntry `go build --ldflags '-linkmode external -extldflags \"-static\"'`\n\n*Dev branch build artifacts for Linux/amd64 are available in the the GitHub Actions.*\n\n# Encryption Support 🔐\n\nEncryption is supported using the E2EE aware proxy daemon [pantalaimon](https://github.com/matrix-org/pantalaimon).  \nPlease follow the installation instructions in their repository. Afterwards you should set the Homeserver in the bot\nconfig to pantalaimon.\n\n# Plugin Setup\n\n### GitHub `github.js`\n\n1. Active `github.js` in the `config.yaml`\n2. (Re)start your bot\n3. Test if plugin is loaded with `!gh ping`\n4. Add your repository with `!gh add \u003cusername\u003e/\u003crepo\u003e`\n5. Get Webhook URL with `!gh webhook`\n6. Add Webhook to your GitHub repository/project and select your wanted events\n\n### TeamCity `teamcity.js`\n\n1. Active `teamcity.js` in the `config.yaml`\n2. (Re)start your bot\n3. Test if plugin is loaded with `!tc ping`\n4. Add your Build configuration (build config id) with `!tc add \u003cbuild config id\u003e`\n5. Get Webhook URL with `!tc webhook`\n6. Add a `Legacy Webhook (JSON)` to your project and select your wanted events\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgurkengewuerz%2Fmatrix-bot","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgurkengewuerz%2Fmatrix-bot","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgurkengewuerz%2Fmatrix-bot/lists"}