spacenerdmo/pnut-matrix
1
0
Fork 0
Code Issues 5 Pull requests Projects Releases 5 Packages 1 Wiki Activity
Matrix bridge for pnut.io
119 commits 2 branches 8 tags 395 KiB
Python 97.7%
Dockerfile 1.2%
Shell 1.1%
Find a file
Morgan McMillian f04ec6fef9 README: added installation and configuration 
Started with the bare minimum instructions needed for getting the bridge
installed and running from source. Related to #34
2022-06-25 12:00:10 -07:00
.gitignore ignore personal vscode settings 2018-12-16 06:51:09 -08:00
appservice.py attempt to generate the pnut matrix user on event 2022-06-11 21:55:06 -07:00
appservice.yaml-sample README: added installation and configuration 2022-06-25 12:00:10 -07:00
CHANGELOG.md update to changelog 2021-03-20 08:14:57 -07:00
config.yaml-sample README: added installation and configuration 2022-06-25 12:00:10 -07:00
database.py pick up config file from environment variable 2020-03-24 20:47:10 -07:00
Dockerfile docker support, issue #48 2020-03-25 22:10:42 -07:00
LICENSE Initial commit 2017-03-04 15:17:07 +00:00
models.py initial private channel support 2021-03-20 13:26:33 +00:00
pnut-matrix-bot.py fix syntax error in user lookups issue #37 2019-01-08 22:03:17 -08:00
pnut-matrix.py use local timestamp when creating events 2022-06-11 21:47:27 -07:00
README.md README: added installation and configuration 2022-06-25 12:00:10 -07:00
requirements.txt Updated for the new public bridge 2022-05-26 18:47:51 -07:00

README.md

The Matrix <--> Pnut bridge

This is a pnut.io channel bridge for Matrix using the Application Services (AS) API.

This bridge will pass pnut.io channel messages through to Matrix, and Matrix messages through to pnut.io channels.

Usage

The public bridge is once again online!

See Using-the-public-bridge for details.

Installation

Currently pnut-matrix has been only tested with and confirmed to work with synapse. Please refer to the synapse installation instructions for details on how to setup your homeserver.

To install the latest version of pnut-matrix from source:

git clone https://gitlab.com/thrrgilag/pnut-matrix.git
cd pnut-matrix
python3 -m venv env
source env/bin/activate
pip3 install -r requirements.txt

Configuration

Copy config.yaml-sample to config.yaml and edit for your setup. Likewise copy appservice.yaml-sample to appservice.yaml and edit to match the tokens, prefix, and port listed in config.yaml. This is the configuration that synapse will need to reference so that it can connect the bridge. Make sure you modify your syanpse configuration accordingly.

Contributing and support

You can open issues for bugs or feature requests and you can submit merge requests to this project on GitLab. You can also submit issues and patches to the mailing list or directly to morgan@mcmillian.dev.

Join my public chat room for development discussion.

License

GPLv3, see LICENSE.