matrix-org/matrix-static

A static golang generated preview of public world readable Matrix rooms.

Matrix Static

No longer maintained

In favour of https://github.com/matrix-org/matrix-public-archive

Installation

git clone or download this repository as an archive and extract then follow below instructions.

go get github.com/valyala/quicktemplate/qtc
qtc
mkdir bin && go build -o bin/ ./cmd/...

Docker

docker build -t matrix-static .
docker run -v $(pwd)/config.json:/opt/matrix-static/config.json -p 8000:8000 -it matrix-static

or for windows:

docker run -v %cd%/config.json:/opt/matrix-static/config.json -p 8000:8000 -it matrix-static

and pass any command line arguments to the end of the command.

Usage

First you must create a config, there is a sample json file provided or you can use the helper binary register-guest to register a guest on a given homeserver and write an appropriate config file.

register-guest takes the following options:

--config-file= to specify the config file, defaulting to ./config.json.

--homeserver-url= to specify the Homeserver URL to use, defaulting to https://matrix.org.

The main binary, matrix-static exhibits the following controls:

Accepts PORT= env variable to determine what port to use, defaulting to port 8000 if one is not specified. Will panic if port is in use.

Accepts the following command line arguments:

--config-file= to specify the config file, defaulting to ./config.json.

--enable-pprof if set, enables the /debug/pprof endpoints for debugging.

--enable-prometheus-metrics if set, enables the /metrics endpoint for metrics.

--num-workers= to specify the number of worker goroutines to start, defaults to 32.

--public-serve-prefix= to specify the router prefix to use for the user-facing html-serving routes, defaults to /.

--logger-directory to specify where the output logs should go.

--cache-ttl to specify how long since last access to keep a room in memory and up to date for, defaults to 30 minutes.

--cache-min-rooms to specify the minimum number of rooms to always keep in memory, defaults to 10.

Support

Currently hosted at https://view.matrix.org

Discussion Matrix Room is #matrix-static:matrix.org

matrix-static's Issues

Display separate Matrix message in page via message id

At now Matrix Static can display rooms with messages, but there are no way to display only one specific message. Will be good to have ability for display only one message in webpage by message id.

Incorporate UI from globau/logbot

Long way off but I'd love to see the UI of logbot (IRC log viewer) incorporated into matrix-static

You can see it running here: https://mozilla.logbot.info/firefox/20181114

Add support for pinned messages

workaround federation inpeekability

I feel like the horrific hack to work around the federation peeking issue is to have static try and register a guest account on whatever HS it's trying to look at (probably (and horrifically) based on room id) - Cadair

Display events of type `im.vector.modular.widgets`

Matrix-static should match the events displayed by Riot probably. Splitting out from #41

check health of servers on server page

to allow estimating how many servers are dead

Room name first in the title

Nit: with the name last, and more than one room open, there's no at-a-glance distinction between rooms:

Consider naming the room first.

For example, instead of the current arrangement:

Matrix Static - Public Room Timeline - Manjaro

– this:

Manjaro – public timeline – Matrix Static

Markup feeds with microformats2

Marking up each room as a microformats2 h-feed of h-entry messages would provide a simple way of beginning to bridge matrix to the indieweb people.

Todo List

• Historical Member Info
• make Peeking more useful (pagination etc)
• investigate additional meta useful for spidering
• make cache invalidate after N requests or M minutes
• sort memberlist
• paginate memberlist
• linkify-js style thing
• handle redactions
• sanitize unbalanced closing tags
• don't backpaginate if has reached m.room.create / smart about m.room.history_visibility

Renderers for common events:

• m.text
• m.emote
• m.notice
• html formatted m.text/m.emote/m.notice
• m.image
• m.file
• m.location
• m.video
• m.audio

Renderers for room state changes:

• m.room.member
• m.room.name
• m.room.topic
• m.room.avatar
• m.room.third_party_invite
• m.room.power_levels
• m.room.history_visibility -ish?
• m.room.join_rules

searchable room directory

probably locally rather than via the filtered part of the API

Support ?via= on room/event permalinks

proposal: matrix-org/matrix-spec-proposals#1704

investigate weirdness

missing events around https://matrix.to/#/!cURbafjkfsMDVwdRDQ:matrix.org/$1505156376191nQoHj:hackerspace.be - https://view.matrix.org/room/!cURbafjkfsMDVwdRDQ:matrix.org/?anchor=$1505157767553rZqNm:riot.ovh&offset=20

Make it obvious how to join a room

