From c831f9a53e4a724523f576a6b601e9d2629e2992 Mon Sep 17 00:00:00 2001 From: LDA Date: Tue, 6 Aug 2024 18:58:33 +0200 Subject: [PATCH] [META/MOD] More README shenanigans. --- README.MD | 29 +++++++++++++++++++++++++++-- 1 file changed, 27 insertions(+), 2 deletions(-) diff --git a/README.MD b/README.MD index 28720b6..474d399 100644 --- a/README.MD +++ b/README.MD @@ -1,5 +1,4 @@ # Parsee - the jealous XMPP<=>Matrix bridge -
Parsee is a Matrix<=>XMPP bridge written in C99, with Cytoplasm, similar to Bifrost, but it is NOT a drop-in replacment. @@ -34,7 +33,26 @@ change a few variables (you can set `CYTO_INC` and `CYTO_LIB`) Parsee tries to avoid dependencies aside from [Cytoplasm](https://git.telodendria.io/Telodendria/Cytoplasm). ## RUNNING -TODO +First off, you may want to configure Parsee by running the `config` tool(generally named +`parsee-config` in most cases), with the correct flags, like here. +```sh +parsee-config \ + -d data/ \ + -m 'https://media.blow.hole/' \ # You will need to reverse proxy media.blow.hole to point + # to Parsee (port 7642) + -H 'blow.hole' \ # Matrix homeserver name + -J 'parsee.blow.hole' \ # XMPP component host, must be reachable + -s 'A very secure XMPP component secret' \ + -p 5347 +``` + +If everything goes well, it should generate a `parsee.json` file. + +To start Parsee, run it in the same directory as the `parsee.json`. It should start properly +and produce a `parsee.yaml` file, which you can chuck into your Matrix homeserver. To test +if the homeserver can talk to Parsee, try reaching it over HTTP at the port 7642. If it returns +with a landing page, then this side works. You can read it for some more information. + ## DOCS TODO @@ -83,3 +101,10 @@ to make Parsee easier to setup and manage. You may also donate to [the LiberaPay](https://en.liberapay.com/Parsee), alongside [Telodendria's](https://en.liberapay.com/Telodendria), as it is the project currently maintaining Cytoplasm. + +## IM chats +Please avoid asking for help/issues here. If you *really* want, you may just open +an issue and link it over it. Basic respect for others/not being an asshat is required. +(Also, these are temporary room aliases.) +- [#parsee:tedomum.net](https://matrix.to/#/%23parsee:tedomum.net) +- [parsee@conference.monocles.eu](xmpp:parsee@conference.monocles.eu?join)