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

Update docs

Browse source
This commit is contained in:
Jordan Bancino 2022-09-29 18:16:16 -04:00
parent 45324ce77a
commit bf5009293d
2 changed files with 14 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
TODO.txt
View file

@ -73,6 +73,7 @@ Phase 3: Welcome to Matrix
Phase 4: Phase 4:
[ ] Create an OpenBSD package and get it submitted to ports [ ] Create an OpenBSD package and get it submitted to ports
[ ] Add relayd examples to contrib/
[ ] Create a command line tool to manage Telodendria [ ] Create a command line tool to manage Telodendria
[ ] Configuration file generation [ ] Configuration file generation
[ ] User management [ ] User management
@ -100,3 +101,9 @@ Documentation
[x] Clean up dark mode in man page CSS (links) [x] Clean up dark mode in man page CSS (links)
[x] Synopsis table should not be styled [x] Synopsis table should not be styled
[ ] Internal API docs [ ] Internal API docs
[ ] Add onboarding documentation
[ ] Building from source
[ ] Writing config file
[ ] Setting up chroot
[ ] Setting up relayd

14
docs/telodendria.7
View file

@ -1,4 +1,4 @@
.Dd $Mdocdate: September 27 2022 $ .Dd $Mdocdate: September 29 2022 $
.Dt TELODENDRIA 7 .Dt TELODENDRIA 7
.Os Telodendria Project .Os Telodendria Project
.Sh NAME .Sh NAME
@ -98,13 +98,13 @@ To implement the latest Matrix specification as fully and completely as possible
All features defined by the specification should eventually be present in All features defined by the specification should eventually be present in
.Nm . .Nm .
.It .It
To be a production-ready Matrix server capable of handling a lot of users. To be a production-ready Matrix server capable of working in constrained environments,
such as embedded devices, cheap VPSs, or a peer-to-peer device.
.Nm
should also work on traditional setups as well, and be able to handle a decent
amount of users. It should work well for personal Matrix homeservers that also
host a few friends and/or family members.
.Nm .Nm
should have good performance in many diverse environments. It should scale up
well for large instances, such as the
.Pa matrix.org
instance, and yet also be able to scale down to an embedded or peer-to-peer
device.
.It .It
To be easier to get up and running, and yet also be more configurable than other To be easier to get up and running, and yet also be more configurable than other
Matrix homeserver implementations. The configuration file should be flexible, Matrix homeserver implementations. The configuration file should be flexible,