Prepare for v0.2.0 release.

This commit is contained in:
Jordan Bancino 2023-03-07 00:44:53 +00:00
parent 04bf8ca1a1
commit cfba96edee
3 changed files with 42 additions and 49 deletions

View file

@ -27,7 +27,7 @@
| | __/ | (_) | (_| | __/ | | | (_| | | | | (_| | | | __/ | (_) | (_| | __/ | | | (_| | | | | (_| |
|_|\___|_|\___/ \__,_|\___|_| |_|\__,_|_| |_|\__,_| |_|\___|_|\___/ \__,_|\___|_| |_|\__,_|_| |_|\__,_|
======================================================= =======================================================
Copyright (C) 2022 Jordan Bancino <@jordan:bancino.net> Copyright (C) 2023 Jordan Bancino <@jordan:bancino.net>
This is the source code for Telodendria, a Matrix homeserver written This is the source code for Telodendria, a Matrix homeserver written
in C. All of the documentation is available as man pages in the in C. All of the documentation is available as man pages in the
@ -42,10 +42,12 @@ repository.
Telodendria/ Telodendria/
contrib/ - Supplemental files, such as example configs. contrib/ - Supplemental files, such as example configs.
man/ - The official documentation as man pages. man/ - The official documentation as man pages.
proposals/ - Proposals for new features or fixes, as man pages.
site/ - The official website. site/ - The official website.
src/ - The C source code for Telodendria. src/ - The C source code for Telodendria.
include/ - Header files for the source code. include/ - Header files for the source code.
Routes/ - Where Matrix API endpoints are implemented Routes/ - Where Matrix API endpoints are implemented.
Static/ - Endpoints that just generate static HTML pages.
tests/ - Unit and integration tests will eventually go here. tests/ - Unit and integration tests will eventually go here.
tools/ - Development environment and tools. tools/ - Development environment and tools.

View file

@ -8,28 +8,6 @@ Key:
[~] In Progress [~] In Progress
[!] Won't Fix [!] Won't Fix
Milestone: v0.2.0
-----------------
[!] Abstract /email/requestToken and /msidsn/requestToken
- Call it RouteRequestToken
- Reference it all the places it's needed
- Finish implementing JSON parsing
[x] User Interactive Authentication
[x] Fix UiaComplete so we can use multi-stage flows
[x] User login
[x] Logout all
[x] Documentation
[x] User functions
[x] Json functions
[x] Db functions
[x] Uia (move docs from Matrix)
[x] Convert proposals to man pages
Milestone: v0.3.0 Milestone: v0.3.0
----------------- -----------------

View file

@ -1,4 +1,4 @@
.Dd $Mdocdate: January 17 2023 $ .Dd $Mdocdate: March 7 2023 $
.Dt TELODENDRIA-CHANGELOG 7 .Dt TELODENDRIA-CHANGELOG 7
.Os Telodendria Project .Os Telodendria Project
.Sh NAME .Sh NAME
@ -49,31 +49,16 @@ used to authenticate requests.
.It .It
Added the basic form of the user interactive authentication API, Added the basic form of the user interactive authentication API,
which can be used by any endpoints that the spec says require which can be used by any endpoints that the spec says require
it. Currently, it only implements a single dummy login flow, it. Currently, it only implements the dummy and password stages,
so it's more of a formality than anything else, but more login but more stages, such as the registration token stage, will be
flows can easily be added in the future. added in future releases.
.It .It
Added a simple landing page that allows those setting up Added a simple landing page that allows those setting up
.Nm .Nm
to quickly verify that it is accessible where it needs to be. to quickly verify that it is accessible where it needs to be.
.It .It
Added a way to safely delete objects from the database. Added the static login page for clients that don't support
While the database is for persistent storage, there may regular login.
be some ephemeral data that lives there only for a short
while, so it will be necessary to remove that data when
necessary.
.It
Added a thread-safe random string generator, which will
be used extensively for generating session tokens, device
IDs, access tokens, and more. This generator is seeded by
the current timestamp and the thread ID, so it should be
fairly random.
.It
Added a SHA-256 hash function, which at present is used
to hash passwords.
.It
Added a basic job scheduler to execute periodic jobs, such
as expiring tokens and cleaning up temporary files.
.El .El
.Pp .Pp
Changes: Changes:
@ -125,7 +110,7 @@ Fixed a memory leak that would occur when deleting database
objects. objects.
.It .It
Fixed a few non-fatal memory warnings that would show up Fixed a few non-fatal memory warnings that would show up
as a result of passing a constant string into certain APIs. as a result of passing a constant string into certain functions.
.El .El
.Pp .Pp
Misc: Misc:
@ -157,9 +142,37 @@ as possible to allowe debugging the configuration file parsing
if necessary. if necessary.
.El .El
.Pp .Pp
And many more small bug fixes and feature additions. Please \&... And many more bug fixes and feature additions! Too much
test the current functionality, and report bugs to the Matrix has changed to make a comprehensive change log. A lot of things
rooms. have been done under the hood to make
.Nm
easier to develop in the future. Please test the current
functionality, and report bugs to the Matrix rooms.
.Pp
The following platforms have been known to compile and run
.Nm :
.Bl -bullet
.It
OpenBSD
.It
Linux (GNU and non-GNU)
.It
Windows (via Cygwin)
.It
FreeBSD
.It
NetBSD
.It
DragonFlyBSD
.It
Haiku OS
.It
Android (via Termux)
.El
.Pp
.Nm
is about being portable; if you compile it on an obscure
operating system, do let me know about it!
.Sh v0.1.0 .Sh v0.1.0
.Pp .Pp
Tuesday, December 13, 2022 Tuesday, December 13, 2022