diff --git a/config/_default/config.yaml b/config/_default/config.yaml index 3295d85..f300538 100644 --- a/config/_default/config.yaml +++ b/config/_default/config.yaml @@ -6,6 +6,7 @@ theme: learn defaultContentLanguage: fr defaultContentLanguageInSubdir: true +enableEmoji: true removePathAccents: true outputs: home: ["HTML", "RSS", "JSON"] diff --git a/content/en/matrix/_index.md b/content/en/matrix/_index.md index 5077f7e..1635279 100644 --- a/content/en/matrix/_index.md +++ b/content/en/matrix/_index.md @@ -1,6 +1,5 @@ --- title: "Matrix Documentation" -date: 2020-08-02T21:26:25+02:00 chapter: true draft: false --- @@ -10,3 +9,14 @@ draft: false [Matrix](https://matrix.org) is a free and open, secure, decentralized protocol for real-time communication, also known by the name of one of its clients - [Element](https://element.io). + +## What is Matrix? + +{{< youtube jr2mXSKq3B4 >}} + +## Why provide Matrix to open science enthusiasts? + +## Our long-term goal + +In the future, we hope Canada could be connected at least as much as Germany in +terms of Matrix servers. diff --git a/content/en/matrix/clients/_index.md b/content/en/matrix/clients/_index.md new file mode 100644 index 0000000..ce84f5a --- /dev/null +++ b/content/en/matrix/clients/_index.md @@ -0,0 +1,72 @@ +--- +title: "Clients / Installation" +date: 2020-07-02T21:22:27+02:00 +draft: false +chapter: true +weight: 15 +--- + +# Installation of a client / program + +To connect to the Matrix federation, you will use a client. The recommended +client for using Matrix is called Element[^1] and it is free to use. Element is +the official client developped by the Matrix core team and the only one we +officially support. It can be used on different systems and devices: + +1. **Element Web:** + [The browser web application provided by the OSUM team](#web-app) +1. **Element Desktop:** [Downloads for Linux/Windows/Mac](#desktop-app) +1. **Element mobile:** [Android/iOS](#mobile-app) + +![Element page for client download](get-element.png) + +## Element Web {#web-app} + +The easiest way is to use Matrix is to open the Element Web application directly +in your favorite modern browser (for example +[Mozilla Firefox](https://www.mozilla.org/firefox/)). + +Web-App: +{{% button href="https://chat.openscience.ca" icon="fas fa-globe" %}}chat.openscience.ca{{% /button %}} + +Further information can be found in the section ["Element Web +(Browser)"]({{< ref "matrix/clients/browser" >}} "Element Web (Browser)"). + +## Element Desktop {#desktop-app} + +We recommended that you install Element on your own computer for practicality +purposes. You will have access to your conversations without having to open a +browser (however, you will have to update Element from time to time, like any +other program). + +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 information can be found in the submenu ["Element +Desktop"]({{< ref "desktop.md" >}} "Element Desktop"). + +## Element Mobile {#mobile-app} + +To have access to Matrix anywhere you go, you can install the Element Mobile +client on your smartphone. + + +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-Droid){{% /button %}} + +Further information can be found in the submenu ["Element +Mobile"]({{< ref "mobile" >}} "Element Mobile"). + +## Other clients + +If you are familiar with such technologies, you may be tempted to use one of the +[many clients](https://matrix.org/clients/) developped by the community. Note +that we will probably not be able to help you if you encounter bugs on other +clients than Element. Refer to the [Other +clients]({{% relref "more_clients" %}}) section for more information. + +[^1]: Element was formerly known as Riot.im before it became Element. diff --git a/content/en/matrix/clients/browser.md b/content/en/matrix/clients/browser.md new file mode 100644 index 0000000..eb15514 --- /dev/null +++ b/content/en/matrix/clients/browser.md @@ -0,0 +1,85 @@ +--- +menutitle: "Element Web (Browser)" +title: Using our Element Web client +draft: false +weight: 10 +--- + +In order to use our Element Web client, you have to go +[https://chat.openscience.ca](https://chat.openscience.ca). + +{{% notice info %}} The first time you use our service, you will have to +register by clicking on +"[Create Account](https://chat.openscience.ca/#/register)" on the chat homepage +[https://chat.openscience.ca](https://chat.openscience.ca) unless you have +already registered with another matrix server and know how to join our server +through the federation. + +If you require help during the registration process, refer to the [First +steps]({{% ref "matrix/first-steps" %}}) section. + +{{% /notice %}} + +If you are registered, you can skip the registration process section and read +the [Sign in section below](#sign-in) to make sure to use your existing account +**on our server** and not create a new account on another server like +matrix.org. + +## Register using the Element Web App + +1. Open the Element Web App @ ; +1. Click on the green _Create Account_ button; +1. Fill in the form. + - Choose your username carefully since it is not possible to change it. We + recommend using your `FirstLastname` but you are free to pick any username + that complies with our Code of Conduct. + - Analogous to e-mail addresses, this results in matrix addresses with the + following structure: `@USERNAME:openscience.ca` + - E-mail address are mandatory on our server, this is to ensure you can reset + your password at anytime. +1. Click on the _Register_ button. +1. Voilà, you should now be signed in to the Matrix 🌐! + +## Sign in + +1. Click on the blue _Sign in_ button. +1. The default option is to enter your _Username_, but you can change the + _Username_ option for the email address you signed up with via the drop-down + menu "_Sign in with:_". We recommend leaving it to the default option, namely + _Username_. +1. Enter your username and password +1. Click on _Sign In_ +1. You are now signed in, congratulations! :tada: + +{{% notice warning %}} If you want to immediately start using another [Matrix +Client]({{< relref "../clients" >}}) instead of the Element Web client installed +at chat.openscience.ca, it is important to change the home server from the +default matrix.org server to https://matrix.openscience.ca {{% /notice %}} + +## 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://ofaolain.com/blog/2018/04/23/tracker-blocking-with-noscript-and-privacy-badger/) +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) + + + +### Cookies + +You may also want to allow cookies from the 2 sites below for a smoother +experience. + +- openscience.ca +- vector.im (for the integration and app manager) diff --git a/content/en/matrix/clients/desktop.md b/content/en/matrix/clients/desktop.md new file mode 100644 index 0000000..1c66b77 --- /dev/null +++ b/content/en/matrix/clients/desktop.md @@ -0,0 +1,64 @@ +--- +title: "Element Desktop" +draft: false +weight: 20 +--- + +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 %}} + +{{% notice info %}} After installing the Element Desktop client, you will have +to register if you have not registered yet. As said in the previous sections, +the first time you use our service, you have to register unless you have already +registered with another matrix server and know how to join our server through +the federation. + +If you require help during the registration process, refer to the [First +steps]({{% ref "matrix/first-steps" %}}) section. + +{{% /notice %}} + +If you are registered, you can skip the registration process section and read +the [Sign in section below](#sign-in) to make sure to use your existing account +**on our server** and not create a new account on another server like +matrix.org. + +### Registration process through the Element App + +1. Open the Element Desktop App; +1. Click on the green _Create Account_ button; +1. Click on **Change** and enter the custom homeserver: + `https://matrix.openscience.ca` +1. Fill in the form. Choose your username carefully since it is not possible to + change it. We recommend using your `FirstLastname` but you are free to pick + any username that complies with our Code of Conduct. + - Analogous to e-mail addresses, this results in matrix addresses with the + following structure: `@USERNAME:openscience.ca` + - E-mail address are mandatory on our server, this is to ensure you can reset + your password at anytime. +1. Click on the _Register_ button. +1. Voilà, you should now be signed in to the Matrix 🌐! + +### Sign in + +1. Click on the blue _Sign in_ button; +1. To not accidentally end up on the wrong server (matrix.org), click on + **Change** and manually specify the home server: + `https://matrix.openscience.ca`; +1. Click Next and enter your credentials. The default option is to enter your + _Username_, but you can change the _Username_ option for the email address + you signed up with via the drop-down menu "_Sign in with:_". We recommend + leaving it to the default option, namely _Username_. +1. Enter your username and password +1. Click on _Sign In_ +1. You are now signed in, congratulations! :tada: +1. By activating the slider under Settings > Settings > "**Automatic start after + system login**", the Element client will start after every reboot and you + will no longer miss any notifications due to accidentally closing the browser + tab. + +{{% notice tip %}} There are many useful, additional settings and +recommendations described in the [Settings]({{% relref "../settings" %}}) +section that will make you life easier :smile: {{% /notice %}} diff --git a/content/en/matrix/clients/get-element.png b/content/en/matrix/clients/get-element.png new file mode 100644 index 0000000..676031c Binary files /dev/null and b/content/en/matrix/clients/get-element.png differ diff --git a/content/en/matrix/clients/mobile.md b/content/en/matrix/clients/mobile.md new file mode 100644 index 0000000..d821927 --- /dev/null +++ b/content/en/matrix/clients/mobile.md @@ -0,0 +1,60 @@ +--- +title: "Element Mobile" +draft: false +chapter: false +weight: 30 +--- + + +Download the Element app for your platform: +{{% 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-Droid){{% /button %}} + +{{% notice info %}} After installing the Element Mobile client, you will have to +register if you have not registered yet. As said in the previous sections, the +first time you use our service, you have to register unless you have already +registered with another matrix server and know how to join our server through +the federation. + +If you require help during the registration process, refer to the [First +steps]({{% ref "matrix/first-steps" %}}) section. + +{{% /notice %}} + +If you are registered, you can skip the registration process section and read +the [Sign in section below](#sign-in) to make sure to use your existing account +**on our server** and not create a new account on another server like +matrix.org. + +## Registration process through the Element Mobile App + +1. Open the Element Mobile App; +1. Click on the green _Create Account_ button; +1. Click on **Change** and enter the custom homeserver: + `https://matrix.openscience.ca` +1. Fill in the form. Choose your username carefully since it is not possible to + change it. We recommend using your `FirstLastname` but you are free to pick + any username that complies with our Code of Conduct. + - Analogous to e-mail addresses, this results in matrix addresses with the + following structure: `@USERNAME:openscience.ca` + - E-mail address are mandatory on our server, this is to ensure you can reset + your password at anytime. +1. Click on the _Register_ button. +1. Voilà, you should now be signed in to the Matrix 🌐! + +## Sign in + +1. Open the Element Mobile App +1. Click on _Get Started_ +1. Choose _Other - Custom & advanced settings_ + - This ensures you do not accidentally end up on the wrong server + (matrix.org). +1. Set the address server to: `https://matrix.openscience.ca` and click on + _Continue_. +1. Enter your credentials. The default option is to enter your _Username_, but + you can change the _Username_ option for the email address you signed up with + via the drop-down menu "_Sign in with:_". We recommend leaving it to the + default option, namely _Username_. +1. Click on _Sign In_ +1. You are now signed in, congratulations! :tada: diff --git a/content/en/matrix/clients/more_clients.md b/content/en/matrix/clients/more_clients.md new file mode 100644 index 0000000..f281373 --- /dev/null +++ b/content/en/matrix/clients/more_clients.md @@ -0,0 +1,16 @@ +--- +title: "Other clients" +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: + +If you want to connect to our server, make sure to use our server: +`https://matrix.openscience.ca`. + +- https://matrix.org/docs/projects/clients-matrix +- https://matrix.org/docs/projects/try-matrix-now diff --git a/content/en/matrix/development/_index.md b/content/en/matrix/development/_index.md new file mode 100644 index 0000000..d11c715 --- /dev/null +++ b/content/en/matrix/development/_index.md @@ -0,0 +1,34 @@ +--- +title: "Development" +draft: false +chapter: true +weight: 200 +--- + +# Further development of Matrix + +We, [Open Science UMontreal](https://osumontreal.ca), does not pay for the +source code but we do pay for the server to host our Matrix instance and put a +lot of volunteer work into maintaining the server and the documentation. + +Matrix is an open standard, which all the details of interoperable communication +using the matrix set of HTTP-APIs are freely published online. 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](/img/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. + +We, the maintainers of this server, are in contact with the Matrix/Element +developers and try to occasionally contribute to the Matrix ecosystem by means +of testing, commenting, opening issues, etc. to help with the development of all +Matrix-related tools. + +{{% notice info %}} If you interested in helping with the maintance or develop +new things, we want to hear from you @ matrix@openscience.ca. {{% /notice %}} + +--- diff --git a/content/en/matrix/encryption/_index.md b/content/en/matrix/encryption/_index.md new file mode 100644 index 0000000..d54a04d --- /dev/null +++ b/content/en/matrix/encryption/_index.md @@ -0,0 +1,33 @@ +--- +title: "Encryption" +draft: false +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 "matrix/settings" >}})) + +The decision whether a 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 will 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. + +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): + +To do this, move the Encrypted slider on the Security & Privacy tab: + +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 "matrix/settings" >}})) to be able to read earlier messages or +one sent when your clients are closed. + +A detailed description of the topic can be found in this +[in this Matrix blog article](https://blog.riot.im/e2e-encryption-by-default-cross-signing-is-here). diff --git a/content/en/matrix/faq/_index.md b/content/en/matrix/faq/_index.md new file mode 100644 index 0000000..f425f05 --- /dev/null +++ b/content/en/matrix/faq/_index.md @@ -0,0 +1,198 @@ +--- +menutitle: "FAQ" +title: "Frequently asked questions" +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 support room +`#support:openscience.ca`. Beware that it is community support, so you may not +get a reply immediately. + +{{% expand "Messages 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 "matrix/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. {{% /expand %}} + +--- + +{{% expand "What is the difference between passphrase and recovery key?" %}} 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. +{{% /expand %}} + +--- + +{{% expand "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? " %}} +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. {{% /expand %}} + +--- + +{{% expand "How to tell people a room address with Element Desktop Client?" %}} +You can see the public address when you click on the `I` (ℹ️) icon in the top +right corner. It will open a sidebar and display the address below the picture +and the name (`#room:openscience.ca`). To get the link for a direct access from +outside Matrix, click on "Share room" and you will see a link starting with +`https://matrix.to...`. + +{{% /expand %}} + +--- + +{{% expand "Can I write LaTeX formulas?" %}} It is an experimental feature as of +the time of updating this page. It will be available for everybody in the near +future. You can get the latest update from this +[issue](https://github.com/vector-im/element-web/issues/1945). {{% /expand %}} + +--- + +{{% expand "Is there something like threading (like in Mattermost/Slack) in Matrix?" %}} +No, threads like in Mattermost or Slack are currently not available in Matrix. +The developers of Element are working hard to implement such functionality in +the near future. In the meantime, you can hit the `reply` (↩️) button when you +hover a message to keep conversations tidy. To get more information, follow +their [roadmap](https://github.com/vector-im/roadmap/projects/1). +{{% /expand %}} + +--- + +{{% expand "I do not have a security key (recovery key)" %}} To do this, please +check whether this has been set up first. See [Secure +backup]({{< relref "matrix/settings/#secure-backup" >}}) {{% /expand %}} + +--- + +{{% expand "How do I change the passphrase for my backup key?" %}} + +- 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 "matrix/settings/#secure-backup" >}}) {{% /expand %}} + +--- + +{{% expand "How do I reset the secure backup if I have lost my security phrase AND my (saved and printed) security key?" %}} +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 "matrix/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 "matrix/settings/#secure-backup" >}}) {{% /expand %}} + +--- + +{{% expand "How can I, as the administrator, delete many messages at once?" %}} +It is not possible yet, but we expect it to be in the future!{{% /expand %}} + +--- + +{{% expand "How can I mark the room as 'unread' again?" %}} As of March 2021, +this function has not been implemented yet. As a workaround, you can mark the +room as a favorite to have a quick access to it. {{% /expand %}} + +--- + +{{% expand "What should I do if video or audio in a video conference does not work on a MacOS?" %}} +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. +{{% /expand %}} + +--- + +{{% expand "How many people can be invited at ones into a room? Can I invite people by their e-mail address?" %}} +Mass invite by e-mail is currently not supported in Element. If you want to mass +invite, please send an request via the `#support:openscience.ca` room, so we can +assist. You can invite 100 people by their username yourself. {{% /expand %}} + +--- + +{{% expand "What is the 'community/communities' option?" %}} Communities were +created by Matrix to group multiple rooms together. However, major refactoring +is happening on communities, which will become _'spaces'_ in the future. Spaces +will be really powerful, we are excited to implement this feature as soon as +possible! For the time being, you can play with _Communities_ but know that it +will probably be not possible to import your _Communities_ into _Spaces_. +{{% /expand %}} + +--- + +{{% expand "Can I manage multiple Matrix-Account on my Element Desktop Client?" %}} +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 through the command line: + +```bash +element-desktop --profile PROFILE_NAME +``` + +So you can place several Element-Starters in your Autostart, with different +profile names, e.g. `--profile OSUM` or `--profile Private`. Unfortunately, both +opened windows will appear with the same Icon in the Indicator-Applet. Someone +is probably already working on a solution to this problem. + +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). {{% /expand %}} + +--- diff --git a/content/en/matrix/first-steps/_index.md b/content/en/matrix/first-steps/_index.md new file mode 100644 index 0000000..d28f012 --- /dev/null +++ b/content/en/matrix/first-steps/_index.md @@ -0,0 +1,169 @@ +--- +menutitle: First steps +title: First steps - How to use Matrix? +draft: false +weight: 2 +--- + +- [1. How to register?](#1-how-to-register) + - [Registration process through our Web App (browser)](#registration-process-through-our-web-app-browser) + - [Registration through the Element Desktop or Mobile App](#registration-through-the-element-desktop-or-mobile-app) +- [2. How to use?](#2-how-to-use) + - [How to sign in using our Web app (browser)?](#how-to-sign-in-using-our-web-app-browser) + - [Element Web client](#element-web-client) + - [Element Desktop client](#element-desktop-client) + - [Element Phone client](#element-phone-client) +- [3. Crucial information to know](#3-crucial-information-to-know) + - [Convenient use of end-to-end encryption (E2EE)](#convenient-use-of-end-to-end-encryption-e2ee) +- [4. Still have questions?](#4-still-have-questions) + +## 1. How to register? + +There are many ways to join our server. You can create an account as described +below using either a browser, a desktop app or a mobile app. For more advanced +users who already have a Matrix account on another server that is globally +federated, they can find rooms they would like to join from their server +:exploding_head:. + +Instruction to create an account from the [different client +Apps]({{% relref "/matrix/clients/_index.md" %}}) are listed below and in their +respective section of this documentation, which also includes more details +regarding the installation and usage of each app. + +- [Web App (browser)]({{% relref "/matrix/clients/browser.md" %}}) section +- [Desktop App]({{% relref "/matrix/clients/desktop.md" %}}) section +- [Mobile App]({{% relref "/matrix/clients/mobile.md" %}}) section + +{{% notice info %}} + +**When you register, keep these points in mind:** + +- **Choose your username carefully** as it is not possible to change it. We + recommend using your `FirstLastname` but you are free to pick any username + that is compliant with our Code of Conduct. +- Analogous to e-mail addresses, matrix addresses have the following structure: + `@USERNAME:openscience.ca` +- An e-mail address is mandatory to register on our server to ensure you can + reset your password at anytime. It won't be shared with anyone, we don't + directly have access to it. + +{{% /notice %}} + +### Registration process through our Web App (browser) + +The easiest way to create an account is by far through the Element Web App the +we provide: + +1. Open the Element Web App @ ; +1. Click on the green _Create Account_ button; +1. Fill in the form. +1. Click on the _Register_ button. +1. Voilà, you are now signed in to the Matrix 🌐! + +### Registration through the Element Desktop or Mobile App + +1. [Download and install the Desktop and/or Mobile + App]({{% relref "/matrix/clients/" %}}) +2. Open the Element Desktop or Mobile App; +3. Click on the green _Create Account_ button; +4. **Click on _Change_ and enter our custom homeserver: + `https://matrix.openscience.ca`** +5. Fill in the form. +6. Click on the _Register_ button. +7. Voilà, you are now signed in to the Matrix 🌐! + +## 2. How to use? + +{{% notice tip %}} We recommend using the official [Element +client]({{% relref "/matrix/clients/_index.md" %}}) as it is the official client +developped by the Matrix core team and the only one we officially support. + +{{% /notice %}} + +### How to sign in using our Web app (browser)? + +1. Open your favorite browser and go to + [https://chat.openscience.ca](https://chat.openscience.ca) +1. Click on the blue _Sign in_ button. +1. The default option is to enter your _Username_, but you can change the + _Username_ option for the email address you signed up with via the drop-down + menu "_Sign in with:_". We recommend leaving it to the default option, namely + _Username_. +1. Enter your username and password +1. Click on _Sign In_ +1. You are now signed in, congratulations! :tada: + +{{% notice tip %}} If you want to immediately start using another [Matrix +Client]({{< relref "../clients" >}}) instead of the Element Web client installed +at [chat.openscience.ca](https://chat.openscience.ca), it is important to change +the home server from the default matrix.org server to +https://matrix.openscience.ca {{% /notice %}} + +### Element Web client + +In order to use our Element Web client, you have to go +[https://chat.openscience.ca](https://chat.openscience.ca). To use the Element +Web client we provide, see the guide under [clients :right_arrow: +Browser]({{< ref "../clients/browser" >}}). + +### Element Desktop client + +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="/matrix/clients/install_linux" icon="fas fa-download" %}}Linux{{% /button %}} + +To use the Element Desktop App, see the guide under [clients :right_arrow: +Desktop]({{< ref "../clients/desktop" >}}). + +### Element Phone client + + +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-Droid){{% /button %}} + +To use the Element Mobile App, see the guide under [clients :right_arrow: +Desktop]({{< ref "../clients/mobile" >}}). + +## 3. Crucial information to know + +Because we believe in your privacy, all unpublished or private rooms (just like +all new 1:1 conversations) have [end-to-end +encryption]({{< relref "encryption" >}}) enabled by default. + +**Encryption** means scrambling a message in such a way that only those knowing +the _"secret key"_ can unscramble it. Matrix uses encryption to keep your +messages and files private. + +### Convenient use of end-to-end encryption (E2EE) + +Matrix not only encrypts transports to and from the home server (located in +Montreal, Canada) 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. + +When E2EE is enabled, messages can only be read by the participants in the +conversation and nobody else. This means messages can't be read by the +maintainers of the server, or by any other third party. **It also means that if +you lose your keys, you won't be able to read your messages either. So, back +them up.** + +The 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 our +home server, 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 read more about [encryption in +its own dedicated section]({{< relref "encryption" >}}) to prevent unforeseen +damage! {{% /notice %}} + +## 4. Still have questions? + +Answers to questions from our users are available in the +[FAQ]({{< relref "faq" >}}). You can always come and ask us questions in the +`#support:openscience.ca` room or by email at . diff --git a/content/en/matrix/integrations/_index.md b/content/en/matrix/integrations/_index.md new file mode 100644 index 0000000..40e3088 --- /dev/null +++ b/content/en/matrix/integrations/_index.md @@ -0,0 +1,77 @@ +--- +menutitle: Integrations +title: Widgets, Bots, & Bridges Integrations +draft: false +weight: 80 +--- + +Integrations or Widgets can be managed via the room information in the upper +right corner. + +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. + +## 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://wikipedia.org/wiki/Jitsi) is used, a free video conferencing +tool (Apache license). + +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 %}} You can also add via the Integration Manager to feature +talks while others can chat in the room. {{% /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 is highly recommended to avoid feedback between sound +recording and sound playback. Ideally a headset with a microphone close to your +mouth works best because the use of the microphone hole on the laptop may cause +more noise through. + +The `m` key mutes your microphone - you should always start a conference with +your microphone muted. 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 (This is often +the case with MacOS: under System Preferences > Security > Privacy > Screen +Capture). + +## 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, you may want to use another +solution. + +## Custom widget + +Any Internet page can be integrated. + +--- + +{{% notice tip %}} + +More information about bridges, bots and other integrations will be added in the +future. + +{{% /notice %}} + +--- diff --git a/content/en/matrix/messaging/_index.md b/content/en/matrix/messaging/_index.md new file mode 100644 index 0000000..aa68e0e --- /dev/null +++ b/content/en/matrix/messaging/_index.md @@ -0,0 +1,36 @@ +--- +title: "Messages" +chapter: true +weight: 30 +--- + +## Find people and send direct messages + +To create a 1:1 conversation with a person, you need to click on the :plus: +(`+`) sign in the _"People"_ section in the left sidebar. You can then search +someone by their (display) name, username, or email. You may have to wait a +little after typing the last character before the search results appear. Please +also note on which server your searched person is displayed. + +In the search result, click on the target person and then click on **_Go_**. The +conversation window will opens. You can have a conversation once the other +person connects to the server and accepts the invitation. + +By default, [end-to-end encryption is enable]({{% relref "encryption" %}}) as it +is the standard. The connection to the server is of course also +transport-encrypted. If you explicitly do not want end-to-end encryption for a +special reason, you can [create an unencrypted room]({{% relref "create" %}}) +and invite people in. + +A room with yourself is also possible, which can used as notebook / clipboard +and for tests like to check whether formatting and hyperlinks look correct. + +{{% notice tip %}} + +Many useful tips regarding [formatting messages]({{< relref "format" >}}) in the +next page. + +You may also be interested in [searching for specific +messages]({{< relref "search" >}}). + +{{% /notice %}} diff --git a/content/en/matrix/messaging/format.md b/content/en/matrix/messaging/format.md new file mode 100644 index 0000000..795bea1 --- /dev/null +++ b/content/en/matrix/messaging/format.md @@ -0,0 +1,104 @@ +--- +title: "Format messages" +draft: false +weight: 30 +--- + +## Write and format messages + +You can format your text using +[**Markdown**](https://wikipedia.org/wiki/Markdown), a lightweight markup +language. Markdown has become more common recently given its ease of use and its +readability to create formatted text using a plain-text editor. + +You can think of Markdown as a few little symbols around your text that will +allow Element to render the text with a little bit of formatting. For example +you can write words as **bold** (`**bold**`), or in _italics_ (`*italics*`), as +a [link](https://youtu.be/dQw4w9WgXcQ) (`[link](https://youtu.be/dQw4w9WgXcQ)`) +to a webpage, or as an image +(`![](https://docs.osumontreal.ca/img/en/kitty.jpg)`): ![](/img/en/kitty.jpg) + +[CommonMark](https://spec.commonmark.org/current/) is the current Markdown +specification implemented in Element. + +The input of LaTeX formulas is currently not supported. It is offered as an +experimental feature as of the time of updating this page. It will be available +for everybody in the near future. You can get the latest update from this +[issue](https://github.com/vector-im/element-web/issues/1945). Alternatively, an +integration can be used to display LaTeX formulas in the meantime. + +**Hashtags** (`#`) can be used to make terms easier to find using the [search +function]({{% relref "search" %}}). + +**Smileys** can be reached with a starting colon `:` and then the emoji name. +For example, _\:rainbow_flag\:_ is rendered as :rainbow_flag:. + +For a new line break, press **Shift + Enter**. + +When the **Ctrl + Enter** option is enabled, you can create a new line break by +pressing **Enter** only. + +### Send messages + +Messages can be sent by pressing the **Enter key**. If you are used to using +**Ctrl + Enter** to send messages, you can enable the _"Use Ctrl + Enter to send +a message"_ setting in +`Settings > Preferences > Use Ctrl + Enter to send a message`. + +### Edit your messages + +When you hover your message, you can click on the Edit button (:pencil:) to edit +your message. If a message is edited, it will also appear as edited in +_[threads](#reply-to-a-specific-message-or-thread)_. + +### Delete your messages + +When you hover your message, you can click on the **...** button, then Remove to +erase this message. The content of the message will be erased and replaced by +the following content _"Message deleted"_. If a message inside thread is +deleted, it will also appear as _"Message deleted"_ in +_[threads](#reply-to-a-specific-message-or-thread)_. + +### Keyboard shortcuts + +Keyboard shortcuts can save you a lot of time when formatting a message in the +**_Composer_** pane. The usual **Ctrl + b** will turn the highlighted text bold, +etc. The keyboard shortcut to toggle all the keyboard shortcuts is **Ctrl + /**. + +This window will pop up: + +![Keyboard shortcuts](../keyboard_shortcuts.png) + +## Read messages + +If there are more unread messages in a room than the screen cannot display, +clicking on the circle with the chevron icon +() near the right edge of the message +pane will make you jump to the oldest unread message. + +Similarly, you can jump to the latest timestamp of a conversation by clicking on +the circle () in the bottom right +corner of the message pane. + +## Reply to a specific message or thread + +To keep conversations tidy, you can hit the `reply` (↩️) button when you hover +the last message you want to reply to. If more than one message in involved in +the _thread_, you can click on the _"In reply to"_ to unroll the thread message +by message. + +Threads like in Mattermost or Slack are currently not available yet in Matrix. +The developers of Element are working hard to implement such functionality in +the near future. In the meantime, you can hit the `reply` (↩️) button when you +hover a message to keep track of conversations. + +To get more information about threading, follow their +[roadmap](https://github.com/vector-im/roadmap/projects/1), more specifically +this [issue](https://github.com/vector-im/element-web/issues/2349). + +## Upload and send files + +Files and any other media objects (image, GIF, video, etc.) can be sent up to a +maximum size of 10MB. For this purpose the paper clip :paperclip: button must be +selected. The sidebar with the document symbol shows the files within a room. +Larger files needs to be shared via a third-party service via a share link. diff --git a/content/en/matrix/messaging/keyboard_shortcuts.png b/content/en/matrix/messaging/keyboard_shortcuts.png new file mode 100644 index 0000000..3f5afde Binary files /dev/null and b/content/en/matrix/messaging/keyboard_shortcuts.png differ diff --git a/content/en/matrix/messaging/search.md b/content/en/matrix/messaging/search.md new file mode 100644 index 0000000..03678dd --- /dev/null +++ b/content/en/matrix/messaging/search.md @@ -0,0 +1,20 @@ +--- +title: "Message search" +draft: false +weight: 40 +--- + +It is not uncommon to want to search for older conversation content. To search +through the message history of a room (or all rooms) for a certain text, you +need to click the 🔍 "Search" button in the upper right corner of the Element +App. + +Looking for messages is possible in _unencrypted_ rooms without any problem +since Element has access to all the messages. + +The situation is different in encrypted rooms because Element does not have +access to all your encrypted messages. This function is only possible using the +[desktop client]({{< relref "clients" >}}) because messages must be cached for +the search, which is a disabled function by default. The message search must be +explicitly enabled under `Settings` -> `Security & Privacy` -> `Message search` +-> `Enable`. Afterwards, searching is also possible in encrypted rooms. diff --git a/content/en/matrix/notifications/_index.md b/content/en/matrix/notifications/_index.md new file mode 100644 index 0000000..54082d4 --- /dev/null +++ b/content/en/matrix/notifications/_index.md @@ -0,0 +1,77 @@ +--- +title: "Notifications" +chapter: false +weight: 50 +--- + +Like any communication platforms, you have to be able to do your work and not be +disturbed. 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 can 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 only when your name is mentioned in +> the discussion. + +Fortunalety, Element allows you to customise your notifications at two levels: +across the app through Global Settings and per room. + +### Global settings + +T0 access the global notification panel from the web/desktop app, you need to: + +1. Click on your name or your picture in the top left corner; +1. Click on _Notification settings_ in the drop down menu; + +These default settings, as the name implies, are applied globally across the app +for particular events for group and one-to-one chat rooms, invites and calls. +For example, if you turn `Enable audible notifications for this session` off, no +sound ever will n0tify you. Most notification options can be turned _off_, _on_ +or _noisy_. You can then choose which events should trigger a notification. + +The notifications can be: + +- **Turned off**: you won’t be notified when the selected event happens. +- **Turned on**: you will get a message popping up when the selected event + happens, but no sound. +- **_Noisy_**: you will get a visual highlight (red badge and/or text + highlight), a sound and/or vibration (depending on the device) when the + selected event happens. There will be a sound only if the global _audible + notification_ setting is set to on. + +You can also configure keywords by clicking on it and enter as many keywords as +you want separated by a comma. + +### Per room fine-tuning + +You can also configure the notification settings for each room individually +based on your needs. This is very handy when you wish to temporarily mute a +room, or make sure you’re not missing anything from a given discussion. + +1. Hover a chat or room in the room list on the left; +2. You should now see a bell appears - Click on it; +3. Select the option you want between _Use default_, _All messages_, _Mentions & + Keywords_ or _None_. + - **Use default**: Default settings from the Global notification settings + apply. (That is the default option). + - **All messages**: You get a notification for every message happening in the + room. + - **Mentions & Keywords**: You are only notified for the items that are meant + to be ‘noisy’, namely your when someone @YOURUSERNAME and keywords + previously set in the Global notification settings. + - **None**: You won’t be notified, even if your name or a keyword is + mentioned. + +{{% notice tip %}} There are many useful, additional settings and +recommendations described the in [Settings]({{% relref "../settings" %}}) +section for you to discover. {{% /notice %}} diff --git a/content/en/matrix/quick-start.md b/content/en/matrix/quick-start.md new file mode 100644 index 0000000..6b6d6e2 --- /dev/null +++ b/content/en/matrix/quick-start.md @@ -0,0 +1,58 @@ +--- +title: Quick start +weight: 100 +--- + +This _quick start guide_ is meant to get you started in less than one minute +with the Open Science Matrix instance. If you are not familiar with Matrix or +Element, we highly recommend reading the section ["First +steps"]({{< ref "matrix/first-steps" >}}) to make sure you set your account +properly. + +## Create an Account + +### On Desktop + +1. Go to https://chat.openscience.ca +1. Click on the _Create Account_ button +1. Fill the form and click on the _Register_ button + +### On Mobile + +1. Download the Element app for your platform: + +- [Android via Google Play Store][google] +- [Android via F-Droid][fdroid] +- [iOS][ios] + +1. Open the app +1. Click on _Get Started_ +1. Choose _Other - Custom & advanced settings_ +1. Set the address to: https://matrix.openscience.ca and click on _Continue_ +1. Click on _Sign In_ +1. Enter your username and password +1. Click on _Sign In_ + +## Connect to Element + +### On Desktop + +1. Go to https://chat.openscience.ca +1. Click on _Sign In_ +1. Enter your username and password +1. Click on _Sign In_ + +Alternatively, you can [download the Element Desktop app][desktop] (Windows, +MacOS, Linux) and: + +1. Open Element Desktop +1. Click on _Sign In_ +1. Click on _Change_ +1. Change the Homeserver URL to: https://matrix.openscience.ca and click _Next_ +1. Enter your username and password +1. Click on _Sign In_ + +[desktop]: https://element.io/get-started +[google]: https://play.google.com/store/apps/details?id=im.vector.app +[fdroid]: https://f-droid.org/en/packages/im.vector.app/ +[ios]: https://apps.apple.com/app/vector/id1083446067 diff --git a/content/en/matrix/rooms/_index.md b/content/en/matrix/rooms/_index.md new file mode 100644 index 0000000..b262301 --- /dev/null +++ b/content/en/matrix/rooms/_index.md @@ -0,0 +1,32 @@ +--- +title: "Rooms" +chapter: true +draft: false +weight: 35 +--- + +# Rooms + +Matrix supports public and private conversations in what we call **rooms**. +One-to-one and group chat rooms are organized the same way, making it easy for +you to: + +## - [find / leave rooms]({{< relref "find-leave" >}}) + +## - [create rooms and adjust settings]({{< relref "create" >}}) + +## - [delete rooms]({{< relref "delete" >}}) + +## - [share rooms]({{< relref "share" >}}) + +## Room vs People + +But wait, I see a People section and a Room section... What is going on? + +In the _People_ section, you see all the conversations you have with people +one-to-one rooms. + +In the _Room_ section, you see all the public channels you have joined, +including group conversations you have been a part of. Private conversations +with many people are listed in this section as well since these rooms are simply +_private rooms_, unless you decide to make them public by changing its settings. diff --git a/content/en/matrix/rooms/create.md b/content/en/matrix/rooms/create.md new file mode 100644 index 0000000..0247caf --- /dev/null +++ b/content/en/matrix/rooms/create.md @@ -0,0 +1,151 @@ +--- +title: "Create rooms + Settings" +draft: false +weight: 20 +--- + +## Create rooms and take responsibility + +New rooms are created using the :plus: (+) button in the left sidebar next to +the _Rooms_ section title. + +| | | +| ----------------------------------------------------------- | -------------------------------------------------------------- | +| ![Create a private room](../room_create_pv_advanced_lt.png) | ![Create a public room](../room_create_public_advanced_lt.png) | + +1. Assign a name to the room. +1. _Optional_: you can also assign a topic. + - This can be added or modified later on. +1. Decide whether the room should be made publicly accessible (this is not the + default setting, meaning the default is _unpublished/private_). + - This can be modified later on, but it is much simpler to set it at this + stage if you plan to have your room searchable on the server. +1. If you choose to create a **private** room, decide whether you want to enable + end-to-end ecryption (default option) or not. + - You **can’t disable** this later, so consider this choice carefully. + However, it can be enabled at a later time. + - If you plan to make your room public in the future, we don't recommend + enabling encryption. In addition, bridges & most bots won’t work yet. + - If you are unsure about this option, you can get more information in the + [end-to-end encryption]({{< relref "encryption" >}}) section. +1. If you choose to create a **public** room, decide of a human-friendly address + for your room. + - This can be added or modified later on. +1. With an additional click on "Show more", you can block anyone not registered + with a @openscience.ca account from joining your room. + - Again, you can't disable it laterit can be prevented that Matrix users from + outside the Open Science home server (Homeserver) can enter the room. + - This can be turned _on_ later. + +Once you click on **Create Room**, the room is created and appears in your _Room +section_ in the left sidebar. It gets assigned a random color with the first +letter inside the circle. There are many more options that can be adjusted in +the _Room settings_. + +{{% notice warning %}} As the room administrator, you are **responsible** for +the content shared in the room (e.g. false messages, hate mail, etc.). You have +admin tools that are useful to moderate rooms (mute, kick, ban, and remove +recent messages). You can also include other people to help you with this +important responsibility by assigning roles in the right sidebar when you click +on a person icon. You can change the _"Permission Level"_ drop-down menu (Admin, +Moderator or Custom). There is also a bot that can help you, but you have to +invite it. {{% /notice %}} + +--- + +## Room settings + +To have full control over a room's settings, one needs to be an _admin_. You are +an admin when: + +1. You create a room, you become its admin by default; +2. An admin of a room makes you an admin. + +By clicking on the :information: icon (**i**) in the upper right corner and then +the gear wheel "room settings" you can access the room settings: + +### General tab + +In this tab, you can adjust many settings: + +- Update the room name; +- Add a description or topic; +- Upload a room-specific image/icon using the upload button on the right; +- Add 0r modify Room Addresses; + - Refer to the [dedicated section below](#room-addresses)). +- Publish this room to the public in openscience.ca's room directory?; + - Read the [#room-addresses section](#room-addresses) below. +- Enable URL previews for everyone by default or for you; + - In encrypted rooms, URL previews are disabled by default to ensure that the + our server (where the previews are generated) cannot gather information + about links you see in these rooms. + +#### Room addresses + +Every room has a so-called _internal room ID_ that looks like +`!JbwMKWxduJCSMqzHWp:openscience.ca`. Because this cryptic address can not be +read nor easily remembered by humans, custom room addresses can be assigned. +While you can always view the _internal room ID_ in the **Advanced** tab, you +can assign in parallel a local room address in the **General** tab, which is +even more important when we want to [share]({{% relref "share" %}}) a room. + +The assigned local room address can then easily be distributed in public or to +the target group and has the following structure: +`#room-address:openscience.ca`. + +This is only necessary for rooms you want to make public and reference in other +places which would look like this: `#support:openscience.ca` instead of +`!JbwMKWxduJCSMqzHWp:openscience.ca`. + +To assign a local address, you have to click on _"Show more"_ under _"Local +Addresses"_. + +Room addresses can be published **locally** with a local address within the +openscience.ca's, which is only valid within the matrix home server for +openscience.ca or **globally** (findable by users in other servers - useful for +topics beyond Open Science), which will make the _local address_ to a _main +address_ as well. + +### Security & Privacy tab + +Room administrators have to make 3 important decisions: + +#### Should the room be encrypted? + +If for a reason you want to enable encryption from now on, this is the button +you can use to do it. There is chance of reverting it once encryption is +enabled, so think carefully before acting. + +{{% notice note %}} The end-to-end encryption of large or public spaces is +critical in terms of the difficult verification. See [Use end-to-end +encryption]({{< relref "encryption" >}}). {{% /notice %}} + +#### Who is allowed access? + +There are 3 options: + +1. **Only people who have been invited**: These are closed/private rooms. Access + at the moment only by explicit invitation by moderator:inside or + administrator:inside +2. **Everyone who knows the room's link, apart from 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. If + necessary, you can use the admin tools to control the access (kick and ban + people who should not be in the room). +3. **Everyone who knows the room's 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. + +#### And who can read the chat history? + +There are 4 options: + +- **Anyone** +- **Members only (since the point in time of selecting this option)** +- **Members only (since they were invited)** +- **Members only (since they joined)** diff --git a/content/en/matrix/rooms/delete.md b/content/en/matrix/rooms/delete.md new file mode 100644 index 0000000..9d3db6a --- /dev/null +++ b/content/en/matrix/rooms/delete.md @@ -0,0 +1,34 @@ +--- +title: "Delete rooms" +chapter: true +draft: false +weight: 30 +--- + +## Delete rooms + +If the last person in a room leaves it, the room is still in the archive for 7 +days, but is then permanently deleted[^1]. + +If you are an administrator[^2] of a room and you want to delete it, the +recommended steps are to be done in the following order: + +1. Go in the room [settings]({{% relref "settings" %}}) Disable Security & + Privacy +1. all room members should first be "kicked" out of it (removed from the room), +1. the administrator is the last to leave the room and thus initiates the later + deletion by the server. + +{{% notice warning %}} At the moment, there is no official way to export the +room history into a log file either in `.txt`, `.html` or `.json`. Refer to this +[GitHub issue](https://github.com/vector-im/element-web/issues/2630) to know +more. There are amazing open sourcerers who provided clever solutions in this +issue, including +[matrix-archive](https://github.com/russelldavies/matrix-archive), and +[matrix-dl-csv](https://github.com/shawntabrizi/matrix-dl-csv) that were seen +active recently. {{% /notice %}} + +[^1]: We can't be deem responsible for any dataloss. +[^2]: + Unless the default settings have been changed, the creator of a room is the + default administrator from the moment the room was created. diff --git a/content/en/matrix/rooms/find-leave.md b/content/en/matrix/rooms/find-leave.md new file mode 100644 index 0000000..45a287a --- /dev/null +++ b/content/en/matrix/rooms/find-leave.md @@ -0,0 +1,32 @@ +--- +title: "Find / Leave rooms" +chapter: true +draft: false +weight: 10 +--- + +## Find rooms + +The room directory, in which the publicly accessible rooms are presented, can be +open via the :compass: (compass) button "Explore / Discover" in the left +sidebar, under your name or via the :plus: sign button next to the _Rooms_ +section title. A new window will open and you will be able to search for public +Rooms on the Open Science server and others through the federation. +![Menu to find public rooms](../room_explore.png) +![Menu to find public rooms](../room_explore_lt.png) + +{{% notice note %}} The global federation is currently in test operation, +meaning you can join any room on servers that have enabled the global +federation. It is possible that the Federation will be restricted again at a +later date if problem arises. {{% /notice %}} + +## Leave rooms + +In the left sidebar, hover the room you want to leave and click on the `...` +(room options) button, then click on _Leave Room_. +![Dark-themed button to leave a room](../room_leave.png) +![Light-themed button to leave a room](../room_leave_lt.png) + +Rooms that you leave no longer appear in your room list (left sidebar), but may +appear in a new section at the bottom called _Historical_. You can get rid of +them completely by clicking on the `...` again and click on _Forget Room_. diff --git a/content/en/matrix/rooms/room_create_public_advanced.png b/content/en/matrix/rooms/room_create_public_advanced.png new file mode 100644 index 0000000..2f08e01 Binary files /dev/null and b/content/en/matrix/rooms/room_create_public_advanced.png differ diff --git a/content/en/matrix/rooms/room_create_public_advanced_lt.png b/content/en/matrix/rooms/room_create_public_advanced_lt.png new file mode 100644 index 0000000..0f50e84 Binary files /dev/null and b/content/en/matrix/rooms/room_create_public_advanced_lt.png differ diff --git a/content/en/matrix/rooms/room_create_pv_advanced.png b/content/en/matrix/rooms/room_create_pv_advanced.png new file mode 100644 index 0000000..a6322f3 Binary files /dev/null and b/content/en/matrix/rooms/room_create_pv_advanced.png differ diff --git a/content/en/matrix/rooms/room_create_pv_advanced_lt.png b/content/en/matrix/rooms/room_create_pv_advanced_lt.png new file mode 100644 index 0000000..d715dc9 Binary files /dev/null and b/content/en/matrix/rooms/room_create_pv_advanced_lt.png differ diff --git a/content/en/matrix/rooms/room_explore.png b/content/en/matrix/rooms/room_explore.png new file mode 100644 index 0000000..66713cd Binary files /dev/null and b/content/en/matrix/rooms/room_explore.png differ diff --git a/content/en/matrix/rooms/room_explore_lt.png b/content/en/matrix/rooms/room_explore_lt.png new file mode 100644 index 0000000..e273592 Binary files /dev/null and b/content/en/matrix/rooms/room_explore_lt.png differ diff --git a/content/en/matrix/rooms/room_leave.png b/content/en/matrix/rooms/room_leave.png new file mode 100644 index 0000000..99a6b67 Binary files /dev/null and b/content/en/matrix/rooms/room_leave.png differ diff --git a/content/en/matrix/rooms/room_leave_lt.png b/content/en/matrix/rooms/room_leave_lt.png new file mode 100644 index 0000000..45a9fce Binary files /dev/null and b/content/en/matrix/rooms/room_leave_lt.png differ diff --git a/content/en/matrix/rooms/share.md b/content/en/matrix/rooms/share.md new file mode 100644 index 0000000..99ce174 --- /dev/null +++ b/content/en/matrix/rooms/share.md @@ -0,0 +1,69 @@ +--- +title: "Share rooms" +draft: false +weight: 40 +--- + +This page is about sharing rooms to others through links. + +{{% notice note %}} To share or publish a global address, you have to create a +local address first. **It is necessary to create a local address in both +cases!** If you did not do this step when you created a room, you have to do +this, please refer to the [Settings for Rooms +section]({{% ref "create#room-settings" %}}) to do it. {{% /notice %}} + +That being said, you can find the room address with following structure +`#room-address-name:openscience.ca` in the _Room settings_ under the General +tab > Room Addresses > Published Addresses. If you don't find an address there, +click on "Show more" under Local Addresses, and it should be there. If you don't +see any address, it means that the admin never created one in the first place. +If you want to share a room within Matrix, you don't have to go through this +procedure, you simply have to know the name of the room you want to share, as +described below. + +## How to share a room within Matrix + +When you want to share a room that you are a member of, you can simply use the +internal link feature by starting typing `#` followed by the _room address_ or +_name_. You can confirm the room name by autocompleting it using your mouse or +your arrow keys on your keyboard. You can also autocomplete the room name by +hitting your `tab` button. When you use the `#room-address:openscience.ca` +format into the chat box, it renders the name of the room automatically. + +This is a special link for a usage within matrix, which will open directly in +the client of the receiver when they click on it with their mouse. + +## How to share a room outside Matrix + +{{% notice warning %}} + +There is a share icon in the upper right corner of each room also provides a +link, a QR code and various social networks. However, these links lead to +https://matrix.to/ from which anyone can access the room or get invited to join +the room via the Element Web **(not our Element App)** if +they don't have a matrix client installed on their computer. To prevent +misunderstanding and to share a room so people can register through our Open +Science Server, we highly advise you to use the methode explained below. Matrix +developpers are aware of this issue +([#197](https://github.com/matrix-org/matrix.to/issues/197)). + +{{% /notice %}} + +A typical link looks like this +`https://chat.openscience.ca/#/room/#ROOM-ADDRESS:openscience.ca`. The only +thing you have to change in this URL is the `ROOM-ADDRESS` part. + +If you are using the **Element Web App**, the easiest way to share a link to +someone outside the Matrix ecosystem is to simply copy and paste the URL you see +in the address bar of your browser. If the room is public, the person who clicks +on the link will be prompted to log in or sign up. + +If you are using any other app, you can create a hyperlink to the room, which +you have to construct like this: +`https://chat.openscience.ca/#/room/#support:openscience.ca` + +The link you share is, in fact, 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. +Once a person has joined the room, they will see it appear in their desktop app +automatically. diff --git a/content/en/matrix/settings/_index.md b/content/en/matrix/settings/_index.md new file mode 100644 index 0000000..af32e8d --- /dev/null +++ b/content/en/matrix/settings/_index.md @@ -0,0 +1,13 @@ +--- +title: "Important settings" +draft: false +chapter: false +weight: 10 +--- + +{{% notice warning %}} + +This page is under construction. For basic settings info, +https://element.io/help may help you in the meantime. + +{{% /notice %}} diff --git a/content/fr/credits.md b/content/fr/credits.md index bfa4aec..bdeb72b 100644 --- a/content/fr/credits.md +++ b/content/fr/credits.md @@ -15,9 +15,10 @@ Merci à eux d'avoir amélioré l'Open Science et les logiciels Open Source! - [Matrix at TU Dresden](https://doc.matrix.tu-dresden.de/en/) - L'équipe derrière Matrix à TU Dresden fournit une merveilleuse documentation disponible - sous une license [CC BY-SA 4.0](https://creativecommons.org/licenses/by-sa/4.0/legalcode) que nous avons adaptée à - nos besoins. Voir notre section [Matrix - Documentation]({{}}) pour un aperçu. + sous une license + [CC BY-SA 4.0](https://creativecommons.org/licenses/by-sa/4.0/legalcode) que + nous avons adaptée à nos besoins. Voir notre section [Documentation pour + Matrix]({{< relref "matrix/_index.md">}}) pour un aperçu. ## Outils diff --git a/layouts/shortcodes/expand.html b/layouts/shortcodes/expand.html new file mode 100644 index 0000000..47c629a --- /dev/null +++ b/layouts/shortcodes/expand.html @@ -0,0 +1,17 @@ +{{ $_hugo_config := `{ "version": 1 }` }} +
+
+ + + {{$expandMessage := T "Expand-title"}} + {{ if .IsNamedParams }} + {{.Get "default" | default $expandMessage}} + {{else}} + {{.Get 0 | default $expandMessage}} + {{end}} + +
+ +
\ No newline at end of file diff --git a/static/img/en/kitty.jpg b/static/img/en/kitty.jpg new file mode 100644 index 0000000..ad8cd33 Binary files /dev/null and b/static/img/en/kitty.jpg differ diff --git a/static/img/free-software-likes-you-and-your-freedom.webp b/static/img/free-software-likes-you-and-your-freedom.webp new file mode 100644 index 0000000..c618b3c Binary files /dev/null and b/static/img/free-software-likes-you-and-your-freedom.webp differ