View the history of public and world readable Matrix rooms

Go to file

Eric Eastwood 2b4ecb737a Add support for client-side room alias hash `#` redirects to the correct URL (#111 ) This helps when someone just pastes a room alias on the end of the domain, - `/#room-alias:server` -> `/r/room-alias:server` - `/r/#room-alias:server/date/2022/10/27` -> `/r/room-alias:server/date/2022/10/27` Since these redirects happen on the client, we can't write any e2e tests. Those e2e tests do everything but run client-side JavaScript. Follow-up to https://github.com/matrix-org/matrix-public-archive/pull/107 Part of https://github.com/matrix-org/matrix-public-archive/issues/25		2022-10-28 00:32:24 -05:00
.github/workflows	Add linting to CI (#74 )	2022-09-27 22:21:00 -05:00
build	Add support for client-side room alias hash `#` redirects to the correct URL (#111 )	2022-10-28 00:32:24 -05:00
config	Room directory landing page v1 (#61 )	2022-09-08 01:30:04 -05:00
public	Add support for client-side room alias hash `#` redirects to the correct URL (#111 )	2022-10-28 00:32:24 -05:00
server	Add support for client-side room alias hash `#` redirects to the correct URL (#111 )	2022-10-28 00:32:24 -05:00
shared	Add support for client-side room alias hash `#` redirects to the correct URL (#111 )	2022-10-28 00:32:24 -05:00
test	Add support for room aliases (#107 )	2022-10-27 01:09:13 -05:00
.eslintignore	Fix lints	2022-02-15 21:33:31 -06:00
.eslintrc.json	Room directory landing page v1 (#61 )	2022-09-08 01:30:04 -05:00
.gitignore	E2E test but still failing because fetching from start of day before test events happened	2022-02-23 21:25:05 -06:00
.prettierignore	Add linting to CI (#74 )	2022-09-27 22:21:00 -05:00
.prettierrc.json	SSR with linkedom	2022-02-03 23:44:50 -06:00
Dockerfile	Room directory landing page v1 (#61 )	2022-09-08 01:30:04 -05:00
LICENSE.md	Add Apache 2.0 license (#55 )	2022-08-30 18:35:36 -05:00
README.md	Add app screenshot (#42 )	2022-07-18 13:29:47 -05:00
docker-health-check.js	Make sure container is able to start up (#23 )	2022-06-15 17:12:44 -05:00
package-lock.json	Add support for room aliases (#107 )	2022-10-27 01:09:13 -05:00
package.json	Page-load with the correct homeserver selected (#98 )	2022-10-21 02:09:26 -05:00

README.md

Matrix public archive

NB: This project is very much a work-in-progress (WIP)! Undocumented config/secrets, using a draft branch of Hydrogen, etc.

In the vein of feature parity with Gitter, the goal is to make a public archive site for world_readable Matrix rooms like Gitter's archives which search engines can index and keep all of the content accessible/available. There is already https://view.matrix.org/ (https://github.com/matrix-org/matrix-static) but there is some desire to make something with more Element-feeling polish and loading faster (avoid the slow 502's errors that are frequent on view.matrix.org).

Plan summary

The plan is to server-side render (SSR) the Hydrogen Matrix client on a Node.js server (since both use JavaScript) and serve pages on the fly (probably with some Cloudflare caching on top) when someone requests /archives/${year}/${month}/${day}. To fetch the events for a given day/time, we will use MSC3030's /timestamp_to_event endpoint to jump to a given day in the timeline and fetch the messages from a Matrix homeserver.

Re-using Hydrogen gets us pretty and native(to Element) looking styles and keeps the maintenance burden of supporting more event types in Hydrogen.

Setup

Prerequisites

Node.js v16
- We only need v16 because it includes require('crypto').webcrypto.subtle for Matrix encryption (olm) which can't be disabled in Hydrogen yet.

Get the app running

$ npm install

# Edit config/config.user-overrides.json so that `matrixServerUrl` points to your homeserver
# and has `matrixAccessToken` defined
$ cp config/config.default.json config/config.user-overrides.json

$ npm run start-dev

Development

# We need to use a draft branch of Hydrogen to get the custom changes needed for
# `matrix-public-archive` to run. Hopefully soon, we can get all of the custom
# changes mainlined so this isn't necessary.
$ git clone git@github.com:vector-im/hydrogen-web.git
$ cd hydrogen-web
$ git checkout madlittlemods/matrix-public-archive-scratch-changes
$ yarn install
$ yarn build:sdk
$ cd target/ && npm link && cd ..
$ cd ..

# Now clone and install the `matrix-public-archive` project
$ git clone git@github.com:matrix-org/matrix-public-archive.git
$ cd matrix-public-archive
$ npm install
$ npm link hydrogen-view-sdk
# If you just want to run the tests, you can skip to the "Running tests" section at this point
#
# Edit config/config.user-overrides.json so that `matrixServerUrl` points to your homeserver
# and has `matrixAccessToken` defined
$ cp config/config.default.json config/config.user-overrides.json

# Now we can finally start the app
$ npm run start-dev

Running tests

See the testing readme.