103 lines
2.6 KiB
Groff
103 lines
2.6 KiB
Groff
." The last field is the codename, by the way.
|
|
." ALL MANPAGES FOR PARSEE ARE UNDER PUBLIC DOMAIN
|
|
.TH parsee-config 1 "Parsee Utility" "lunar-rainbow"
|
|
|
|
.SH NAME
|
|
parsee-config - generate a basic configuration file
|
|
|
|
.SH SYNOPSIS
|
|
parsee-config
|
|
.B [-H HOMESERVER_NAME]
|
|
.B [-s SHARED_SECRET]
|
|
.B [-m MEDIA_URL]
|
|
.B [-J JABBER_HOST]
|
|
.B [-j JABBER_ADDR]
|
|
.B [-p JABBER_PORT]
|
|
.B [-d DATABASE]
|
|
.B [-M MAX_STANZA]
|
|
.B [-S DATABASE size]
|
|
|
|
.SH DESCRIPTION
|
|
.I parsee-config
|
|
creates a basic configuration file to initialise a Parsee instance with the
|
|
given input flags, and makes a basic database. A basic example of
|
|
.I parsee-config
|
|
would be this(for a blow.hole server, with a xmpp.blow.hole JCP on Prosody,
|
|
and a 128MB LMDB backend)
|
|
.sp
|
|
.if n \{\
|
|
.RS 4
|
|
.\}
|
|
.nf
|
|
$ parsee-config \\
|
|
-d '/var/lib/parsee' \\
|
|
-m 'https://pmedia.blow.hole' \\
|
|
-H 'blow.hole' \\
|
|
-s 'The Dark Shared Secret' \\
|
|
-J 'xmpp.blow.hole' \\
|
|
-j 'localhost' \\
|
|
-S 128
|
|
.fi
|
|
.if n \{\
|
|
.RE
|
|
.\}
|
|
.sp
|
|
|
|
.SH OPTIONS
|
|
.TP
|
|
.BR -H HOMESERVER_NAME
|
|
.I HOMESERVER_NAME
|
|
points to the homeserver name, without delegation (which is autosensed).
|
|
For example, if you except Parsee users to be on
|
|
.IR @something:blow.hole
|
|
, then it should be set to
|
|
.IR blow.hole .
|
|
.TP
|
|
.BR -s SHARED_SECRET
|
|
.I SHARED_SECRET
|
|
is a shared secret known by Parsee and the XMPP component to authenticate.
|
|
.TP
|
|
.BR -M MAX_STANZA
|
|
.I MAX_STANZA
|
|
is the maximum stanza size accepted by the XMPP host. If it is less than 10000 bytes, then it shall be set to that limit(the standardised value).
|
|
.TP
|
|
.BR -m MEDIA_URL
|
|
.I MEDIA_URL
|
|
is an optional field used by Parsee as an address that points to Matrix
|
|
media. It must be publicly accessible (behind a reverse proxy to HTTP:7642)
|
|
.TP
|
|
.BR -J JABBER_HOST
|
|
.I JABBER_HOST
|
|
is used as the component host for Parsee.
|
|
.TP
|
|
.BR -j JABBER_ADDR
|
|
.I JABBER_ADDR
|
|
can optionally be used to change the hostname Parsee will try to contact
|
|
for XMPP. Users should ideally use localhost (or a hostname pointing to
|
|
the server itself), as XMPP component streams are not encrypted.
|
|
.TP
|
|
.BR -p JABBER_PORT
|
|
.I JABBER_PORT
|
|
is used as the component post for Parsee. Parsee uses it alongside
|
|
.I JABBER_HOST
|
|
to connect to
|
|
.I JABBER_HOST:JABBER_PORT
|
|
over TCP.
|
|
.TP
|
|
.BR -d DATABASE
|
|
The directory inwhich Parsee stores its database(LMDB/flat-file). Whenever the
|
|
database is flat or LMDB is dictated by the presence of the -S flag, and
|
|
whenever Cytoplasm has LMDB enabled.
|
|
.TP
|
|
.BR -S SIZE
|
|
If set, enables LMDB in Parsee, and sets its max DB size to
|
|
.BR SIZE MiB .
|
|
|
|
|
|
.SH LICENSE
|
|
Unlike Parsee,
|
|
.B parsee-config
|
|
is under the CC0/PD.
|
|
|
|
.SH SEE ALSO
|
|
.B parsee-aya(1), parsee-adminify(1), parsee(1)
|