https://github.com/matrix-hacks/matrix-puppet-imessage

A two-way puppeted Matrix bridge for Apple iMessage / Messages
https://github.com/matrix-hacks/matrix-puppet-imessage

bridge imessage matrix

Last synced: 3 days ago
JSON representation

A two-way puppeted Matrix bridge for Apple iMessage / Messages

• Host: GitHub
• URL: https://github.com/matrix-hacks/matrix-puppet-imessage
• Owner: matrix-hacks
• Created: 2016-12-03T12:50:53.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2020-08-25T20:01:26.000Z (about 4 years ago)
• Last Synced: 2024-08-02T15:53:30.409Z (3 months ago)
• Topics: bridge, imessage, matrix
• Language: JavaScript
• Homepage:
• Size: 368 KB
• Stars: 156
• Watchers: 13
• Forks: 22
• Open Issues: 19
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• project-awesome - matrix-hacks/matrix-puppet-imessage - A two-way puppeted Matrix bridge for Apple iMessage / Messages (JavaScript)
• awesome-matrix - matrix-appservice-imessage

README

        
# matrix-puppet-imessage [![#matrix-puppet-bridge:matrix.org](https://img.shields.io/matrix/matrix-puppet-bridge:matrix.org.svg?label=%23matrix-puppet-bridge%3Amatrix.org&logo=matrix&server_fqdn=matrix.org)](https://matrix.to/#/#matrix-puppet-bridge:matrix.org)

This is a Matrix bridge for Apple iMessage

## requirements

You need a Mac with a functional Messages.app, already authenticated.

The bridge uses applescripts for outbound messages and watches `~/Library/Containers/com.apple.iChat/Data/Library/Messages/Archive` for incoming messages, parsed with [ichat2json](https://github.com/kfatehi/ichat2json).

## installation

clone this repo

cd into the directory

run `npm install`

### special for macOS Mojave and later

Since Mojave the System Integrity Protection (SIP) prevents ichat2json from reading incoming messages.

There are two options: 

### a) Allow access for ichat2json (recommeded)

Go to "System settings" -> "Data protection" -> "Full disk access" and add `ichat2json` from `matrix-puppet-imagessage/bin/`

### b) Disable SIP (not recommended)

Boot to recovery using CMD+R, open terminal, type `csrutil disable` and reboot.

## configure

Copy `config.sample.json` to `config.json` and update it to match your setup

## register the app service

Generate an `imessage-registration.yaml` file with `node index.js -r -u "http://your-bridge-server:8090"`

Note: The 'registration' setting in the config.json needs to set to the path of this file. By default, it already is.

Copy this `imessage-registration.yaml` file to your home server, then edit it, setting its url to point to your bridge server. e.g. `url: 'http://your-bridge-server.example.org:8090'`

Edit your homeserver.yaml file and update the `app_service_config_files` with the path to the `imessage-registration.yaml` file.

Launch the bridge with ```node index.js```.

Restart your HS.

## Discussion, Help and Support

Join us in the [![Matrix Puppet Bridge](https://user-images.githubusercontent.com/13843293/52007839-4b2f6580-24c7-11e9-9a6c-14d8fc0d0737.png)](https://matrix.to/#/#matrix-puppet-bridge:matrix.org) room

# TODO

* Be able to originate conversations from the Matrix side.