I only found out about /aliases by accident, and was otherwise left quite confused trying to join a room I found on view.matrix.org. A fat button in the top right taking me to matrix.to might make sense. Thanks for your consideration.

Instructions for non-docker install don't work on linux

qtc: command not found. No vendor directory.

matrix-static does not start if initial request to client/r0/publicRooms times out

When starting, matrix-static can panic mid-startup when it's doing it's initial sync of publicRooms:

panic: Get <<REDACTED - client/r0/publicRooms url with access token>>: net/http: request canceled (Client.Timeout exceeded while awaiting headers)

goroutine 1 [running]:
github.com/t3chguy/matrix-static/mxclient.(*Client).NewWorldReadableRooms(0xc4202d90a0, 0xd)
        /home/matrixstatic/matrix-static/src/github.com/t3chguy/matrix-static/mxclient/public-rooms.go:53 +0x8d
main.main()
        /home/matrixstatic/matrix-static/src/github.com/t3chguy/matrix-static/matrix-static.go:93 +0x368
error: Forever detected script exited with code: 2

This isn't particularly fatal, we can just restart matrix-static until it completes, but adding a longer timeout may be useful here.

Do we set URLs, Etags & caching headers to ensure search engines don't respider the same content?

Right now google is hammering matrix.org by indexing view.matrix.org. Do we ensure that the historical pages have nice unique URLs, Etags and have a suitably massive caching header to ensure that Google doesn't go and try to reindex the whole thing again a few days later?

allow user to specify timezone

Don't require a trailing slash on request routes

it shouldn't care if there is or isn't a slash there

in /aliases, denote canonical alias visually

/alias/:roomAlias endpoint to redirect to relevant room if public, else show pretty not a public guest peekable room

like members,servers, a page listing aliases would be neato

how can I host this on a subpath?

I'd like to run this on a /view/ folder, is that possible?

Handle room upgrades

It would be nice if it could handle room upgrades in a similar way to Riot's interface. An example of an upgraded room is https://view.matrix.org/room/!FyQrGcOoVamcLcvdob:matrix.org/ to https://view.matrix.org/room/!yjVgJUsMLYLAONsoii:jki.re/

Provide stylesheet file

Hi, @t3chguy!

I've read about your work at Matrix.org status update

After visiting your Heroku app I would like to ask you, whether you could add a CSS file instead of styling inline? This way, web designers could use Stylish/edit the stylesheet using browser developer tools and send a PR with an updated stylesheet without needing to know, how to build a local version of the website.

Do you have any mockups on how you would like to see the app look like?

Test Issue

https://matrix.to/#/#matrix:matrix.org is cool

Display link for files

Zip, Image, Audio, Video files are shown as m.file.Event, instead there should be a link to download that file.

linked messages should be centered rather than at the bottom

When linking to this message:
https://view.matrix.org/room/!ChuQQIVJvwyJujhNIG:synapse.keyvan.pw/?anchor=$152456240720927yUzQv:matrix.org&highlight

The event gets placed at the bottom of the scrollback. I think it would be preferred to center the linked event right in the middle of the page. Is that doable? Thanks.

Add ability to whitelist the rooms matrix-static can show per-instance

Sanity check API parameters

We don't validate that page is >= 0, so we can panic when we attempt to access negative indices in an array.

panic: runtime error: slice bounds out of range

goroutine 61 [running]:
main.RoomMembersJob.Work(0xc4203ae0fe, 0x1e, 0xfffffffffffffffe, 0x14, 0xc420de00c0)
/home/matrixstatic/matrix-static/src/github.com/t3chguy/matrix-static/job-room-members.go:41 +0x687
main.(*RoomMembersJob).Work(0xc421ae0420, 0xc420de00c0)
:7 +0x72
main.(*Worker).Start(0xc420de00c0)
/home/matrixstatic/matrix-static/src/github.com/t3chguy/matrix-static/workers.go:38 +0x75
created by main.NewWorker
/home/matrixstatic/matrix-static/src/github.com/t3chguy/matrix-static/workers.go:88 +0x141

link to back to room rather than room list

/servers and /members links to rooms rather than the room they are of, fixxy

Remove code for handling unknown types in room-chat.qtpl template

it looks to me like matrix-static should display "Cannot Understand Event" when it gets an event with a type it doesn't recognize, but instead, it just doesn't display that event.

Support viewing groups

consider allowing the user to be invited into a room

to get around the public peekable requirement

rate-limit synapse calls

No names for people without names

