Code Monkey home page Code Monkey logo

synapse-appservice-docker's Introduction

Synapse + appservices Docker setup

This is a Docker Compose setup for development of Synapse and Matrix appservices.

Getting Started

Checkout Synapse and the IRC bridge appservice:

$ git clone https://github.com/matrix-org/synapse.git synapse/synapse
$ git clone https://github.com/matrix-org/matrix-appservice-irc.git irc-bridge/matrix-appservice-irc

Build the Docker images:

$ docker-compose build
Generate keys::

$ openssl genpkey -out irc-bridge/varlib/passkey.pem -outform PEM -algorithm RSA -pkeyopt rsa_keygen_bits:2048 $ docker-compose run synapse python -m synapse.app.homeserver

-c /etc/matrix-synapse/homeserver.yaml --generate-config --report-stats=no --server-name synapse

Generate the appservice registration file for the IRC bridge [1]:

$ docker-compose run appservice-irc ./bin/matrix-appservice-irc \
  --generate-registration \
  --url http://appservice-irc:9009 \
  --localpart appservice-irc \
  --config /etc/matrix-appservice-irc/config.yaml \
  --file /etc/synapse-appservice-registrations/irc.yaml

Register a Matrix user:

$ docker up synapse # Run in a separate terminal
$ docker-compose run synapse \
  register_new_matrix_user \
  -c /etc/matrix-synapse/homeserver.yaml \
  http://synapse:8008

Follow the prompts and then interrupt (Ctrl+C) the docker up process.

Start the Docker Compose services (you may want to do this in a separate terminal):

$ docker-compose up

Now point your client at https://localhost:8008.

[1]The appservice registration file is generated from the appservice configuration file, which is why this is not kept under version control.

synapse-appservice-docker's People

Contributors

aidalgol avatar

Stargazers

 avatar

Watchers

 avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.