89 lines
3.6 KiB
Markdown
89 lines
3.6 KiB
Markdown
# 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.
|
|
|
|
## How can I put a badge on my website linking to my matrix room?
|
|
|
|
You can use the badge image we've put up at https://matrix.to/img/matrix-badge.svg, and use it in a link like this:
|
|
|
|
[](https://matrix.to/#/#matrix.to:matrix.org)
|
|
|
|
You can use this Markdown:
|
|
```md
|
|
[](https://matrix.to/#/#matrix.to:matrix.org)
|
|
```
|
|
|
|
Or this HTML:
|
|
|
|
```html
|
|
<a href="https://matrix.to/#/#matrix.to:matrix.org" rel="noopener" target="_blank"><img src="https://matrix.to/img/matrix-badge.svg" alt="Chat on Matrix"></a>
|
|
```
|
|
|
|
to show the badge.
|
|
|
|
## How does matrix.to work?
|
|
|
|
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.
|
|
|
|
## URL Scheme
|
|
|
|
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)
|
|
|
|
### Optional parameters
|
|
|
|
https://matrix.to/#/#matrix:matrix.org?web-instance[element.io]=chat.mozilla.org
|
|
|
|
- `client`, e.g. `client=im.fluffychat`, `client=element.io`
|
|
- `web-instance[]`, e.g. `web-instance[element.io]=chat.mozilla.org`
|
|
- `via`, e.g. `via=mozilla.org`
|
|
|
|
You can discuss matrix.to in
|
|
[`#matrix.to:matrix.org`](https://matrix.to/#/#matrix.to:matrix.org)
|
|
|
|
## Build Instructions
|
|
|
|
1. Install [yarn](https://classic.yarnpkg.com/en/docs/install)
|
|
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
|
|
|
|
## Docker instructions
|
|
|
|
1. Build your own image, `docker build . -t matrixdotorg/matrix-to:dev`
|
|
2. Run, `docker run -it -d --name matrix-to-dev -p 5000:5000 matrixdotorg/matrix-to:dev`
|