Wiki source code of Element Messenger
Last modified by Thomas Coelho (local) on 2026/03/13 11:41
Show last authors
| author | version | line-number | content |
|---|---|---|---|
| 1 | {{warning}} | ||
| 2 | The Element Messenger is in testing. You can try it and report problems or ask questions. Currently voice and video calls are untested. The service can be taken down and your data (chats) can be deleted without notice. | ||
| 3 | {{/warning}} | ||
| 4 | |||
| 5 | {{warning}} | ||
| 6 | Because this system uses end-to-end encryption, you have to backup your encryption key. This is important to make your communication private without a backdoor. | ||
| 7 | {{/warning}} | ||
| 8 | |||
| 9 | {{toc/}} | ||
| 10 | |||
| 11 | = What it is = | ||
| 12 | |||
| 13 | Element is an implementation of the open Matrix protocol. Matrix is a messenger protocol with the same intend like What's app, also with features from Mattermost. As the main differences is, it is self hosted and federated (like email). This means, we run the server in our server room and you can communicate with people from other Matrix instances. | ||
| 14 | |||
| 15 | == Glossary == | ||
| 16 | |||
| 17 | There many names involved we should clear out | ||
| 18 | |||
| 19 | * Matrix: The open communications protocol | ||
| 20 | * Element: The main developer of your software stack ([[Element.io>>https://element.io]]) | ||
| 21 | * Element-web: The Matrix Web client | ||
| 22 | * Element X: The recommended mobile app | ||
| 23 | * Synapse: The Matrix server backend | ||
| 24 | * MAS: Matrix Authentication Server - Backend Managing the Matrix Users | ||
| 25 | |||
| 26 | == Anatomy of a matrix address == | ||
| 27 | |||
| 28 | Matrix addresses are different then email addresses. This is important to lookup other users: | ||
| 29 | |||
| 30 | **@username:homeserver** | ||
| 31 | |||
| 32 | For example: @itptest:itp.uni-frankfurt.de | ||
| 33 | |||
| 34 | == Our Server == | ||
| 35 | |||
| 36 | If you use something different then our Element-Web, you need to connect the client to our matrix server. | ||
| 37 | |||
| 38 | {{info}} | ||
| 39 | Our Matrix Server: **https:~/~/matrix.itp.uni-frankfurt.de** | ||
| 40 | {{/info}} | ||
| 41 | |||
| 42 | = Where to start = | ||
| 43 | |||
| 44 | Starting is quite easy: Go to our Element-Web Client [[ITP Element-Web>>https://element.itp.uni-frankfurt.de]] | ||
| 45 | |||
| 46 | [[image:1771233799504-920.png]] | ||
| 47 | |||
| 48 | ITP Users and other users select select "Sign In". | ||
| 49 | |||
| 50 | Then you have to choose your "Home Server". The Element Web Client is independent from Matrix server. Click on continue, the ITP Matrix Service is preconfigured. | ||
| 51 | |||
| 52 | [[image:1771234068639-516.png]] | ||
| 53 | |||
| 54 | Then you will be redirected to MAS, the Matrix Authentication Service. This service manages the access to Matrix. | ||
| 55 | |||
| 56 | |||
| 57 | You will be redirected to our SSO Login "Authentic". Enter your ITP creadentials | ||
| 58 | |||
| 59 | There you have to confirm your user and your have successfully login in. The Element Session will normally not expire. | ||
| 60 | |||
| 61 | = Backup your encryption key (important!) = | ||
| 62 | |||
| 63 | After you have sent your first chat message, encryption is activated and you will see the this pop up: | ||
| 64 | |||
| 65 | [[image:1772184851421-817.png]] | ||
| 66 | |||
| 67 | Click on continue. | ||
| 68 | |||
| 69 | The recovery section is marked with a red dot. Click on the button "Setup recovery". | ||
| 70 | |||
| 71 | Follow the guide and store the displayed key in a secure place (eg. password manager like keypass). If your are logged out from your last session, this is the only way the regain access to your encrypted chats. | ||
| 72 | |||
| 73 | = External User = | ||
| 74 | |||
| 75 | == Users with a different Matrix home server == | ||
| 76 | |||
| 77 | Matrix is a federated service. You can communicate with any other Matrix user in the world. The HRZ offers an unsupported matrix instance ([[HRZ Matrix Server>>https://element.uni-frankfurt.de]]). Communicating with university members is straight forward. | ||
| 78 | |||
| 79 | == People without Matrix access == | ||
| 80 | |||
| 81 | People with no other option can be invited to enroll to Authentik. Please ask Support for an invitation key. | ||
| 82 | |||
| 83 | = Mobile Apps = | ||
| 84 | |||
| 85 | For sure Element is also available for iOS and Android. Please install "Element X" from your app store. Attention: There is also an "Element Classic" which is deprecated and does not work with MAS. | ||
| 86 | |||
| 87 | To setup the mobile app go to element web and click on the avatar icon in the left upper corner. Then choose "link new device". A QR code and instruction how to scan this with your mobile app. | ||
| 88 | |||
| 89 | = Desktop Apps = | ||
| 90 | |||
| 91 | On our managed ITP machines, the desktop application "Element" is installed. This is basically a wrapped version off the web client, which uses the Electron frame work. It has some features the web app does not offer, like full text search trough your chats. | ||
| 92 | |||
| 93 | = Special Features = | ||
| 94 | |||
| 95 | == Latex Formula Rendering == | ||
| 96 | |||
| 97 | It's declared as experimental feature. In the Desktop App you can add a configuration file in JSON format. | ||
| 98 | |||
| 99 | {{code language="bash"}} | ||
| 100 | cd ~/.config/Element | ||
| 101 | {{/code}} | ||
| 102 | |||
| 103 | Create a file "config.json" with the following content: | ||
| 104 | |||
| 105 | {{code language="json"}} | ||
| 106 | { | ||
| 107 | "features": { | ||
| 108 | "feature_latex_maths": true | ||
| 109 | } | ||
| 110 | } | ||
| 111 | |||
| 112 | {{/code}} | ||
| 113 | |||
| 114 | In the web client this is also enabled. | ||
| 115 | |||
| 116 | You can render Latex with a surrounding $ or $$ for inline or block setting. See [[Documentation>>https://github.com/element-hq/element-web/blob/develop/docs/labs.md]] |