Skip to content

Commit fd412f4

Browse files
authoredJan 28, 2026
Revise README for clarity on project status and purpose
Updated README to clarify the status and purpose of the Matrix homeserver implementation. Added information about assistance received and encouraged community contributions.
1 parent 2d3969d commit fd412f4

File tree

1 file changed

+7
-5
lines changed

1 file changed

+7
-5
lines changed
 

‎README.md‎

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,9 @@
22

33
[![Deploy to Cloudflare Workers](https://deploy.workers.cloudflare.com/button)](https://deploy.workers.cloudflare.com/?url=https://github.com/nkuntz1934/matrix-workers)
44

5-
A production-grade Matrix homeserver implementation running entirely on Cloudflare's edge infrastructure. Implements Matrix Client-Server API v1.12 and Server-Server (Federation) API.
5+
This is a proof of concept Matrix homeserver implementation running entirely on Cloudflare's edge infrastructure. This was built to prove E2EE utilizing Matrix protocols over Element X on the Cloudflare Workers Platform. It is meant to serve as an example prototype and not endorsed as ready for production at this point.
6+
7+
I was assisted by Claude Code Opus 4.5 for this implementation to speed up showing that you could message over Cloudflare Workers utilizing the Element Web and Element X App. Feel free to submit issues, fork the project to make it your own, or continue to build on this example!
68

79
## Table of Contents
810

@@ -23,7 +25,7 @@ A production-grade Matrix homeserver implementation running entirely on Cloudfla
2325

2426
```
2527
┌─────────────────────────────────────────────────────────────────────────────┐
26-
│ Cloudflare Edge Network
28+
│ Cloudflare Edge Network │
2729
├─────────────────────────────────────────────────────────────────────────────┤
2830
│ ┌─────────────┐ ┌─────────────┐ ┌─────────────┐ ┌─────────────────────┐ │
2931
│ │ Workers │ │ Durable │ │ D1 │ │ R2 │ │
@@ -37,16 +39,16 @@ A production-grade Matrix homeserver implementation running entirely on Cloudfla
3739
│ │ └─────────────┘ └─────────────┘ │ │
3840
│ │ │ │ │ │
3941
│ ┌──────┴────────────────┴────────────────┴───────────────────┴───────────┐ │
40-
│ │ KV Namespaces │ │
41-
│ │ SESSIONS: Access tokens, refresh tokens │ │
42+
│ │ KV Namespaces │ │
43+
│ │ SESSIONS: Access tokens, refresh tokens │ │
4244
│ │ DEVICE_KEYS: E2EE device keys, cross-signing keys │ │
4345
│ │ CACHE: Room metadata, federation server keys │ │
4446
│ │ ONE_TIME_KEYS: Olm one-time keys for E2EE │ │
4547
│ │ CROSS_SIGNING_KEYS: Master, self-signing, user-signing keys │ │
4648
│ └────────────────────────────────────────────────────────────────────────┘ │
4749
│ │
4850
│ ┌────────────────────────────────────────────────────────────────────────┐ │
49-
│ │ Workflows (Durable Execution) │ │
51+
│ │ Workflows (Durable Execution) │ │
5052
│ │ RoomJoinWorkflow: Federation handshake with retries │ │
5153
│ │ PushNotificationWorkflow: Batched push delivery │ │
5254
│ └────────────────────────────────────────────────────────────────────────┘ │

3 commit comments

Comments
 (3)

SoNick commented on Jan 28, 2026

@SoNick

Your commit description is a far cry from the changes you are making with this commit.

ResultsMayVary commented on Jan 28, 2026

@ResultsMayVary

Heavy emphasis on "assisted". Spoken like a true manager.

nnnn20430 commented on Jan 28, 2026

@nnnn20430

"I was assisted by Claude Code Opus 4.5 for this implementation"
The implementation wasn't the only thing "assisted" by AI, so was your blog post.

Please sign in to comment.