Document setup process better

[aaptel]

• Do I have to run this on the same machine as the matrix server?
• Does this require an xmpp server?
• Do I have to run this on the same machine as the xmpp server?

I just want to talk to xmpp contacts through my existing xmpp account which is on a free xmpp server I do not own. Is this software the best way to do that at the moment?

  backendOpts: <=== no sure what to put here
     # endpoint to reach the component on. The default port is 5347                                                                                                                                                                          
     service: "xmpp://localhost:5347"
     # domin assigned to the component.                                                                                                                                                                                                      
     domain: "matrix.localhost"
     # password needed by the component.                                                                                                                                                                                                     
     password: "jam"

portals:
  # List of regexes to match a alias that can be turned into a bridge.                                                                                                                                                                       
  aliases:
    # This matches _purple_ followed by anything                                                                                                                                                                                             
    "/^_xmpp_(.+)$/":
      # Use the prpl-jabber protocol.                                                                                                                                                                                                        
      protocol: "prpl-jabber" <===== does this need to be changed for xmpp.js?
      properties:
        # Set room to the first regex match                                                                                                                                                                                                  
        room: "regex:1"
        # Set the server to be conf.localhost                                                                                                                                                                                                
        server: "conf.localhost"

[Ghabry]

I couldn't figure out how to use xmpp.js. I was only succesful with libpurple.

backendOpts is only needed for xmpp.js and you need your own server that supports component registration. You must create a new component.

When you want to use a different server use prpl-jabber. You can add an account by talking to the chatbot. I experienced problems when more than one account was added (messages sent through wrong account) and I don't know if this is fixed by now.

[aaptel]

I'm still confused what needs to be run and where :(

I have a free XMPP account from a server I'm not admin (cannot edit the configuration of that XMPP server). Can this software be used in this situation or not?

[Ghabry]

with prpl-jabber: yes

You create an account with a pidgin on your computer. Copy the accounts.xml from pidgin over to $SYNAPSE_USER/.purple/accounts.xml Then start bifrost-purple and message the bridge bot as explained in the README:

accounts add-existing prpl-jabber $USERNAME@$XMPP_SERVER accounts enable prpl-jabber $USERNAME@$XMPP_SERVER

Though you can't write people, they have to write you first, otherwise you won't get a room-handle to answer on.

[mcrosson]

If using prosody you'll likely need to follow the info at this page for setting up a 'custom component'.

Looks like this is a key piece of the docs when setting up xmpp.js as a back end.

https://prosody.im/doc/components