Should probably fall back to something, otherwise the list looks weird: https://view.matrix.org/room/!zxWLnBMJtBomyQlnRV:tang.ents.ca/members?page=1 (see bottom or page 2)

Fix html errors found by w3 validator

See e.g. https://validator.w3.org/nu/?doc=https%3A%2F%2Fview.matrix.org%2Froom%2F%21cURbafjkfsMDVwdRDQ%3Amatrix.org%2F

Primary errors seem to be not including an alt attribute on <img> tags and using using nowrap attribute on <td> element is considered obsolete.

I'm not really sure what we should be putting as image alt-texts, but according to w3, something does have to be there.

Option to auto-join rooms

as this would allow access to history of rooms without History=Anyone

when event resolution fails, show better error

Room list – Public Rooms, view.matrix.org/?page=0 – relatively slow, heavyweight

https://view.matrix.org/?page=0

Around fifty seconds to load finish when e.g. the network console is open, in Firefox 71.0, before loading the page.

Then a waiting period before the application becomes responsive, but this is probably an issue with Firefox. Screen recording:

2019-12-30 15:45 Firefox 71.0.zip

Not so long when web developer tools are in use but still, it's remarkably slow to load in some browsers.

allow /alias/ endpoint to omit the `#`

Invalid redirection URL

The following URL is generated from matrix.to for the matrix-static client:

https://view.matrix.org/room/!qIEpwTKYYJECuPNzlt:flying-snail-matrix.nsupdate.info?via=flying-snail-matrix.nsupdate.info&via=matrix.org

Calling this redirects to the following, obviously invalid, URL:

https://matrix.orgroom/!qIEpwTKYYJECuPNzlt:flying-snail-matrix.nsupdate.info?via=flying-snail-matrix.nsupdate.info&via=matrix.org

(server "matrix.orgroom" cannot be found)

LRU to expire spidering of rooms if nobody is actively viewing them

to stop spidering accumulating steadily over time until it takes out synapse

panic

[GIN] 2019/02/09 - 11:35:10 | 200 ESC[0m|  985.490869ms | 54.36.148.31 |  ESC[0m GET     /api/room/!byVSIeqgYCNgmluYKv:outcasts.win/
time="2019-02-09T11:35:36Z" level=info msg="Started Initial Syncing Room" roomID="!AEhkQDKeSJvwkKyIHq:matrix.org" worker=14
time="2019-02-09T11:35:38Z" level=info msg="Finished Initial Syncing Room" roomID="!AEhkQDKeSJvwkKyIHq:matrix.org" worker=14
panic: runtime error: slice bounds out of range

goroutine 41 [running]:
main.RoomMembersJob.Work(0xc4331f01ee, 0x1e, 0x0, 0x14, 0xc420ed7ce0)
        /home/matrixstatic/matrix-static/src/github.com/t3chguy/matrix-static/job-room-members.go:41 +0x687
main.(*RoomMembersJob).Work(0xc420dd9540, 0xc420ed7ce0)
        <autogenerated>:7 +0x72
main.(*Worker).Start(0xc420ed7ce0)
        /home/matrixstatic/matrix-static/src/github.com/t3chguy/matrix-static/workers.go:38 +0x75
created by main.NewWorker
        /home/matrixstatic/matrix-static/src/github.com/t3chguy/matrix-static/workers.go:88 +0x141

filter out NSFW rooms

view.matrix.org seems to be fussy about trailing slashes

this 404s https://view.matrix.org/room/!MeRdFpEonLoCwhoHeT:matrix.org
but https://view.matrix.org/room/!MeRdFpEonLoCwhoHeT:matrix.org/ dosen't

Older direct links stop working

I opened this message direct link from Jul 5

https://view.matrix.org/room/!wSdymYrEpBhsWlDJuk:decred.org/?anchor=$153090455433548QNlFj:decred.org

and it showed "Some error has occurred". Then I removed the anchor part from the URL to open latest messages in the room and pressed "Load older messages" until I reached Jul 5 and it showed the message I was after. Then I visited initial direct link again and it opened.

Example of direct link that doesn't work (until someone visits it via "Load older messages"):

https://view.matrix.org/room/!OfChXgczrIlpEZSFAv:decred.org/?anchor=$153125687135698lmQRO:decred.org

fallback to generated avatar onerror

match colours of generated avatars

or maybe we don't care because afaik synapse/whatever will eventually offer to generate them for us

check if /assets/ folder is accessible on start-up

to prevent people running in wrong working directory and wondering why it looks even worse :(

fix readme hosted-at link