Login, read receipts, and typing notification docs for iMessage on nosip #16
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
shreyasajj
suggested changes
Jan 18, 2022
| @@ -78,6 +78,9 @@ You can also refer to Apple's [official documentation on disabling SIP](https:// | |||
| 3. In the `imessage` section of the config, change `platform` to `mac-nosip` | |||
| and set `imessage_rest_path` to the path to the `darwin-barcelona-mautrix` | |||
| executable you downloaded or compiled. | |||
| 4. Run the bridge with `./mautrix-imessage`. | |||
| 4. If you want messages sent directly from iMessage to be replicated on Matrix (have the puppet work), you'll need to set up the [shared secret] plugin for Synapse (there may exist other ways to do this using `login-matrix` but the iMessage bridge doesn't seem to support this at the moment). Once you generate a shared secret, use the same secret in the `login_shared_secret` section in the `bridge` section of `config.yaml`. It's worth noting the `m_login_password_setup_enabled` should be `true` when setting up the shared secret plugin. | |||
There was a problem hiding this comment.
This is probably better to put in the normal imessage(with sip)
|
This doesn't really belong in iMessage docs at all, double puppeting is already documented in https://docs.mau.fi/bridges/general/double-puppeting.html |
|
@tulir I wasn't aware that the double puppeting page exists (I see it has a lot more detail and is informative to me, actually). As someone who came to the documentation knowing nothing about bridges/puppeting, mayhaps it would be helpful to link the double-puppeting page on the |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
When I was setting up the Mautrix iMessage bridge for nosip I encountered some difficulties getting typing indicators and puppeting to work due to a lack of documentation. Anyway, I wanted to document these things since hopefully it would make them easier for future users setting up this bridge.
My PR just adds a couple of points on how to enable read receipts and that you need the custom puppet enabled if you want typing indicators to work. It also has documentation about how to log in for puppeting, but I'm not sure if the
login-matrixstuff is right.I'm not too sure about the contribution guidelines to this repo/the validity of what I added, so feel free to reject this or comment on any changes that need to be made.
Thanks!