{"id":13556407,"url":"https://github.com/aidalgol/synapse-appservice-docker","last_synced_at":"2025-04-03T09:31:19.446Z","repository":{"id":69107535,"uuid":"117531643","full_name":"aidalgol/synapse-appservice-docker","owner":"aidalgol","description":"Docker Compose setup for development of Synapse and Matrix appservices.","archived":true,"fork":false,"pushed_at":"2018-02-06T05:37:12.000Z","size":17,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-30T22:55:11.811Z","etag":null,"topics":["appservice","docker","docker-compose","matrix","synapse"],"latest_commit_sha":null,"homepage":null,"language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/aidalgol.png","metadata":{"files":{"readme":"README.rst","changelog":null,"contributing":null,"funding":null,"license":null,"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":"2018-01-15T10:32:10.000Z","updated_at":"2023-01-28T05:24:27.000Z","dependencies_parsed_at":"2023-09-15T00:15:32.058Z","dependency_job_id":null,"html_url":"https://github.com/aidalgol/synapse-appservice-docker","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/aidalgol%2Fsynapse-appservice-docker","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aidalgol%2Fsynapse-appservice-docker/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aidalgol%2Fsynapse-appservice-docker/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aidalgol%2Fsynapse-appservice-docker/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/aidalgol","download_url":"https://codeload.github.com/aidalgol/synapse-appservice-docker/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246976247,"owners_count":20863047,"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":["appservice","docker","docker-compose","matrix","synapse"],"created_at":"2024-08-01T12:03:49.073Z","updated_at":"2025-04-03T09:31:17.922Z","avatar_url":"https://github.com/aidalgol.png","language":null,"funding_links":[],"categories":["Others","docker"],"sub_categories":[],"readme":"==================================\nSynapse + appservices Docker setup\n==================================\n\nThis is a Docker Compose setup for development of Synapse and Matrix appservices.\n\nGetting Started\n===============\nCheckout Synapse_ and the `IRC bridge appservice`_::\n\n  $ git clone https://github.com/matrix-org/synapse.git synapse/synapse\n  $ git clone https://github.com/matrix-org/matrix-appservice-irc.git irc-bridge/matrix-appservice-irc\n\nBuild the Docker images::\n\n  $ docker-compose build\n\nGenerate keys::\n  $ openssl genpkey -out irc-bridge/varlib/passkey.pem -outform PEM -algorithm RSA -pkeyopt rsa_keygen_bits:2048\n  $ docker-compose run synapse python -m synapse.app.homeserver \\\n    -c /etc/matrix-synapse/homeserver.yaml \\\n    --generate-config \\\n    --report-stats=no \\\n    --server-name synapse\n\nGenerate the appservice registration file for the IRC bridge [1]_::\n\n  $ docker-compose run appservice-irc ./bin/matrix-appservice-irc \\\n    --generate-registration \\\n    --url http://appservice-irc:9009 \\\n    --localpart appservice-irc \\\n    --config /etc/matrix-appservice-irc/config.yaml \\\n    --file /etc/synapse-appservice-registrations/irc.yaml\n\nRegister a Matrix user::\n\n  $ docker up synapse # Run in a separate terminal\n  $ docker-compose run synapse \\\n    register_new_matrix_user \\\n    -c /etc/matrix-synapse/homeserver.yaml \\\n    http://synapse:8008\n\nFollow the prompts and then interrupt (`Ctrl+C`) the `docker up` process.\n\nStart the Docker Compose services (you may want to do this in a separate terminal)::\n\n  $ docker-compose up\n\nNow point your client at `https://localhost:8008`.\n\n.. _Synapse: https://github.com/matrix-org/synapse\n.. _`IRC bridge appservice`: https://github.com/matrix-org/matrix-appservice-irc\n.. [1] The appservice registration file is generated from the appservice configuration file, which is why this is not kept under version control.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faidalgol%2Fsynapse-appservice-docker","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Faidalgol%2Fsynapse-appservice-docker","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faidalgol%2Fsynapse-appservice-docker/lists"}