{"id":43154207,"url":"https://github.com/dfuchss/matrix-joinlink","last_synced_at":"2026-02-01T00:31:24.880Z","repository":{"id":176484962,"uuid":"658374517","full_name":"dfuchss/matrix-joinlink","owner":"dfuchss","description":"A bot that can create JoinLinks for non-public matrix rooms","archived":false,"fork":false,"pushed_at":"2026-01-25T00:39:17.000Z","size":537,"stargazers_count":16,"open_issues_count":3,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2026-01-25T07:44:58.849Z","etag":null,"topics":["bot","incubator","invite","matrix","trixnity"],"latest_commit_sha":null,"homepage":"https://fuchss.org/projects/joinlink","language":"Kotlin","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/dfuchss.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2023-06-25T15:02:59.000Z","updated_at":"2026-01-24T20:55:56.000Z","dependencies_parsed_at":null,"dependency_job_id":"ca7d4962-5282-4bf5-8266-20233b7a67da","html_url":"https://github.com/dfuchss/matrix-joinlink","commit_stats":null,"previous_names":["dfuchss/matrixjoinlink","dfuchss/matrix-joinlink"],"tags_count":56,"template":false,"template_full_name":null,"purl":"pkg:github/dfuchss/matrix-joinlink","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dfuchss%2Fmatrix-joinlink","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dfuchss%2Fmatrix-joinlink/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dfuchss%2Fmatrix-joinlink/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dfuchss%2Fmatrix-joinlink/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dfuchss","download_url":"https://codeload.github.com/dfuchss/matrix-joinlink/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dfuchss%2Fmatrix-joinlink/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28961962,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-31T23:03:11.038Z","status":"ssl_error","status_checked_at":"2026-01-31T22:56:44.691Z","response_time":128,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":["bot","incubator","invite","matrix","trixnity"],"created_at":"2026-02-01T00:31:24.310Z","updated_at":"2026-02-01T00:31:24.875Z","avatar_url":"https://github.com/dfuchss.png","language":"Kotlin","funding_links":[],"categories":[],"sub_categories":[],"readme":"# MatrixJoinLink - A bot that allows the creation of Join Links to non-public Rooms in Matrix\n\nThis bot allows the creation of join links to non-public rooms in matrix. It uses the [Trixnity](https://trixnity.gitlab.io/trixnity/) framework.\n\n## Reason for this Bot\n\nI always struggled with the problem that I have private rooms, I want to share with a group of friends. Before the bot, I had to invite all the people. Now I\ncan invite _JoinLink_ and create an invite link. This link can be shared to my friends who want to join my room (including spaces).\n\n## Setup\n\n1. Get a matrix account for the bot (e.g., on your own homeserver or on `matrix.org`)\n2. Prepare configuration:\n    * Copy `config-sample.json` to `config.json`\n    * Enter `baseUrl` to the matrix server and `username` / `password` for the bot user\n    * Set an encryption key. The bot will use this string as key to encrypt the state events.\n    * Add yourself (e.g., `@user:matrix.org`) or your homeserver (e.g., `:matrix.org`) to the `users` (empty == allow all). Users can interact with the bot.\n    * Add yourself to the `admins` (can't be empty)\n3. Either run the bot via jar or run it via the provided docker.\n    * If you run it locally, you can use the environment variable `CONFIG_PATH` to point at your `config.json` (defaults to `./config.json`)\n    * If you run it in docker, you can use a command similar to\n      this `docker run -itd -v $LOCAL_PATH_TO_CONFIG:/usr/src/bot/data/config.json:ro ghcr.io/dfuchss/matrixjoinlink`\n    * If you want to persist sessions, you should persist the data volume `-v $LOCAL_PATH_TO_DATA:/usr/src/bot/data`\n\n## Configuration Options\n\nThe `config.json` file supports the following configuration options:\n\n### Required Options\n\n| Option | Type | Description |\n|--------|------|-------------|\n| `baseUrl` | String | The base URL of the Matrix server the bot should connect to (e.g., `https://matrix-client.matrix.org`) |\n| `username` | String | The username of the bot's Matrix account |\n| `password` | String | The password of the bot's Matrix account |\n| `admins` | Array of Strings | List of Matrix user IDs that have administrative privileges (e.g., `[\"@admin:example.org\"]`). Cannot be empty |\n| `encryptionKey` | String | A symmetric encryption key used to encrypt state events. Must not be empty. Keep this secure and don't share it |\n\n### Optional Options\n\n| Option | Type | Default | Description |\n|--------|------|---------|-------------|\n| `prefix` | String | `\"join\"` | The command prefix the bot listens to. Commands will be in the format `!\u003cprefix\u003e \u003ccommand\u003e` |\n| `dataDirectory` | String | `\"./data/\"` | The path to the directory where the bot stores its databases and media files |\n| `users` | Array of Strings | `[]` | List of Matrix user IDs or server domains that are authorized to use the bot. Use `@user:domain` for specific users or `:domain` for entire servers. Empty array allows all users |\n\n### Configuration Examples\n\n**Minimal Configuration:**\n```json\n{\n    \"baseUrl\": \"https://matrix-client.matrix.org\",\n    \"username\": \"joinlinkbot\",\n    \"password\": \"your-bot-password\",\n    \"encryptionKey\": \"your-secure-encryption-key-here\",\n    \"admins\": [\"@yourusername:matrix.org\"]\n}\n```\n\n**Full Configuration:**\n```json\n{\n    \"prefix\": \"joinlink\",\n    \"baseUrl\": \"https://your-matrix-server.example.org\",\n    \"dataDirectory\": \"/opt/bot/data/\",\n    \"username\": \"joinlinkbot\",\n    \"password\": \"your-bot-password\",\n    \"encryptionKey\": \"your-secure-encryption-key-here\",\n    \"admins\": [\n        \"@admin1:example.org\",\n        \"@admin2:example.org\"\n    ],\n    \"users\": [\n        \":example.org\",\n        \"@specific-user:other-server.org\"\n    ]\n}\n```\n\n**Security Notes:**\n- Keep your `encryptionKey` secure and unique\n- Use strong passwords for the bot account\n- Consider restricting `users` to specific domains or users for better security\n- The bot needs invite permissions in rooms to create join links\n\n## Usage\n\n* A user (see user list in configuration file) can invite the bot to a room.\n* After the bot has joined use `!join help` to get an overview about the features of the bot (remember: the bot only respond to users in the user list)\n* In order to create a Join Link simply type `!join link SomeFancyNameForTheLink` and the bot will create a join link. Please make sure that the bot has the ability to invite users.\n\n![Help](.docs/help.png)\n\n### Creation of Join (Invite) Links\n![Creation](.docs/creation.png)\n\n### Entering a Join (Invite) Link Room\n![Enter](.docs/joined.png)\n\n### Unlinking a Join (Invite) Link\n![Unlink](.docs/unlink.png)\n\n## Development\n\nI'm typically online in the [Trixnity channel](https://matrix.to/#/#trixnity:imbitbu.de). So feel free to tag me there if you have any questions.\n\n* The basic functionality is located in [Main.kt](src/main/kotlin/org/fuchss/matrix/joinlink/Main.kt). There you can also find the main method of the bot.\n\n### How does the bot work\n\n1. Let's assume that you want to share the private room `!private:room.domain`\n2. After you've invited the bot, you can enter `!join link IShareLinksWithYou`\n3. The bot creates a new public room that contains \"IShareLinksWithYou\" in its name. This room will not be listed in the room directory; for this example its ID\n   is `!public:room.domain`\n4. If somebody joins the public room, the bot verifies based on two encrypted state events in `!private:room.domain` and `!public:room.domain` whether the rooms\n   belong to each other. If so, the bot simply invites the user to the private room.\n5. If you want to disable the share simply type `!join unlink` in the private room. This will invalidate the join link.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdfuchss%2Fmatrix-joinlink","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdfuchss%2Fmatrix-joinlink","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdfuchss%2Fmatrix-joinlink/lists"}