plate/telodendria
1
0
Fork 0
forked from lda/telodendria
Code Pull requests Activity Actions

Update documentation

Browse source
This commit is contained in:
Jordan Bancino 2022-11-08 17:56:11 +00:00
parent 8e71cc833c
commit c7a358150c
2 changed files with 8 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
TODO.txt
View file

@ -16,7 +16,7 @@ Due: January 1, 2023
[ ] Database upgrades/migration path [ ] Database upgrades/migration path
[ ] Caching and cache control [ ] Caching and cache control
[x] Make memory info access O(1) [x] Make memory info access O(1)
[ ] Make config option 'id' optional; print warning if not present started as root. [x] Make config option 'id' optional; print warning if not present started as root.
[x] Write install and uninstall scripts [x] Write install and uninstall scripts
[x] Add relayd example to contrib/ [x] Add relayd example to contrib/
[x] Refactor man pages to be prefaced with 'telodendria-' [x] Refactor man pages to be prefaced with 'telodendria-'
@ -49,7 +49,6 @@ Due: July 1, 2023
[ ] Json [ ] Json
[ ] Log [ ] Log
[ ] Matrix [ ] Matrix
[ ] NonPosix
[x] Queue [x] Queue
[ ] Routes [ ] Routes
[ ] TelodendriaConfig [ ] TelodendriaConfig

15
man/man5/telodendria.conf.5
View file

@ -1,4 +1,4 @@
.Dd $Mdocdate: October 24 2022 $ .Dd $Mdocdate: November 8 2022 $
.Dt TELODENDRIA.CONF 5 .Dt TELODENDRIA.CONF 5
.Os Telodendria Project .Os Telodendria Project
.Sh NAME .Sh NAME
@ -80,13 +80,12 @@ This directive is optional. If it is not specified, it is automatically
set to be the same as the base URL. set to be the same as the base URL.
.It Ic id Ar uid Ar gid .It Ic id Ar uid Ar gid
The effective UNIX user and group to drop to after binding to the socket The effective UNIX user and group to drop to after binding to the socket
and changing the filesystem root. This only works if Telodendria is and changing the filesystem root for the process. This only works if
running as the root user, and is used as a security mechanism. If Telodendria Telodendria is running as the root user, and is used as a security mechanism.
is started as a non-priviledged user, then a warning is printed to the log If this option is set and Telodendria is started as a non-priviledged user,
if that user does not match what's specified here. This directive is then a warning is printed to the log if that user does not match what's
required, even if Telodendria is unable to switch to the given user and specified here. This directive is optional, but should be used as a sanity
group. It should be used as a sanity check to make sure the permissions are check, if nothing more, to make sure the permissions are working properly.
working properly.
.It Ic data-dir Ar directory .It Ic data-dir Ar directory
The data directory into which Telodendria will write all user and event The data directory into which Telodendria will write all user and event
information. Telodendria doesn't use a database like other Matrix homeserver information. Telodendria doesn't use a database like other Matrix homeserver