Initial commit

This commit is contained in:
Carsten Brueggenolte 2021-07-31 20:14:01 +02:00
parent a70a9ea935
commit 1994d8c2af
95 changed files with 10205 additions and 2 deletions

27
TODO Normal file
View File

@ -0,0 +1,27 @@
TODO
- Look for link pointing to tu-dresden.de
- Images need to be adjusted
- links need to be fixed
- subfolders need to be addressed correctly
Search and Replace:
-------------------
1.
{{% notice info %}}
<span class="info">
2.
{{% /notice %}}
</span>
-- find all
{{< relref "
and remove

BIN
docs/.DS_Store vendored Normal file

Binary file not shown.

40
docs/clients.md Normal file
View File

@ -0,0 +1,40 @@
---
title: "Clients / Installation"
date: 2020-07-02T21:22:27+02:00
draft: false
chapter: true
weight: 15
---
# Installation of a client / program
The recommended client for using Matrix is called Element and can be used on different systems and devices:
1. **Element Web:** [The TU Dresden browser web application](#web-app)
1. **Element Desktop:** [Downloads for Linux/Windows/Mac](#desktop-app)
1. **Element mobile:** [Android/iOS](#mobile-app)
![Element page for client download](images/12_Element-Download.png)
## Element Web {#web-app}
Web-App: {{% button href="https://matrix.tu-dresden.de" icon="fas fa-globe" %}}matrix.tu-dresden.de{{% /button %}}
The easiest way is to open the Element Web application directly in a modern browser (e.g. [Mozilla Firefox](https://www.mozilla.org/de/firefox/)).
Further information can be found in the submenu ["Element Web (Browser)"]({{< ref "clients/browser" >}} "Element Web (Browser)").
## Element Desktop {#desktop-app}
Downloads for: {{% button href="https://packages.riot.im/desktop/install/win32/x64/Element%20Setup.exe" icon="fas fa-download" %}}Windows{{% /button %}} {{% button href="https://packages.riot.im/desktop/install/macos/Element.dmg" icon="fas fa-download" %}}macOS{{% /button %}} {{% button href="/clients/install_linux" icon="fas fa-download" %}}Linux{{% /button %}}
More recommendable than using a browser tab is the installation of the program Element on your own computer. Here you can keep the overview independently of the browser (however, you should also take care of the updates of the program).
More information can be found in the submenu ["Element Desktop"]({{< ref "desktop.md" >}} "Element Desktop").
## Element Mobile {#mobile-app}
Downloads for: {{% button href="https://play.google.com/store/apps/details?id=im.vector.app" icon="fas fa-download" %}}Android (Google Play){{% /button %}} {{% button href="https://apps.apple.com/app/vector/id1083446067" icon="fas fa-download" %}}iOS (iPhone/iPad){{% /button %}} {{% button href="https://f-droid.org/packages/im.vector.app/" icon="fas fa-download" %}}Android (F-Driod){{% /button %}}
To have access to Matrix on the road, there is the possibility to install a mobile element client on the smartphone.
Further information can be found in the submenu ["Element Mobile"]({{< ref "mobile.md" >}} "Element Mobile").

BIN
docs/clients/.DS_Store vendored Normal file

Binary file not shown.

65
docs/clients/browser.md Normal file
View File

@ -0,0 +1,65 @@
---
title: "Element Web (Browser)"
date: 2020-07-15T16:46:07+02:00
draft: false
chapter: true
weight: 10
---
# Using the Element webclient
Start here: [https://matrix.tu-dresden.de](https://matrix.tu-dresden.de)
![Start page of Element Webclient with login button](/images/01_Welcome_en.png)
No registration is necessary, the service can be used immediately by clicking on "Register" on the homepage [https://matrix.tu-dresden.de](https://matrix.tu-dresden.de).
![Login window with request to enter ZIH login and password](/images/02_Login1_en.png)
The drop-down menu "Log in with:" should be left at "User name". Then the following entries must be made:
**Username: ZIH-Login** (only the ZIH-Login, no e-mail address!)
**Password: ZIH password**
An alternative login, e.g. using the e-mail address, is **NOT** possible during the first, initial login, only after the second login.
After the first login there is also no e-mail / confirmation mail.
Analogous to e-mail addresses, this results in matrix addresses with the following structure:
@ZIH-Login:tu-dresden.de
{{% notice warning %}}
If you want to start immediately with a [Matrix Client]({{< relref "../clients" >}}) instead of the above mentioned website (Element Web-App installed at TU Dresden), it is important to change the home server from the usually default matrix.org to https://matrix.tu-dresden.de (shown in the following three screenshots)
{{% /notice %}}
![Change login page with focus on the homeserver Button](/images/02_Login2_en.png)
1. click on change
![input field to change the home server with the input matrix.tu-dresden.de](/images/02_Login3_en.png)
2. mark the preset home server address and remove it
![](/images/02_Login4_en.png)
3. entry of the matrix home server address of the TU Dresden
## Browser settings
### Browser selection
Recommended are the browsers [Firefox](https://www.mozilla.org/de/firefox/new/), [Chromium](https://www.chromium.org/getting-involved/download-chromium), newer versions of MS Edge (based on Chromium). Older or unsuitable browsers may only show a white page.
### NoScript
Many people use script blockers to protect themselves from [Tracking](https://tu-dresden.de/tu-dresden/newsportal/news/datenschutz-beim-website-tracking) and malware in the browser, for example with the addon [NoScript](https://addons.mozilla.org/de/firefox/addon/noscript/). Here you have to make the following settings (for the integration manager, e.g. Jitsi/Etherpad)
![Browser plugin settings NoScript with tu-dresden.de and vector.im selected as trusted script sources](/images/10_Sicherheit2_en.png)
### Cookies
Do you also allow cookies from
- tu-dresden.de
- vector.im (for the integration manager)

33
docs/clients/desktop.md Normal file
View File

@ -0,0 +1,33 @@
---
title: "Element Desktop"
date: 2020-10-12T09:27:07+02:00
draft: false
chapter: true
weight: 20
---
## Element Desktop
Downloads for: {{% button href="https://packages.riot.im/desktop/install/win32/x64/Element%20Setup.exe" icon="fas fa-download" %}}Windows{{% /button %}}
{{% button href="https://packages.riot.im/desktop/install/macos/Element.dmg" icon="fas fa-download" %}}macOS{{% /button %}}
{{% button href="/clients/install_linux/" icon="fas fa-download" %}}Linux{{% /button %}}
After a desktop installation, make sure to use the existing account with the ZIH login and not to create a new account on another server. Here the example of Element:
![Selected login button in the element matrix client](/images/01_Login_en.png)
This is done by clicking on **Change**. Then you will not accidentally end up on the wrong server...
![Change login page with focus on the homeserver button](/images/02_Change-Homeserver_en.png)
Now you can manually specify the home server: tu-dresden.de
![Input field to change the home server with the input matrix.tu-dresden.de](/images/03_Set-Homeserver_en.png)
Afterwards the one-time login with ZIH login and ZIH password must be carried out:
![Login window with request to enter ZIH login and password](/images/04_Username_en.png)
By activating the slider under Settings > Settings > "**Automatic start after system login**", the element client starts after every reboot and you no longer miss any notifications due to accidentally closing the browser tab in the usage variant with the Web App.
![settings marked with the dot start automatically after system startup](/images/05_Settings_en.png)

View File

@ -0,0 +1,36 @@
---
title: "Install on Linux"
date: 2020-12-31T09:29:07+02:00
draft: false
chapter: true
weight: 60
---
# Install Element Desktop on Linux
We recommend using the package manager of your System to install Element Desktop. The following commands will install element desktop. You can enter them on the command line.
### Debian/Ubuntu
```sh
sudo apt install -y wget apt-transport-https
sudo wget -O /usr/share/keyrings/riot-im-archive-keyring.gpg https://packages.riot.im/debian/riot-im-archive-keyring.gpg
echo "deb [signed-by=/usr/share/keyrings/riot-im-archive-keyring.gpg] https://packages.riot.im/debian/ default main" | sudo tee /etc/apt/sources.list.d/riot-im.list
sudo apt update
sudo apt install element-desktop
```
### Fedora
```sh
sudo dnf install -y dnf-plugins-core distribution-gpg-keys
sudo dnf copr enable taw/element
sudo dnf install -y element --refresh
```
### Arch Linux
```sh
sudo pacman -Sy element-desktop
```
### NixOS
```sh
nix-env -iA nixos.element-desktop
```

17
docs/clients/mobile.md Normal file
View File

@ -0,0 +1,17 @@
---
title: "Element Mobile"
date: 2020-10-12T09:29:07+02:00
draft: false
chapter: true
weight: 30
---
## Element Mobile
Downloads for: {{% button href="https://play.google.com/store/apps/details?id=im.vector.app" icon="fas fa-download" %}}Android (Google Play){{% /button %}} {{% button href="https://apps.apple.com/app/vector/id1083446067" icon="fas fa-download" %}}iOS (iPhone/iPad){{% /button %}} {{% button href="https://f-droid.org/packages/im.vector.app/" icon="fas fa-download" %}}Android (F-Driod){{% /button %}}
The following series of images shows screenshots of the setup of Android or iOS Element:
![Screenshot of the login procedure under Android/iOS](/images/15_Android1_en.png)
![Screenshot of the Android client element after successful login](/images/15_Android2_en.png)

View File

@ -0,0 +1,13 @@
---
title: "More clients"
date: 2020-07-02T21:22:27+02:00
draft: false
chapter: true
---
# More clients
For users who like to experiment, there are numerous other clients in addition to Element, with which the Matrix communication protocol can be used:
- https://matrix.org/docs/projects/clients-matrix
- https://matrix.org/docs/projects/try-matrix-now

32
docs/communities.md Normal file
View File

@ -0,0 +1,32 @@
---
title: "Communities"
date: 2020-07-02T21:22:34+02:00
draft: false
chapter: true
weight: 50
---
# Use communities as room filters
All matrix users of the client element (and a few other clients) can use communities to filter different rooms, which may be lost or scattered in the room list on the left.
Communities can only be created for yourself or for others (if you invite them into a community) and create a superordinate structure for rooms. For example, for a semester group/study group or for a chair team etc.
Existing rooms can be assigned to a community in the community settings (under #).
![Screenshot of the selection of the current community](images/20_Communities.webp)
A community created with the + button can be drag'n'dropped from the community avatar (little picture) onto the sidebar.
A small HTML page can be used to describe the community.
Unfortunately it is currently not possible to add more administrators through the matrix client: [https://github.com/vector-im/element-web/issues/5240](https://github.com/vector-im/element-web/issues/5240)
Removing rooms from communities is done by clicking on the hash # in the upper right corner, then clicking on the room to be removed and then clicking on "Remove from community".
A community can be deleted when the administrator leaves it.
### other administrators
Currently no more administrators can be added to a community via Element. Issue on Github](https://github.com/vector-im/riot-web/issues/5240) If you need more administrators in a community, they can be added by the Matrix Admin Team. Please send a support request to servicedesk@tu-dresden.de.

28
docs/development.md Normal file
View File

@ -0,0 +1,28 @@
---
title: "Development"
date: 2020-07-03T13:15:20+02:00
draft: false
chapter: true
weight: 200
---
# Further development of Matrix
Currently the TU Dresden does not pay for the use of the source code. The Matrix-Admin-Team is in contact with the developers and occasionally contributes small things to the further development.
Matrix is an open standard, the details of interoperable communication using the matrix set of HTTP-APIs are freely published. Matrix is also open source, which means that the source code of the reference servers, clients and services has been released to the public under the Apache v2 license to encourage everyone to run their own servers and clients.
![free software banner](images/free-software-likes-you-and-your-freedom.webp)
Since it is free software, improvement requests can be converted into direct programming jobs.
Currently still in development, and can be promoted/accelerated by orders/donations, are among others
* chat export
* Threading (more clearly arranged discussions)
* personal status
* various integrations / bots / bridges
Discussions on the topic can be held in Matrix@TUD.

68
docs/encryption.md Normal file
View File

@ -0,0 +1,68 @@
---
title: "Encryption"
date: 2020-07-03T13:20:58+02:00
draft: false
chapter: true
weight: 60
---
# Use of end-to-end encryption
1:1 calls are now encrypted end-to-end by default. Therefore, a configured key backup as well as a verification of all self used client devices is recommended ([Important settings]({{< ref "settings" >}}))
The decision whether a created room should be encrypted in this way must be well thought out and cannot be undone. If the room is large or public, checking all keys of all interlocutors could take a lot of time. But this manual check can be done later on occasion and end-to-end encrypted conversations can be started directly with blind trust for the time being.
![Create new room with activated encryption](images/01_Create-Room-wE2E_en.png)
If you want end-to-end encryption (E2EE) to interlocutor:inside in an unencrypted room, you can achieve this by clicking on the settings of the desired room. (or in the room via "Room info" > "Room settings" in the upper right corner):
![Menu to get to the room settings](images/02_Roomsettings_en.png)
To do this, move the Encrypted slider on the Security & Privacy tab:
![Enable encryption in the room settings](images/03_Roome2e_en.png)
This can be confirmed with OK. From now on the messages can only be read by those involved in the conversation. If you have not set up a key protection in the settings before, you should do this now (see [Important settings]({{< ref "settings" >}})) to be able to read earlier and in absence received messages.
Now the encrypted exchange can begin. If you want to verify the correctness of the keys and to document this trustworthiness digitally, you first have to unfold the sidebar by clicking on the person symbol in the upper right corner:
![open the list of persons in the room](images/04_RoomPeople_en.png)
The contact person can now be clicked on in the opening bar of the participants in the conversation:
![room with note that not all participants are verified](images/05_People-Unverified_en.png)
The bar now shows the conversation person in detail. Here a key verification can be initiated by clicking on "Verify". By clicking on "Start Verification" the other side is notified and after confirmation (see next picture) the "Verification by Emojis" can start.
![Menu to the person to verify selected with the verify button](images/06_E2EE_Verify_en.png)
![Menu to start the verification](images/07_E2EE_Accept_en.png)
This verification should be done with the contact person by comparison (e.g. verbally via telephone, in the same room or other medium). Since this is not always easy, the trust can also be expressed first of all (otherwise you will be asked again and again to carry out the verification) and carried out on occasion (e.g. at the next meeting).
A detailed description of the topic can be found in this [video by Prof. Plikat](https://invidious.ggc-project.de/VOxfa6dqXSk) and [in this Matrix blog article](https://blog.riot.im/e2e-encryption-by-default-cross-signing-is-here).
The adjustment itself is done via emoji images or QR codes, which can look different depending on the device and icon pack. Also the translation of all interface elements into German is not 100% available.
![Emoji comparison to verify the key exchange](images/16_E2EE.png)
This is done analogously in rooms with several participants, each one individually.
![verification process was successful](images/08_Verified_en.png)
In the respective room rows the following symbols indicate the status of the encryption and the corresponding verification:
![symbol for at least one non-verified person](images/gray.png)
At least one person in the room has not yet been verified.
![symbol for a verified person who has opened unverified sessions](images/unverified.png)
There is at least one person in the room who has already been verified, but who in turn has opened further unverified sessions.
![symbol for all persons in the room are verified](images/green.png)
All persons in the room were verified.

142
docs/faq.md Normal file
View File

@ -0,0 +1,142 @@
---
menutitle: "FAQ"
title: "Frequently asked questions"
date: 2020-08-02T21:26:25+02:00
draft: false
weight: 200
---
This is a collection of frequently asked questions and their answers. Some of the answers are not yet written. In these cases please ask in the matrix room ```#matrix-support:tu-dresden.de```.
* [Messages not readable](#message-not-readable)
* [What is the difference between passphrase and recovery key?](#securityphrase-vs-securitykey)
* [Why is there no status bar at the bottom of the screen when hovering over hyperlinks in the Desktop-Client element? How can you trust them then?](#no-statusline)
* [How to tell people a room address with Element Desktop Client?](#desktop-share-room)
* [How do you tell people a room address with Element Web-Client?](#web-share-room)
* [Can I write LaTeX?](#latex)
* [Are there something like Threads (like in Mattermost/Slack) in Matrix?](#threads)
* [I do not have a security key (recovery key)](#no-security-key)
* [How do I change the passphrase for my key backup?](#change-securityphrase)
* [How do I reset the secure backup if I have lost my security phrase AND my (saved and printed) security key?](#reset-securityphrase)
* [Why is there no room "TU Dresden"? Who is allowed to create it?](#no-tud-room)
* [How can I, as the administrator, delete many messages at once?](#delete-multiple-messages)
* [Sometimes I see a room marked in bold and click on it, but I don't have the time to edit the content and any consequences for me immediately. How can I mark the room as "unread" again?](#mark-room-as-unread)
* [What should I do if video or audio in a video conference does not work on a MacOS?](#apple-no-video)
* [How many people can be invited at ones into a room? Can I invite people by their E-Mail address?](#how-many-invites-can-i-do)
* [Can I modify access permissions for all rooms in my community, that only members of the community can enter?](#roompermissions-in-communities)
* [Can I manage multiple Matrix-Account on my Element Desktop Client?](#multiple-accounts-element)
* [I can no longer see profile/room pictures or other pictures.](#relogin)
#### Messages not readable {#message-not-readable}
* At least one verified session must be open at all times, the easiest way to do this is to set up the Desktop Client or Element on a smartphone. These programs can be closed and restarted without having to log in again. Otherwise, a verified Matrix session can be created in a private web browser window by logging into Matrix there and verifying this session from an existing one. This window can be closed after about five minutes. The keys are transferred to the other Matrix clients by the verification process. This creates a ghost session which is then always open. Then all other clients can be logged out. Otherwise messages which are received in the period without open matrix session cannot be read later. This is to be solved in the future by means of the function dehydrated devices.
* Has the [Secure Backup]({{< relref "settings/#secure-backup" >}}) been set up properly?
* Messages remain unreadable when matrix sessions are created and then the web browser window is simply closed without logging out. Solution: only possible for new messages: read this documentation.
***
#### What is the difference between passphrase and recovery key? {#securityphrase-vs-securitykey}
The password that can access the key backup is called the recovery key and is very long, starts with a capital E and should be saved or printed after setup. Since this password is hard to remember in everyday life (e.g. when you are on the road, want to have a look at Matrix, but only have access to other computers) you can think of a (easy to remember) passphrase from which the recovery key can be calculated (in the browser/client) before trying to "open" the key backup.
***
#### Why is there no status bar at the bottom of the screen when hovering over hyperlinks in the Desktop-Client element? How can you trust them then? {#no-statusline}
In fact, the status bar is a popular test of the seriousness of hyperlinks you are trying to click on. In the Desktop Client element this is not possible, similar to the mobile clients. Here you can only right-click on the link and check the presented target page for seriousness.
***
#### How to tell people a room address with Element Desktop Client? {#desktop-share-room}
With the matrix.to link, which you can see under the i for the room properties and another click on "Share room".
***
#### How do you tell people a room address with Element Web-Client? {#web-share-room}
With the matrix.to link, which you can see under the i for the room properties and a further click on "Part room" and an exchange of the front matrix.to with matrix.tu-dresden.de
***
#### Can I write LaTeX? {#latex}
Yes, but it is an experimental feature right now. It will be available for everybody in a few weeks: https://github.com/vector-im/element-web/issues/1945
***
#### Are there something like Threads (like in Mattermost/Slack) in Matrix? {#threads}
No, threads like in Mattermost or Slack are currently not existing in Matrix. The developers of Element are aware of this topic and planed it for future release. To get more information, follow their roadmap: https://github.com/vector-im/roadmap/projects/1
***
#### I do not have a security key (recovery key) {#no-security-key}
To do this, please check whether this has been set up at all. See [Secure backup]({{< relref "settings/#secure-backup" >}})
***
#### How do I change the passphrase for my key backup? {#change-securityphrase}
* export the room keys for all matrix sessions except for one, which is still accessible, `Settings` -> `Security & Privacy` -> `Encryption`/`Cryptography`, here it is best to provide the matrix login password. Finally, log out by clicking on the user name in the upper left corner and log out. If you are asked whether you want the encrypted messages, click on 'I don't want my encrypted messages', because these keys have already been exported.
* Under `Settings`-> `Security & Privacy` -> `Secure Backup` press first `Delete Backup`, afterwards the button `Reset` and may a clearing of the cache under `Settings`-> `Help & About` is necessary, as well a logging off and logging on again. If all this does not work, continue in the next point. The action was successful, if only the green 'Setup' button is displayed.
* For all previously exported key backups, perform the manual import path
* Set up a new security backup. See [Secure backup]({{< relref "settings/#secure-backup" >}})
***
#### How do I reset the secure backup if I have lost my security phrase AND my (saved and printed) security key? {#reset-securityphrase}
Please execute the following:
* export the room keys for all matrix sessions except for one, which is still accessible, `Settings` -> `Security & Privacy` -> `Encryption`/`Cryptography`, here it is best to provide the matrix login password. Finally, log out by clicking on the user name in the upper left corner and log out. If you are asked whether you want the encrypted messages, click on 'I don't want my encrypted messages', because these keys have already been exported.
* [Delete]({{< relref "settings/#security--privacy" >}}) all sessions that are no longer accessible. the top one in bold is the current session, do not tick this one
* Log off the last session
* Write a message to the ServiceDesk with a request to delete the security keys from the database.
* Wait for the answer
* Log in again at Matrix and skip verification at windows and messages
* Log out from Matrix
* Log in again at Matrix and skip verification at windows and messages again
* Under `Settings`-> `Security & Privacy` -> `Secure Backup` look if there is a green button `Setup` and no red buttons. If there are still red buttons, press first `Delete Backup`, afterwards the button `Reset` and may a clearing of the cache under `Settings`-> `Help & About` is necessary, as well a logging off and logging on again. Also it may be necessary to press the red button `Reset` under `Settings`-> `Security & Privacy` -> `Cross-Signing`. The action was successful, if for 'Secure Backup' and 'Cross-Signing' only the green 'Setup' button is displayed.
* If all this does not work reply to the ticket with a request for a jitsi meeting
* For all previously exported key backups, perform the manual import path
* Set up a new security backup. See [Secure backup]({{< relref "settings/#secure-backup" >}})
***
#### Why is there no room "TU Dresden"? Who is allowed to create it? {#no-tud-room}
All persons creating a room are administrative persons and are responsible for the room. Matrix is not yet designed for the exchange of thousands of members at the university. Should a central room be needed one day, its establishment and maintenance would certainly be the responsibility of the Rectorate and the Department of "Strategy & Communication".
***
#### How can I, as the administrator, delete many messages at once? {#delete-multiple-messages}
?
***
#### Sometimes I see a room marked in bold and click on it, but I don't have the time to edit the content and any consequences for me immediately. How can I mark the room as "unread" again? {#mark-room-as-unread}
Unfortunately this is not possible in Element. As a workaround, you can mark the room as a favorite and notice yourself that your own favorites should be looked at again.
***
#### What should I do if video or audio in a video conference does not work on a MacOS? {#apple-no-video}
Often Element does not have the rights to access the webcam and microphone. These can be assigned in the system settings under Security and Privacy.
***
#### How many people can be invited at ones into a room? Can I invite people by their E-Mail address? {#how-many-invites-can-i-do}
Mass invite by E-Mail is currently not supported in Element. If you want to mass invite, please send an request via the servicedesk, so we can assist. You can invite 100 people by their ZIH username yourself.
***
#### Can I modify access permissions for all rooms in my community, that only members of the community can enter? {#roompermissions-in-communities}
No, this is not possible. Rooms can be part of multiple communities. Therefore the access permission will be set on room based level.
***
#### Can I manage multiple Matrix-Account on my Element Desktop Client? {#multiple-accounts-element}
With the Element Desktop client, you can only manage one Matrix-Account right now. But it is possible to start several Element-windows with different Matrix-Accounts, also within your Autostart-settings of your computer. Therefore, you need to change (or create additional) execution commands to open a specific profile:
```
element-desktop --profile PROFILE_NAME
```
So you can place several Element-Starters in your Autorstart, with different profile names, e.g. --profile TUD or --profile Private. Unfortunately, both opened windows will appear with the same Icon in the Indicator-Applet. But therefore, a solution will upcome soon, for sure...
Furthermore, there are other Matrix-Clients, that can handle more Matrix-Accounts per se, e.g. [weechat](https://matrix.org/docs/projects/client/weechat-matrix), [Spectral](https://matrix.org/docs/projects/client/spectral), [Quaternion](https://matrix.org/docs/projects/client/quaternion), or [Mirage](https://matrix.org/docs/projects/client/mirage).
***
#### I can no longer see profile/room pictures or other pictures. {#relogin}
Due to an update on the Matrix server (28.03.2021), clients that have been logged in since then can no longer find media files. To solve this problem, it is necessary to log off and log on again. **Attention: So that you do not loose any of your messages you should follow the procedure below.** If multiple clients are affected, the procedure should be performed one after each other and not in parallel.
<ul type="1">
<li>Make sure you have fulfilled at least one of the following prerequisites:</li>
<ol type="a">
<li>... an additional verified session (e.g. with the smartphone) is active and usable</li>
<li>... the <a href="{{< relref "settings/#secure-backup" >}} ">Secure Backup</a> is set up and the security phrase or the security key are present</li>
<li>... you have exportet your room keys</li>
</ol>
<li>Log off and log on again within the client and use as Matrix <strong>homeserver</strong>: "<strong>tu-dresden.de</strong>"</li>
<li>Restore your messages:</li>
<ol type="a">
<li>... Verify the new session in the additional active session to start the key exchange between these sessions</li>
<li>... Connect to the Secure Backup to get your message keys back</li>
<li>... Import the room keys and set up the <a href="{{< relref "settings/#secure-backup" >}} ">Secure Backup</a></li>
</ol>
**Annotations:**
* Losing the room keys will result in the loss of your messages, as they can only be read by you and your communication participants. No admin can help with that.
* Because of the new session, a red warning sign is subsequently displayed for all your previous messages. This is not an error, but just a little too dramatic information setting (further information can be found here: [external link](https://github.com/vector-im/element-web/issues/13701))
* If you only use Matrix on one device and you do not have access to your security phrase or security key you have to follow route c) to not loose your encrypted messages.

171
docs/first-steps.md Normal file
View File

@ -0,0 +1,171 @@
---
date: 2021-07-31T19:30:00+02:00
weight: 2
authors:
- cblte
- creme
---
# First steps - How to use Matrix?
## Matrix-Login with ZIH account
Members and members of the TU Dresden (of course also students) can use their **ZIH login** to communicate with members of the TU Dresden and other universities and other Matrix users (e.g. academic partners) via chat and audio/video telephony in compliance with the relevant legal and regulatory provisions on data protection and IT security.
communicate.
<span class="tip">
We recommend using the Element desktop client, because this avoids most problems users have with Matrix, e.g. end to end encryption.
<span>
Downloads for: {{% button href="https://packages.riot.im/desktop/install/win32/x64/Element%20Setup.exe" icon="fas fa-download" %}}Windows{{% /button %}} {{% button href="https://packages.riot.im/desktop/install/macos/Element.dmg" icon="fas fa-download" %}}macOS{{% /button %}} {{% button href="/clients/install_linux" icon="fas fa-download" %}}Linux{{% /button %}}
After a desktop installation, make sure to use the existing account with the ZIH login and not to create a new account on another server. Here the example of Element:
![Selected login button in the element matrix client](images/01_Login_en.png)
This is done by clicking on **Change**. Then you will not accidentally end up on the wrong server...
![Change login page with focus on the homeserver button](images/02_Change-Homeserver_en.png)
Now you can manually specify the home server: tu-dresden.de
![Input field to change the home server with the input matrix.tu-dresden.de](images/03_Set-Homeserver_en.png)
Afterwards the login with ZIH login and ZIH password must be carried out:
The drop-down menu "Log in with:" should be left at "User name". Then the following entries must be made:
**Username: ZIH-Login** (only the ZIH-Login, no e-mail address!)
**Password: ZIH-Password**
An alternative login, e.g. using the e-mail address, is **NOT** possible during the first, initial login, only after the second login.
After the first login there is also no e-mail / confirmation mail.
Analogous to e-mail addresses, this results in matrix addresses with the following structure:
@ZIH-Login:tu-dresden.de
![Login window with request to enter ZIH login and password](images/04_Username_en.png)
## Convenient use of end-to-end encryption (E2EE)
Matrix not only encrypts transports to and from the home server (in the data center of TU Dresden) but also allows the use of end-to-end encryption (E2EE). For this, cryptographic keys have to be exchanged between all devices that want to write end-to-end encrypted. This technical necessity sounds and is complicated, but in the meantime it has become very convenient for the users. The many cryptographic keys created by the client are stored on the respective device. If this is a tab in a browser, for example, there is a risk that this tab will be closed unintentionally. Then all encrypted contents are no longer readable. To prevent this from happening, a key protection is offered on the home server of the TU Dresden, on which (protected with a security phrase (or security key that can be calculated from it) all cryptographic keys are stored encrypted.
{{% notice info %}}
It is highly recommended to use this key backup (with a secure security phrase which is NOT your ZIH password)!
{{% /notice %}}
![Prompt to generate the security key or enter a security phrase](images/11_Setup-Key_en.png)
![Prompt to enter a password for the key backup](images/12_Enter-Key_en.png)
Alternatively, instead of the security phrase, you can also have a security key generated that serves the same purpose as the security phrase. Furthermore, the security key is generated in addition to the security phrase and should be kept safe and retrievable as an emergency key (e.g. save it as .txt file AND print it out)
![Display of the security key to write or save away](images/13_Present-Key_en.png)
[Other important settings]({{< relref "settings/_index.en.md" >}}) may improve your Matrix experience!
## Requests to setup the key backup
![Screenshot of the prompt to enter a security phrase](images/01_Restore-Session_en.png)
If you skipped the request to setup the key backup, the next screen would look like this:
![Confirmation of skipping the input of a security phrase](images/03_Cancel-Restore_en.png)
Key protection is highly recommended for worry-free end-to-end encryption. For this reason, a smaller tooltip will prompt you to set up the encryption even after you skip further:
![Chat view showing a tooltip to set up encryption. Marking the confirm field](images/04_Notification_en.png)
If you omit this here as well, you will get a last warning if you log off consciously. If no key backup is set up at the latest, encrypted calls that may have already taken place cannot be accessed later. If the tab is closed, this also corresponds to a logout.
![Query if messages should be encrypted](images/05_Logout-Notify_en.png)
Avoid this situation by setting up a key backup!
## Matrix-Login without ZIH account
A registration of accounts (as known from other matrix servers) is not possible here at the TU Dresden, because only persons with ZIH login can use the service. The TU Dresden is not a communication service provider.
For scientific cooperations with colleagues without a ZIH account there is the possibility to [apply for a ZIH guest account](https://tu-dresden.de/zih/dienste/service-katalog/zugangsvoraussetzung), which also entitles to use Matrix.
However, the federation with the Matrix servers of other scientific or civil society institutions will soon be possible (analogous to the existing e-mail federation). Example servers with which communication is already possible are:
* [TU Freiberg](https://matrix.tu-freiberg.de/) incl. [Docu](https://tu-freiberg.de/en/urz/dienste/chat)
* [TU Chemnitz](https://matrix.tu-chemnitz.de) incl. [Docu](https://www.tu-chemnitz.de/urz/groupware/chat/doku/)
* [Hochschule Darmstadt](https://chat.fbi.h-da.de) incl. [Doku](https://its.h-da.io/element-docs/)
* [Hochschule Zittau-Görlitz](https://matrix.hszg.de) incl. [Docu](https://zfe.hszg.de/das-zfe/aktuelle-entwicklungen/matrix)
* [HMT Leipzig](https://matrix.hmt-leipzig.de)
* [Uni Kiel](https://riot.fs-infmath.uni-kiel.de) incl. [Docu](https://www.fs-infmath.uni-kiel.de/wiki/Technische_Dienste)
* [Uni Hamburg](http://uni-hamburg.de/)
* [Uni Bremen](https://element.stugen.de/#/welcome)
* [TU Berlin](https://chat.tu-berlin.de/) incl. [Docu](https://www.innocampus.tu-berlin.de/projekte/matrixinnocampus/)
* [Humboldt Uni Berlin](https://element.hu-berlin.de/) incl. [Docu](https://www.digitale-lehre.hu-berlin.de/de/lehr-und-lernlandschaft/element)
* [TU München](https://matrix.tum.de) incl. [Docu](https://wiki.in.tum.de/Informatik/Helpdesk/RIOT)
* [Uni Hannover](https://matrix.uni-hannover.de) incl. [Docu](https://www.luis.uni-hannover.de/de/services/kommunikation/matrix-messenger/)
* [Uni Osnabrück](https://chat.virtuos.uni-osnabrueck.de/#/welcome) incl. [Docu](https://www.rz.uni-osnabrueck.de/homeoffice/riot.html)
* [Uni Bielefeld](https://uni-bielefeld.de/teamchat2)
* [Bauhaus-Universität Weimar](https://matrix.bau-ha.us) incl. [Docu](https://m18.uni-weimar.de/stuko/referate/digitale-infrastruktur)
* [RWTH Aachen](https://riot.comsys.rwth-aachen.de/)
* [Ruhr Universität Bochum](https://riot.rub.de/) incl. [Docu](https://www.it-services.ruhr-uni-bochum.de/services/issi/element.html.de)
* [Uni Bonn](https://element.matrix.informatik.uni-bonn.de/)
* [Uni Heidelberg](https://matrix-im.uni-heidelberg.de/) incl. [Docu](https://www.urz.uni-heidelberg.de/en/heichat)
* [Karlsruher Institut für Technologie (KIT)](https://dsn.tm.kit.edu)
* [Uni Augsburg](https://element.physik.uni-augsburg.de/#/welcome) incl. [Docu](https://www.uni-augsburg.de/de/fakultaet/mntf/physik/facilities/itservices/elequick/)
* [Uni Stuttgart](https://chat.stuvus.de/) incl. [Docu](https://wiki.stuvus.uni-stuttgart.de/display/ITKB/Matrix+Messenger)
Explizit für Studierende:
* [StudiChat](https://chat.studichat.de/#/welcome) (für alle)
* [Fachschaften](https://matrix.fachschaften.org/) (für Fachschaften)
Weitere europäische Hochschulen:
* [ETH Zürich](https://element.phys.ethz.ch/) incl. [Docu](https://readme.phys.ethz.ch/chat/)
* [Universität Innsbruck](https://chat.uibk.ac.at/) incl. [Docu](https://www.uibk.ac.at/zid/anleitungen/chat/)
* [University for Business and Technology, Kosovo](https://ubt-uni.net/)
<object data="images/federation_map.svg" type="image/svg+xml" style="width: 600px; max-width: 100%"></object>
For civil use of the Matrix protocol, here is a list of public home servers that can also be used by Kolleg:innen if their institution does not yet offer a Matrix server:
[https://www.hello-matrix.net/public_servers.php](https://www.hello-matrix.net/public_servers.php)
[https://publiclist.anchel.nl/](https://publiclist.anchel.nl/)
[https://fediverse.blog/~/FossMessenger/matrix-server](https://fediverse.blog/~/FossMessenger/matrix-server)
## Privacy policy
Privacy policy: [Link]({{< relref "privacy/_index.en.md" >}})
## Imprint
Imprint: [Link]({{< relref "imprint/_index.en.md" >}})

Binary file not shown.

After

Width:  |  Height:  |  Size: 92 KiB

BIN
docs/images/01_Find_en.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 88 KiB

BIN
docs/images/01_Leave_en.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 94 KiB

BIN
docs/images/01_Login_en.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.1 MiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 636 KiB

BIN
docs/images/01_Rooms_en.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 85 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 69 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 78 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 39 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 908 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 30 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 957 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 577 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 572 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 836 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.2 MiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.2 MiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.2 MiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 56 KiB

BIN
docs/images/02_Rooms_en.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 91 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 95 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 28 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 851 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 66 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 116 KiB

BIN
docs/images/03_Rooms_en.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 91 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 961 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 46 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 59 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 82 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 98 KiB

BIN
docs/images/04_Rooms_en.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 103 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 30 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 943 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 88 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 96 KiB

BIN
docs/images/05_Rooms_en.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 138 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 130 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 71 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 85 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 82 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 124 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 82 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 78 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 94 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 40 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 46 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 31 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 20 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 121 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 94 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 42 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 97 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 85 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 82 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 78 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 103 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 75 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 97 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 113 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 990 KiB

File diff suppressed because one or more lines are too long

After

Width:  |  Height:  |  Size: 449 KiB

File diff suppressed because one or more lines are too long

After

Width:  |  Height:  |  Size: 447 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 91 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 50 KiB

56
docs/index.md Normal file
View File

@ -0,0 +1,56 @@
---
date: 2021-07-31T19:30:00+02:00
weight: 0
authors:
- cblte
- creme
---
# Matrix at envs.net
Matrix is a free and open, secure, decentralized protocol for real-time communication, also known by the name of one of its clients, Element.
<object data="images/matrix_interactive_en.svg" type="image/svg+xml" style="width: 1280px; max-width: 100%"></object>
In recent years, the need for supporting digital tools for team collaboration has increased. A central tool is a team chat. According to Wikipedia, a chat refers to "electronic communication by means of written text in real time, usually via the Internet". ([Source](https://en.wikipedia.org/wiki/Chat)). With a messenger team members can make each other aware of current information and especially share links (*hyperlinks* / *links*) for further collaboration (e.g. for finding appointments, collaborative writing, planning events, editing data, code, mind maps,). Due to the lack of a centralized offer so far, many teams at TU Dresden have been looking for their own solutions, some of which are privacy-critical or cannot be linked to other systems.
In order to meet the demand for real-time communication, the open communication protocol Matrix was introduced in a pilot operation at the TU Dresden at the end of 2018, after a comparative analysis of several potential solution options, and presented to the CIO in April 2019. In autumn 2019, the pilot operation was transferred to regular operation. e.g. [digital](https://invidious.13ad.de/AtkA-sE-9uU) [teaching](https://invidious.13ad.de/jEvKdFTKSxU) (Videos by Prof. Lasch) with Matrix in addition to the [OPAL](https://bildungsportal.sachsen.de/opal) application.
## Topics
* [Why Matrix and no other chat system?](why/why.md)
* [How can Matrix be used? (registration and first steps)](first-steps.md)
* [Recommendations for further important settings after first login](settings/_index.en.md)
* [Installation of a client / program](clients/_index.en.md)
* [Browsersettings](clients/browser.en.md)
* [Find people and send direct messages](messaging/_index.en.md)
* [Use end-to-end encryption](encryption/_index.en.md)
* [Create rooms and take responsibility](rooms/_index.en.md)
* [Sharing rooms and making them public](rooms/sharing.en.md)
* [Find rooms](rooms/find/_index.en.md)
* [Delete and leave rooms](rooms/delete/_index.en.md)
* [Fine-tune notifications](notifications/_index.en.md)
* [Use integrations, bridges, bots (e.g. Jitsi)](integrations/_index.en.md)
* [More Clients](clients/more_clients.en.md)
* [Using communities as room filters](communities/_index.en.md)
* [Further development of Matrix](development/_index.en.md)
* [Privacy policy](privacy/_index.en.md)
* [Imprint](imprint/_index.en.md)
* [Declaration of Accessibility](accessibility/_index.en.md)
### Questions and Contact
Please address general questions to the service desk envs.net:
https://envs.net/impressum/
The ideal is to deal with problems in a transparent way, from which all others can learn. This can be done by describing the situation in the Matrix Support Room - here problems and solutions can be discussed together:
[https://matrix.to/#/#home:envs.net](https://matrix.to/#/#home:envs.net)
<span class="notice">
For some anomalies you can try to empty the cache and reload everything: Settings > Help & About > Clear Cache and reload
</span>
<span class="warning">
Current maintenance is announced in the matrix room [/TODO ADD MATRIX ROOM HERE]).
</span>

63
docs/integrations.md Normal file
View File

@ -0,0 +1,63 @@
---
title: "Integrations"
date: 2020-07-02T21:23:01+02:00
draft: false
chapter: true
weight: 80
---
# Use integrations, bridges, bots (e.g. Jitsi)
Integrations/Widgets can be managed via the room information in the upper right corner.
![Add integration button](/images/01_Widgets_en.png)
Here, for example, an etherpad, a jitsi video conference, an RSS bot, etc. can be integrated, i.e. services that are located and run on other servers. Therefore, when using integrations, the JavaScript activity of vector.im (for the integration manager) and other servers (e.g. in the Firefox addon NoScript) must be allowed. Since the widgets are often too small to use the services in their full functionality, widgets can often be opened large in new browser tabs.
In the following videos Prof. Dr. Alexander Lasch presents some possibilities for integrating widgets into matrix rooms for digital teaching:
https://invidious.13ad.de/watch?v=AtkA-sE-9uU
https://invidious.13ad.de/watch?v=D2Pq-NCaVGE
## Jitsi Videoconference
A 1:1 phone call or video within Matrix uses the direct WebRTC connection between both parties. From the 3rd person on, [Jitsi](https://de.wikipedia.org/wiki/Jitsi) is used, a free video conferencing tool (Apache license), which was installed locally at the TU Dresden in the course of the Corona crisis and the reduced availability of DFNconf: https://jitsi.tu-dresden.de
If the video conference call is started via the camera icon in the lower right corner, the Jitsi operated by the TU Dresden is automatically used. In order for Jitsi to be used for the video conference, at least three people must participate in the conference. If only two people participate in the conference, a direct connection will be established.
{{% notice warning %}}
If the jitsi integration is added via the Integration Manager, the jitsi instance of TU Dresden is not used
{{% /notice %}}
Also with Jitsi, opening the widget as a separate tab is useful to use the full functionality (e.g. screen sharing).
The use of a headset (headphone + microphone) is highly recommended to avoid feedback between sound recording and sound playback. Ideally a headset with a microphone close to the head and not just a headphone and use of the microphone hole on the laptop, which causes noise through it.
The m key mutes your microphone - with this setting you should always start a conference. The space bar switches the microphone on when muting is active (push-to-talk). Since the microphone input levels are all set differently, all hearing participants can adjust the volume of all conference participants individually. Furthermore, the individual video quality can be adjusted.
For sharing the screen contents (or specific program windows), it may be necessary to adjust the security settings of the operating system (e.g. in MacOS under System Preferences > Security > Privacy > Screen Capture).
Many thanks to Dr. Eike Dohmen ([Professorship of Magnetofluiddynamics, Measurement and Automation Technology](https://tu-dresden.de/ing/maschinenwesen/imd/mfd)) and Prof. Dr. Alexander Lasch ([Professorship of German Linguistics and History of Language](http://tu-dresden.de/gsw/slk/germanistik/gls/)) for tests and hints on the interaction of Matrix and Jitsi.
## Etherpad
The Etherpad widget can be used for collaborative writing or attaching important information to a room.
{{% notice warning %}}
For this purpose, a name must be assigned which must have less than 16 characters!
{{% /notice %}}
Etherpads have no user rights management, everyone can write and overwrite other texts (caution!). If user management is needed, better use [Nextcloud Text](https://github.com/nextcloud/text) (contact TUD cloudstore) or [CodiMD](https://md.inf.tu-dresden.de/)
## Element Matrix Services (EMS) offers Bridge for Microsoft Teams
To bringt together users from Element & MS Teams EMS offers a MS Teams Bridge, which you have to pay for:
[https://element.io/blog/ems-launches-bridging-for-microsoft-teams/](https://element.io/blog/ems-launches-bridging-for-microsoft-teams/) and [https://element.io/blog/microsoft-teams-and-slack-integration-using-matrix/](https://element.io/blog/ems-launches-bridging-for-microsoft-teams/).
## Custom widget
Any Internet pages can be integrated. For example [CodiMD](https://md.inf.tu-dresden.de/) to display LaTeX formulas.

42
docs/messaging.md Normal file
View File

@ -0,0 +1,42 @@
---
title: "Messages"
date: 2020-07-15T18:10:07+02:00
draft: false
chapter: true
weight: 30
---
## Find people and send direct messages
To write to individual persons and thus create a 1:1 chat, first click on the + in the category "Direct messages":
![Click on the Start Chat button](/images/01_Start-Chat_en.png)
Now type in the search field and start typing the email address of the person you want to find:
People who already have an account in Matrix can also be found by their display name (usually "first name last name"). Please wait 5 seconds after each last entered character until the search results are displayed. Persons who have not yet logged in can only be found via their e-mail address or their ZIH login. The link button "Show More" will display further search results. Please also note on which server your searched person is displayed.
{{% notice note %}}
Inserting e-mail addresses (e.g. via Ctrl+V) is not enough to find people! Please enter the characters of the e-mail address by hand, character by character and wait 5 seconds until the hits are displayed.
{{% /notice %}}
![Result added to the people invited to the chat](/images/99_Find-Neo_de.gif)
For the mass invitation of persons (up to 100 at once, then repeatable) the matrix names are necessary, which should be in the form @ZIH-Login:tu-dresden.de. Collect them e.g. in a text editor line by line and then paste them into the search field in Matrix/Element using the clipboard (copy & paste).
If you cannot find anyone, ask for their username or share their username (@ZIH-Login:tu-dresden.de) or https://matrix.to/#/@_Your_ZIH-Login_:tu-dresden.de, so that the person addressed can contact you within Matrix.
An invitation e-mail is not sent by Matrix.
Note that Matrix accounts may not be checked by ZIH function logins. Due to the novelty of the medium for many and the missing multi-account functionality of the Matrix client element, TU Dresden employees may prefer to use their personal ZIH login.
In the search result, click on the target person and then on Go:
![A search result for the search query entered](/images/04_Found-and-Go_en.png)
The conversation opens, which can begin after the connected person accepts the invitation [end-to-end encrypted]({{< relref "encryption" >}}) (meanwhile standard). The connection to the server at the TU Dresden is of course also transport-encrypted. If you explicitly do not want end-to-end encryption for a special reason, an unencrypted room and invite the conversation partners to it.
Further: [formatting messages]({{< relref "formatting.en.md" >}})
A room with itself is also possible and can be used as clipboard / notebook and for tests, e.g. whether formatting and hyperlinks look correct.

BIN
docs/messaging/.DS_Store vendored Normal file

Binary file not shown.

View File

@ -0,0 +1,49 @@
---
title: "Format messages"
date: 2020-07-15T18:05:37+02:00
draft: false
chapter: true
weight: 30
---
## Write and read messages
Messages can be sent with the **Enter key**. For a line break press Shift + Enter.
![Explanation of the symbols in the text input line](/images/01_Textformatting_en.png)
**files** (also images) can be sent up to a size of 10MB. For this purpose the paper clip must be selected. The sidebar with the document symbol shows the files within a room. Larger files can be shared via the [cloudstore of TU Dresden](https://cloudstore.zih.tu-dresden.de) and a share link.
Using text formatted in the markup language [**MarkDown**](https://de.wikipedia.org/wiki/Markdown), messages can also be formatted in Matrix Element. Here are some examples:
| result | to type |
|:------------------------------------------------------------------------------- |:-------------------------------------------------------------------------------------:|
| **Bold** | ```**Bold**``` |
| *Italic* | ```_Italic_``` |
| \| quote | ```> quote``` |
| **Heading 1** | ```# Heading 1``` |
| Heading 2 | ```## Heading 2``` |
| [Matrix Help](https://doc.matrix.tu-dresden.de/) | ```[Matrix Help](https://doc.matrix.tu-dresden.de/)``` |
| ![TUD](https://tu-dresden.de/++theme++tud.theme.webcms2/img/tud-logo-white.svg) | ```![TUD](https://tu-dresden.de/++theme++tud.theme.webcms2/img/tud-logo-white.svg)``` |
| list entries | ```* list entry```<br/>```* list entry```<br/>```* list entry```<br/> |
| numbered lists | ```1. numbered list```<br/>```2. numbered list```<br/>```3. numbered list```<br/> |
The current [MarkDown specification can be found here](https://spec.commonmark.org/current/).
The input of LaTeX formulas is currently not supported, but has already been requested: https://github.com/vector-im/element-web/issues/1945
Alternatively, an integration can be used to create a CodiMD (e.g. at https://md.inf.tu-dresden.de/), in which LaTeX can be used.
**Hashtags** can be used to make terms easier to find in the search.
**Smileys** can be reached with a starting colon ":"
![Opened Emoji menu](/images/14_Direktnachricht14.webp)
If there are more unread messages in a room than the screen can display, clicking on the icon to the right of the central content with a triangle pointing up and a dot pointing up will make you jump to the oldest unread message.
![Mark the jump to the last unread message button](/images/18_Sprung_hoch.webp)
Similarly, you can jump to the latest timestamp of a conversation by clicking on the triangle at the bottom of a circle on the right edge of the central content page.
![Marking of the button jumping to the newest message](/images/18_Sprung_nach_unten.webp)
A theme-based presentation (also called "threading") that is similarly good as [Zulip](https://en.wikipedia.org/wiki/Zulip) (by themes in each room/group/stream/channel) or in other programs by using a 3rd column does not exist with Matrix/Element, but is available as a wish: https://github.com/vector-im/element-web/issues/2349

25
docs/messaging/search.md Normal file
View File

@ -0,0 +1,25 @@
---
title: "Message search"
date: 2021-03-02T11:42:35+01:00
draft: false
chapter: true
weight: 40
---
## Message search
It is not uncommon to want to search for older conversation content. To search the
message history in a room (or in all rooms) for a certain text, you will find the text,
you can find the "Search" button in the upper right corner of the Element app. "Search"
button.
![Display of the position of the function button for the search](/images/message-search_en.png)
Searching for messages is possible in unencrypted rooms without any problem, since Element
has access to all messages. The situation is different in encrypted rooms. This function
is only possible using the desktop client (see [Clients / Installation]({{< relref
"clients" >}})), because the messages must be cached for the search. The message search
must be explicitly enabled under `Settings` -> `Security & Privacy` -> `Message search`.
Afterwards, searching is also possible in encrypted rooms.
![Settings section for enabling message search](/images/message-search-active_en.png)

35
docs/notifications.md Normal file
View File

@ -0,0 +1,35 @@
---
title: "Notifications"
date: 2020-07-03T13:45:15+02:00
draft: false
chapter: true
weight: 38
---
## Fine-tune notifications
You have to be able to do your work and not be disturbed by Matrix. In times of digital distraction, we all need to learn how notifications should be adapted step by step in a meaningful way.
*Scenario 1:*
If you are writing a proposal for a research project and the deadline is approaching, you may want to be notified when your colleagues want to start a discussion with you. Notifications in this room are intended to draw attention and will be set accordingly...
*Scenario 2:*
If you are in a room whose main purpose is to inform yourself about new scientific papers and other interesting things from time to time, you may want to turn off the notifications and remind yourself to enter the room from time to time, or you may want to be notified aloud only when your name is mentioned in the discussion.
### Global settings
**Settings > Notifications**
Here experiences must be made if necessary, which help with the estimate, which notifications one really needs promptly and when a back-and-forth-looking is sufficient.
See [recommendations for first steps after first login]({{< ref "settings" >}})
![screenshot of the menu to select when to send notifications](/images/notifications2.webp)
### Roomwise settings
When the mouse is moved over individual rooms in the room list, 3 grey dots appear on the right-hand edge for each room. After clicking on them, you can set up the notifications for each room individually.
![Screenshot of the notification options in the room settings](/images/notification-rooms.webp)

15
docs/rooms.md Normal file
View File

@ -0,0 +1,15 @@
---
title: "Rooms"
date: 2020-07-02T21:23:14+02:00
chapter: true
draft: false
weight: 35
---
# Rooms
Conversations are organized in matrix in rooms. 1:1 conversations are also rooms, but for now with only two people. In this
Category is about
1. [create rooms]({{< relref "rooms/create" >}})
2. [find rooms]({{< relref "rooms/find" >}})
3. [delete rooms]({{< relref "rooms/delete" >}})
4. [share rooms]({{< relref "rooms/sharing" >}})

BIN
docs/rooms/.DS_Store vendored Normal file

Binary file not shown.

53
docs/rooms/create.md Normal file
View File

@ -0,0 +1,53 @@
---
title: "Create rooms"
date: 2020-07-02T21:23:14+02:00
chapter: true
draft: false
weight: 10
---
## Create rooms and take responsibility
New rooms are created using the + in the left bar in the category Rooms.
![Marking of the room add button](/images/01_Rooms_en.png)
Then the room name must be assigned. You can also optionally assign a theme (which can be adapted more often later). Optionally, the room can be made publicly accessible (this is not the default setting). With an additional click on "Show more settings" it can be prevented that Matrix users from outside the TU Dresden home server (Homeserver) can enter the room. By default, all new rooms (just like all new 1:1 calls) have [end-to-end encryption]({{< relref "encryption" >}}) set up. If this is not desired (e.g. because verification of the participants becomes very impractical in very large rooms) you can use the slider before creating the room to not activate end-to-end encryption.
![Input menu for the room name](/images/02_Rooms_en.png)
The room is now created and gets any colored icon color. By clicking on the i in the upper right corner and then the gear wheel "room settings" you can access exactly those room settings:
![Marking of the room settings button for the newly created room](/images/03_Rooms_en.png)
Here you can upload a room-specific image/icon in the **General** tab. An important feature is the assignment of a local room address. This address is easier to read by humans than the cryptic room address, which is always present in parallel (you can see it in the tab Advanced). The assigned local room address can then easily be distributed in public or to the target group and has the following structure:
#roomaddress:tu-dresden.de
Another important setting here is whether the room should appear in the room directory of the TU Dresden. You can also activate the URL preview for the room here.
![Room settings](/images/04_Rooms_en.png)
In the **Security & Privacy** tab, room administrators have to make important decisions: Should the room be encrypted? Who is allowed access? And who can read the chat history?
![Security settings for the newly created room](/images/05_Rooms_en.png)
**To explain the room access options:**
1. "Only people who have been invited": These are closed rooms. Access at the moment only by explicit invitation by moderator:inside or administrator:inside
2) "Everyone who knows the room link (except guests)": This is a public room, but you can only read it if you enter it (and thus become visible to all room members). Here you can see exactly who is in the room and when, and if necessary you can kick and ban people who should not be in the room...
3. "Everyone who knows the room link (including guests)": This is a public room, and everyone can read it. All over the world. And room members will never know who read it and when. So this is like a website where everyone can take notes. This setting often goes along with the option that "everyone" can read the chat history.
A "call waiting" to closed rooms is not yet possible. The closest workaround is to send a direct message to the room administrator, who will then invite you.
{{% notice note %}}
The end-to-end encryption of large or public spaces is critical in terms of the difficult verification for many people. See [Use end-to-end encryption]({{< relref "encryption" >}}).
{{% /notice %}}
{{% notice warning %}}
As the room administrator, you have **responsibility** for the content shared in the room (e.g. false messages, hate mail, etc.). Include other people in this responsibility by assigning roles in the right bar (after clicking on the person icon) via the "Permission Level" drop-down menu, e.g. Administrator:inside or Moderator:inside.
{{% /notice %}}
![Drop-down menu for the assignment of rights for room participants (image row 1)](/images/06_Users-Permissions-1_en.png)
![Drop-down menu for the assignment of rights for room participants (image series 2)](/images/06_Users-Permissions-2_en.png)
You can also use the admin tools to react to any misbehavior (mute, kick, ban, delete recent messages).

17
docs/rooms/delete.md Normal file
View File

@ -0,0 +1,17 @@
---
title: "Delete rooms"
date: 2020-07-02T21:23:14+02:00
chapter: true
draft: false
weight: 30
---
## Delete rooms and leave rooms
When leaving rooms, they no longer appear in the room list (left column). If the last person in the room leaves the room, the room is still in the archive for 7 days, but is then permanently deleted.
![Room settings with the selection Leave](/images/01_Leave_en.png)
As administrator:in, all room members should first be "kicked" (removed from the room), then the person is the last to leave the room and thus initiates the later deletion by the server.
An export of the room history e.g. into a .txt or .html file is not yet possible: https://github.com/vector-im/element-web/issues/2630

16
docs/rooms/find.md Normal file
View File

@ -0,0 +1,16 @@
---
title: "find rooms"
date: 2020-07-02T21:23:14+02:00
chapter: true
draft: false
weight: 20
---
## Find rooms
The room directory, in which the publicly accessible rooms are presented, can be reached via the button "Discover / Explore" in the upper left corner under the own display name. Here you can immediately search for a room on the TUD-Matrix.
![Menu to find public rooms](/images/01_Find_en.png)
{{% notice note %}}
The global federation is currently in test operation. It is possible that the Federation will be restricted again at a later date.
{{% /notice %}}

65
docs/rooms/sharing.md Normal file
View File

@ -0,0 +1,65 @@
---
title: "Share rooms"
date: 2020-07-02T21:23:14+02:00
chapter: true
draft: false
weight: 40
---
# Share rooms and make them public
{{% notice warning %}}
The share icon in the upper right corner of each room also provides a link, a QR code and various social networks. The link, however, leads to https://matrix.to/ from where you can access the room via an Element web app from https://element.io. In order to share a room within TU Dresden please use the methode explained in this artice.
{{% /notice %}}
Every room has a so-called room-address, which can be found in the room settings under the sub-menu Advanced. A room address looks like this:
!aen6iekahv8Pi0zohf:tu-dresden.de
Because this cryptic address can not be read easily by humans, custom room addresses can be assigned. This is only necessary for rooms, which you want to make public and reference in other places.
Room addresses can either be globally published addresses (findable by users in other servers - useful for topics beyond the TU Dresden) or local addresses, which is only valid within the matrix home server at the TU Dresden.
{{% notice note %}}
To publish a global address, you have to create a local address first. **It is necessary to create a local address in both cases!**
{{% /notice %}}
For the more common case of the desired local address, click on "Show more" under Local Addresses in the room settings under the General tab:
![Room settings with the show more selected](/images/01_Sharing_en.png)
Afterwards a recognizable name of this room link can be assigned in the "Room alias" line (no spaces are allowed!):
![Room settings with the local addresses selected](/images/02_Sharing_en.png)
You can also assign different addresses. If the room address should be published in the room directory of the matrix home server of the TU Dresden, this can be done by the following.
![room settings with the public room address selected](/images/03_Sharing_en.png)
The room address then has the following structure
#Room-address-name:tu-dresden.de
**Suggestion Nr. 1 for sharing a room address:**
When you want to share a room within matrix, you can use the internal link feature by typing (the first characters of) the local address
```
#room_address:tu-dresden.de
```
into the chat line. If you are a member of that room, you can confirm the auto-completion with a mouse click. This is a special link for a usage within matrix, which will open directly in the client of the receiver (with a mouse click).
**Suggestion Nr. 2 for sharing a room address:**
The share icon at the top right of each room also offers a matrix.to-link, as well as a QR code and various social networks. The matrix.to-link leads to a page where you can select how the link should be opened. For example, the installed client Element Desktop can be used, or it can be selected via which home server the room is to be entered.
![share icon marked in the chat view of the room](/images/04_Sharing-Button_en.png)
```
https://matrix.to/#/#Room-address-name:tu-dresden.de?via=tu-dresden.de
```
**Suggestion Nr. 3 for sharing a room address:**
Furthermore, you also can create a hyperlink to the room, which you have to construct in this way:
https://matrix.tu-dresden.de/#/room/#roomaddress:tu-dresden.de
resulting in an internet address (URL) which can be easily distributed to the public or target group. BUT, **this link opens only an Element Web in the browser** of the people, not in an installed Element Desktop. More universal (espc. for the large group of people with Element Desktop), and more advised by the Matrix-Admin-Team, is the above mentioned method with the matrix.to-Link.

85
docs/settings.md Normal file
View File

@ -0,0 +1,85 @@
---
date: 2021-07-31T19:30:00+02:00
weight: 2
authors:
- cblte
- creme
---
# Recommendations for steps after the first login
## Convenient use of end-to-end encryption (E2EE)
Matrix not only encrypts transports to and from the home server (in the data center of TU Dresden) but also allows the use of end-to-end encryption (E2EE). For this, cryptographic keys have to be exchanged between all devices that want to write end-to-end encrypted. This technical necessity sounds and is complicated, but in the meantime it has become very convenient for the users. The many cryptographic keys created by the client are stored on the respective device. If this is a tab in a browser, for example, there is a risk that this tab will be closed unintentionally. Then all encrypted contents are no longer readable. To prevent this from happening, a key protection is offered on the home server of the TU Dresden, on which (protected with a security phrase (or security key that can be calculated from it) all cryptographic keys are stored encrypted.
{{% notice warning %}}
It is highly recommended to use this key backup (with a secure security phrase which is NOT your ZIH password) and read on at [Other important settings]({{< relref "_index.en.md#other-important-settings" >}})!
{{% /notice %}}
![Screenshot of the prompt to enter a security phrase](/images/01_Restore-Session_en.png)
If you skip this now, the next screen would look like this:
![Confirmation of skipping the input of a security phrase](/images/03_Cancel-Restore_en.png)
Key protection is highly recommended for worry-free end-to-end encryption. For this reason, a smaller tooltip will prompt you to set up the encryption even after you skip further:
![Chat view showing a tooltip to set up encryption. Marking the confirm field](/images/04_Notification_en.png)
If you omit this here as well, you will get a last warning if you log off consciously. If no key backup is set up at the latest, encrypted calls that may have already taken place cannot be accessed later. If the tab is closed, this also corresponds to a logout.
![Query if messages should be encrypted](/images/05_Logout-Notify_en.png)
## Other important settings
After successfully setting up the key backup, you now activate the desktop notifications:
![Screenshot of the query to activate push-benarchitecture](/images/06_Enable-Notifications_en.png)
This can be undone later and especially individual "conversations" can be set in their notification authority
Adjust settings in the Settings menu: to do this, click on the line of the e-mail address and the downward pointing triangle and then on the line "All settings":
![Selection of the menu item Settings in the user:inside menu](/images/06_Settings_en.png)
In the settings you can change your display name ("First Name Last Name") in the **General** tab if necessary and upload a profile picture (similar to the contact box on the TUD website; select profile picture <5MB):
![Marking of the field Display name and profile picture in the settings](/images/06_Settings-Names_en.png)
In the medium term the display name will be obtained from the Common Name in the LDAP of the TU Dresden, then a manual change is no longer necessary.
The e-mail address field is not necessarily to be filled in, since an e-mail address is stored via your ZIH login. Theoretically you can add more addresses here, e.g. to have notifications about missed messages sent to another e-mail address.
On the same page you can also change the design theme from light to dark.
In the **Notifications** tab you can activate e-mail notifications (to be informed about missed messages) as well as acoustic notifications and set them granularly for individual activities of others. For more information see the [notifications]({{< relref "notifications" >}}).
![Screenshot of the notification settings with a marker of the switched off e-mail notifications](/images/06_Settings-EMailNotify_en.png)
In the **Voice & Video** tab, you can authorize the Matrix client element to use your media (camera + microphone), allow direct voice/video calls via peer-to-peer connections, and in the case of video calls, to see yourself in a small picture:
![Screenshot of the settings menu language and video](/images/06_Settings-Media_en.png)
Fortunately, 1:1 calls start end-to-end encrypted by default. To really trust this encryption with a good feeling, users:inside can perform the key comparison with interlocutor:inside. To ensure that this also applies to all devices of these conversational partners, Matrix users must in turn verify the keys of all their devices with each other (technical term: cross-signing). If you follow the instructions below, this can be done very conveniently.
## Security & Privacy
In the **Security & Privacy** tab you will find all your devices that have been used by the Matrix account so far.
* Remove any sessions that are no longer in use by marking the square box at the end of the line and clicking on the red button that appears.
![Screenshot of the menu for deleting active sessions](/images/09_Delete-Sessions_en.png)
* The device names also give you an overview when comparing keys between your devices.
* The public names of your devices which can be assigned here (by clicking on them with the mouse) can also be viewed by your conversation partner:inside. This helps if they want to compare the cryptographic keys of your devices (e.g. laptop + cell phone) and can easily identify the device names.
* The many cryptographic keys are stored on the respective device. If this is e.g. a tab in a browser, there is a risk that this tab will be closed unintentionally. Then all encrypted contents are no longer readable. To prevent this from happening, a key protection is offered on the home server of the TU Dresden, on which (protected by a passphrase) all cryptographic keys are stored encrypted. It is strongly recommended to use this key backup!
![Screenshot of the menu item for key protection](/images/10_Setup-Keystore_en.png)
## Secure Backup
If not set up after initial registration: The **Secure Backup** is a valuable achievement, as it enables the keys of all end-to-end encrypted calls to be centrally secured on the TU Dresden server with a password. This allows convenient use of multiple devices or matrix clients. To do so, click on "Start using key backup" and choose a strong security phrase (but not the ZIH password). This security phrase will always have to be entered if keys are to be synchronized with the key backup.
![Prompt to generate the security key or enter a security phrase](/images/11_Setup-Key_en.png)
![Prompt to enter a password for the key backup](/images/12_Enter-Key_en.png)
Alternatively, instead of the security phrase, you can also have a security key generated that serves the same purpose as the security phrase. Furthermore, the security key is generated in addition to the security phrase and should be kept safe and retrievable as an emergency key (e.g. save it as .txt file or print it out)
![Display of the security key to write or save away](/images/13_Present-Key_en.png)

33
docs/why.md Normal file
View File

@ -0,0 +1,33 @@
---
date: 2021-07-31T19:30:00+02:00
weight: 1
authors:
- cblte
- creme
---
# Why matrix as a chat system?
There are many services and programs for instant electronic communication. Matrix was chosen because it has the following characteristics:
- Open standard (no technical dead end)
- Communication protocol for federated real-time communication (no isolated solution but like e-mail with worldwide connectivity)
- Differentiated communication possible (1:1, multiple teams, topic-specific)
- Decentralized, persistent and interoperable communication (no central control instances, connectable with other protocols and tools)
- Data protection: end-to-end encryption standard in 1:1 conversations and (group) rooms, can be switched off in the latter
- Web application + desktop client + mobile apps available
- The contacts on your own cell phone are not automatically passed on to third parties (no address book upload)
- Connection to existing authentication systems (e.g. TU Dresden)
- Existing successful security audit
- Autonomy and control: locally installable (server location TU Dresden)
- Recognize the presence status
- Active further development
- Up-and-coming use by other scientific institutions (e.g. lots of German universities)
Further informationen: https://matrix.org/faq/#intro
Detailed explanation of technical terms: https://matrix.org/faq/#definitions
Institutions of higher education (e.g. universities) with a Matrix service:
<object data="../images/federation_map.svg" type="image/svg+xml" style="width: 600px; max-width: 100%"></object>

View File

@ -3,7 +3,28 @@ site_description: envs.net | matrix help
repo_name: <i class="fa fa-github" aria-hidden="true"></i> edit on gitea
repo_url: https://git.envs.net/envs/matrix-doc
theme: cyborg
#theme: cyborg
theme: readthedocs
nav:
- matrix at envs: index.md
- Home: index.md
- Why: why.md
- First Steps: first-steps.md
- Important Settings: settings.md
- Clients / Instalation: clients.md
- Messages: messaging.md
- Rooms: rooms.md
- Notifications: notifications.md
- Communities: communities.md
- Encryption: encryption.md
- Integrations: integrations.md
- FAQ: faq.md
- Development: development.md
markdown_extensions:
- toc:
permalink: "#"
baselevel: 1
separator: "_"