{"id":13554828,"url":"https://github.com/matrix-org/matrix-appservice-tg","last_synced_at":"2025-04-03T07:33:00.387Z","repository":{"id":147156725,"uuid":"78230683","full_name":"matrix-org/matrix-appservice-tg","owner":"matrix-org","description":"Matrix\u003c-\u003eTelegram user-puppeting portal","archived":true,"fork":false,"pushed_at":"2019-05-09T14:52:52.000Z","size":115,"stargazers_count":37,"open_issues_count":8,"forks_count":15,"subscribers_count":36,"default_branch":"master","last_synced_at":"2024-08-01T12:33:16.623Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/matrix-org.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":"2017-01-06T18:55:55.000Z","updated_at":"2023-01-28T18:11:09.000Z","dependencies_parsed_at":null,"dependency_job_id":"35bf43db-1cc3-4149-8881-2511d9c70f90","html_url":"https://github.com/matrix-org/matrix-appservice-tg","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/matrix-org%2Fmatrix-appservice-tg","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/matrix-org%2Fmatrix-appservice-tg/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/matrix-org%2Fmatrix-appservice-tg/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/matrix-org%2Fmatrix-appservice-tg/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/matrix-org","download_url":"https://codeload.github.com/matrix-org/matrix-appservice-tg/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":222935627,"owners_count":17060398,"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":[],"created_at":"2024-08-01T12:02:55.703Z","updated_at":"2024-11-04T03:31:20.882Z","avatar_url":"https://github.com/matrix-org.png","language":"JavaScript","funding_links":[],"categories":["JavaScript","others"],"sub_categories":[],"readme":"# THIS PROJECT IS ON HOLD\n\nThis project is not actively developed, maintained or supported at the moment. It is not recommended for production use.\n\nFor a working Telegram bridge, please check out https://github.com/tulir/mautrix-telegram\n\n\n# ARCHIVED README\n\nInstallation\n------------\n\n```sh\n$ git clone ...\n$ cd matrix-appservice-tg\n$ npm install\n```\n\n\nSetup\n-----\n\n1. Create a new Matrix room to act as the administration control room. Note\n   its internal room ID.\n\n1. Create a `telegram-config.yaml` file for global configuration. There is a\n   sample one to begin with in `config/telegram-config-sample.yaml` you may\n   wish to copy and edit as appropriate. This needs the following keys:\n\n   ```yaml\n   matrix_homeserver: \"http URL pointing at the homeserver\"\n\n   matrix_user_domain: \"domain part of the homeserver's name. Used for\n                        ghost username generation\"\n\n   username_template: \"template for virtual users, e.g. telegram_${USER}\"\n\n   matrix_admin_room: \"the ID of the room created in step 2\"\n\n   auth_key_password: \"a random string used to obfuscate authentication keys\n                       stored in the user database\"\n   ```\n\n1. Pick/decide on a spare local TCP port number to run the application service\n   on. This needs to be visible to the homeserver - take care to configure\n   firewalls correctly if that is on another machine to the bridge. The port\n   number will be noted as `$PORT` in the remaining instructions.\n\n1. Generate the appservice registration file (if the application service runs\n   on the same server you can use localhost as `$URL`):\n\n   ```sh\n   $ node index.js --generate-registration -f telegram-registration.yaml  -u $URL:$PORT\n   ```\n\n1. Start the actual application service. You can use forever\n\n   ```sh\n   $ forever start index.js --config telegram-config.yaml --port $PORT\n   ```\n\n   or node\n\n   ```sh\n   $ node index.js --config telegram-config.yaml --port $PORT\n   ```\n\n1. Copy the newly-generated `telegram-registration.yaml` file to the homeserver.\n   Add the registration file to your homeserver config (default `homeserver.yaml`):\n\n   ```yaml\n   app_service_config_files:\n      - ...\n      - \"/path/to/telegram-registration.yaml\"\n   ```\n\n   Don't forget - it has to be a YAML list of strings, not just a single string.\n\n   Restart your homeserver to have it reread the config file and establish a\n   connection to the bridge.\n\n1. Invite the newly-created `@telegrambot:DOMAIN` user into the admin control\n   room created at step 1.\n\nThe bridge should now be running.\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmatrix-org%2Fmatrix-appservice-tg","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmatrix-org%2Fmatrix-appservice-tg","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmatrix-org%2Fmatrix-appservice-tg/lists"}