mirror of
https://git.kappach.at/lda/Parsee.git
synced 2025-04-20 22:27:05 +02:00
70 lines
1.9 KiB
Groff
70 lines
1.9 KiB
Groff
." The last field is the codename, by the way.
|
|
." ALL MANPAGES FOR PARSEE ARE UNDER PUBLIC DOMAIN
|
|
.TH parsee-bridge-guidebook 7 "Parsee Utility" "star-of-hope"
|
|
|
|
.SH NAME
|
|
parsee-bridge-guidebook - A short guidebook on running a Parsee bridge
|
|
|
|
.SH INTRODUCTION
|
|
.P
|
|
This manpage is intended to be a guidebook for Parsee administrators. It
|
|
is meant to show how to create an instance with an XMPP-Matrix server
|
|
(though it cannot be specific, due to their ecosystem diversity), how to
|
|
plumb rooms, and moderate them through.
|
|
.P
|
|
It also assumes Parsee is properly built and installed, in which case you
|
|
are seeing this from
|
|
.I man
|
|
itself.
|
|
|
|
.SH CONVENTIONS
|
|
This page shall assume a few things that
|
|
.B must
|
|
be changed to fit your configuration. Please read those carefully, or it
|
|
will come and bite at you!
|
|
|
|
.P
|
|
First off, it assumes that you have a domain at
|
|
.I blow.hole
|
|
and that any other domains related to Parsee are it's subdomains, as
|
|
you'll see.
|
|
|
|
.P
|
|
We also assume you're planning on making the XMPP component available at
|
|
.I j.blow.hole ,
|
|
and that Parsee can reach it by using
|
|
.I localhost:1234 .
|
|
It is highly recommended that Parsee can reach the component locally, as
|
|
the stream cannot be encrypted!
|
|
|
|
.P
|
|
The Parsee HTTP server (which is used for media and the appservice) shall
|
|
be reached through
|
|
.I https://p.blow.hole/
|
|
via a reverse proxy. This manual shall only show you what port to make
|
|
available, as there are many reverse proxy options available.
|
|
|
|
.P
|
|
Finally, the Matrix server will be publicly known as
|
|
.I m.blow.hole
|
|
.
|
|
|
|
That is, if
|
|
.B bob
|
|
is in it, then they shall be known as
|
|
.I @bob:m.blow.hole .
|
|
|
|
.SH SETTING UP
|
|
Setting up Parsee mainly involves creating a valid configuration file
|
|
and the database. Most of this however is dealt with by
|
|
.I parsee-config(1)
|
|
TODO
|
|
|
|
.P
|
|
|
|
.SH LICENSE
|
|
This document is under public domain, or CC0 if not allowed by local law.
|
|
|
|
.SH SEE ALSO
|
|
.B parsee(1), parsee-cmd-syntax(7)
|
|
|