sij/env.esq
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
Cloned from https://github.com/matrix-org/matrix.to; anticipating modifications.
298 commits 37 branches 31 tags 2 MiB
JavaScript 92.4%
CSS 6.5%
HTML 0.8%
Dockerfile 0.2%
Find a file
Bruno Windels 690fb3400c
Merge pull request #203 from matrix-org/bwindels/undo-fix-201 
Undo fix for #201 as app.element.io uses mobile page & smart app banners
2021-04-13 09:53:30 +02:00
css basic wrapping for long identifiers, until we come up with something better 2021-04-12 15:21:27 +02:00
docs Set up story book 2020-07-30 13:30:27 +01:00
images add tensor client again 2020-12-07 18:54:57 +01:00
scripts exit package script if anything fails 2021-02-04 17:15:36 +01:00
src undo fix for #201 as app.element.io uses mobile page & smart app banners 2021-04-13 09:47:21 +02:00
.editorconfig editor and lint settings 2020-12-03 11:06:25 +01:00
.eslintrc.js editor and lint settings 2020-12-03 11:06:25 +01:00
.gitignore package script 2020-12-08 15:43:59 +01:00
index.html explain what value people will get from enabling javascript 2021-02-04 14:59:38 +01:00
package.json forgot to update version previously 2021-04-12 14:28:02 +02:00
README.md Add some build instructions 2020-12-22 00:27:34 -06:00
yarn.lock new deps 2020-12-08 10:29:46 +01:00

README.md

Matrix.to

Matrix.to is a simple url redirection service for the Matrix.org ecosystem which lets users share links to matrix entities without being tied to a specific app. Stylistically it serves as a landing page for rooms and communities.

Matrix.to preserves user privacy by not sharing any information about the links being followed with the Matrix.to server - the redirection is calculated entirely clientside using JavaScript, and the link details is hidden behind a fragment to avoid web clients leaking it to the server. However, acting as a landing page it may leak your ip to any number of homeservers involved with the entity linked to while fetching previews. There is an opt out under which no previews will be loaded.

Anyone is welcome to host their own version of the Matrix.to app - Matrix.to is not a single point of failure on the Matrix ecosystem; if the matrix.to deployment ever failed, users could trivially copy the room/user/message details out of the URLs and follow them manually, or change the hostname to point at an alternative deployment of the service. The Matrix.to service could also be hosted in an immutable/signed environment such as IPFS to further increase its availability and avoid tampering.

The matrix.to URL scheme is

Entity type: Example URL
Rooms: https://matrix.to/#/#matrix:matrix.org
Rooms by ID: https://matrix.to/#/!cURbafjkfsMDVwdRDQ:matrix.org
Users: https://matrix.to/#/@matthew:matrix.org
Messages: https://matrix.to/#/#matrix:matrix.org/$1448831580433WbpiJ:jki.re

The #/ component is mandatory and exists to avoid leaking the target URL to the server hosting matrix.to.

Note that linking to rooms by ID should only be used for rooms to which the target user has been invited: these links cannot be assumed to work for all visitors.

(Technically the # and @ in the URL fragment should probably be escaped, but in practice for legibility we bend the rules and include it verbatim)

You can discuss matrix.to in #matrix.to:matrix.org

Build Instructions

  1. Install yarn
  2. git clone https://github.com/matrix-org/matrix.to
  3. cd matrix.to
  4. yarn
  5. yarn start
  6. Go to http://localhost:5000 in your browser