Element

Add Email to Your Account

  1. Go to Element All settings
    temp

  2. Enter your email address and click Add
    temp

  3. When you get this message, check your email
    temp

  4. Click the link in the email. Make sure it opens in another tab/window, leaving your Element client where it is
    temp

  5. When you get this message, you can close the verification tab/window and return to Element
    temp

  6. Go back to Element and click Continue
    temp

  7. Enter your account password or confirm using SSO, then click Continue
    temp

  8. If all worked correctly, your new email should now show up under the Email addresses section in Element settings. If not, something went wrong and you need to try again
    temp

Change Account Password

Resetting the account password will log out all your sessions. Before doing this, make sure that


If you know your current password

  1. Go to Element All settings
    temp

  2. Enter your current password and your new password
    temp

  3. You might want to export your E2E room keys. Just to be on the safe side in case something goes wrong. See also Export and Import E2E Room Keys

  4. Click Continue.
    Note: This warning is outdated, see this issue
    temp

  5. Click OK
    temp

  6. You now need to sign in again on all your other devices

If you do not know your current password

Note, this will only work if you have an email address attached to your Matrix account. If you do not have an email address attached, contact the administrators of your homeserver. (support@matrix.org does not reset passwords in any circumstance)

  1. Sign out of Element
    temp

  2. Click Sign out
    temp

  3. Click "Not sure of your password? Set a new one"
    temp

  4. Enter your email address, and a new password. Then click Send Reset Email
    temp

  5. Click Continue.
    Note: This warning is outdated, see this issue
    temp

  6. When you get this message, check your email
    temp

  7. Click the link in the email. Make sure it opens in new browser tab, leaving your Element client open
    temp

  8. Click Confirm changing my password
    temp

  9. You can now close this tab and return to Element
    temp

  10. Click i have verified my email address
    temp

  11. Click Return to login screen
    temp

  12. Sign in like normal with your new password. Note that all your other sessions have been signed out and you need to sign in again.

Change the default homeserver in Element Desktop

This guide applies if your system cannot connect to https://matrix.org and you see this error message when opening Element Desktop for the first time.

This is a temporary workaround until this issue is resolved.

In this guide, the homeserver domain is example.com, meaning Matrix usernames are @someone:example.com, and the homeserver is exposed on the domain matrix.example.com. Make sure you add your domains in the config below before pasting it into config.json.

First, exit Element, then follow the steps for your operating system below.

Linux

The exact steps may depend on your distro, but generally, it will be something along the lines of:

  1. Open your Terminal

  2. Right-click and paste cat > ~/.config/Element/config.json, then hit enter

  3. Right-click and paste

    {
        "default_server_config": {
            "m.homeserver": {
                "base_url": "https://matrix.example.com",
                "server_name": "example.com"
            }
        },
        "room_directory": {
            "servers": []
        }
    }
    
  4. Hit Ctrl + C

Mac

  1. Open Terminal. Hit Command + Space then enter terminal

  2. Right click and paste cat > ~/Library/Application\ Support/Element/config.json then hit enter

  3. Right-click and paste

    {
        "default_server_config": {
            "m.homeserver": {
                "base_url": "https://matrix.example.com",
                "server_name": "example.com"
            }
        },
        "room_directory": {
            "servers": []
        }
    }
    
  4. Hit Ctrl + C

Windows

  1. Press Win + R

  2. Paste in %APPDATA%\Element\

  3. Create a new text file named config.json

  4. Open config.json in Notepad

  5. Paste in

    {
        "default_server_config": {
            "m.homeserver": {
                "base_url": "https://matrix.example.com",
                "server_name": "example.com"
            }
        },
        "room_directory": {
            "servers": []
        }
    }
    
  6. Save and exit

Element Settings

Notice: Please be advised this document is currently a work in progress, some information is currently missing and will be updated in due course.

Remember: Have you tried - https://element.io/help ?
Don't forget to download our User Guide

Relating to this page, Element Settings, you can specifically check for relevant information from the Account Management and Settings sections.

Accessing Settings

You can change your Matrix account settings by clicking your profile icon in the top left of the Element client. By defualt, this will be a coloured circle with the first letter of your Matrix ID. From the presented drop-down menu, you'll be able to jump into specfic settings straight away, or access 'All Settings'.

You can also use this menu to quickly return 'Home', provide 'Feedback' and this is where you can 'Sign Out' from your client.

Disclaimer: The below setting layout / order may change in subsequent client updates, however generally most settings will still perform the same function.

General

Profile

Allows you to change your 'Display Name', this is the name seen by others whilst messaging with them. Updating this will notify all rooms of the change of name. You are also able to upload / change your profile picture, you can do this by hoovering over the existing picture and clicking.

After making your changing, click 'Save' to set them. You Matrix ID in full is also displayed here for your reference.

Account

Allows you to add email addresses / phone numbers to your account, as well as change your 'Language and Region' setting. Adding of Third-Party IDs requires verifying your login by either supplying your account password, or using SSO (such as when using Element One).

Discovery

Allows you to agree to the identity server (vector.im) Terms of Service to allow yourself to be discoverable by email address or phone number, change your identity server. Using an identity server is optional. If you choose not to use an identity server, you won't be discoverable by other users and you won't be able to invite others by email or phone.

You can stop using an identity server by clicking 'Do not use an identity server'

Manage integrations

Allows you to turn on or off the use of an integration manager. You the toggle button to configure as desired.

Deactivate account

Allows you to deactivate your account - Warning! Deactivating your account is a permanent action.

Appearance

Appearance settings allows you to customise the look and feel of your client, all settings provide visual representation of the changes so you can confirm your preferred style. Options include Theme, Message Layout, Font Size and Image size in the timeline.

Notifications

Notification settings allow you to customise default notification settings which are synced to your account, however you are also able to customise whether you recieve notifications for this specific device. Note: A device is per client, using both a web-based Matrix client and a Desktop client on the same physical device will still appear as two separate devices.

Desktop Notifications

To enable desktop notifications from your client, you can enable the toggle 'Enable desktop notifications for this session', you can also customise these notifications to also display the message that triggers the notification using the 'Show message in desktop notification' toggle. When using a web-based Element client, you will also need to accept permissions allowing the client to display notifications.

Notification types explained

Notification settings allow notifications to be set as either 'Off', 'On' or 'Noisy'.

For finer tuning, you can easily configure per room notification setting from the context menu you get by clicking on the ... icon that appears when hovering over the room name in the room list. You can use this to temporarily mute a room, or make sure you’re not missing anything from a given discussion. You can select the following options:

Keyword Notifications

From the notification settings you can also add additional keywords to listen for to trigger a notification. You can directly specify how a notification triggered from these keywords responds in the 'Mentions & keywords' section.

Preferences

Keyboard

Sidebar

Voice & Video

Security & Privacy

Labs

Help & About

From Help & About you can find important information related to the client itself, such as it's current version, your homeserver and identity server details as well as links to our FAQ, Legal documents and credits.

Your Access Token

Your access token gives full access to your account via the use of Matrix APIs, you can read more about them depending on your needs. If you are an Admin of a homeserver, and are using an account with Admin access, you can make use of the Synapse Admin API. For both admins and regular users, the Matrix APIs can be found from the latest Matrix Spec page - these include:

Bug Reporting

If you've experience a bug, the best place to report it is by submitting a bug report to the appropriate Github repository for your client, the Element account

Exporting Messages

Using your Element client you can export your Room's message history in HTML, Plain Text or JSON format - including attachments.

  1. Open the room you wish to export message history

  2. Access 'Room Info' using the icon in the top right

  3. Select 'Export Chat', then confirm your desired settings for export

  4. Finally click 'Export' - once the export has completed you will be prompted to save an archive of the export.

Submit Debug Logs

  1. Search for other issues of the same problem on

  2. If you cannot find any, create one by clicking New issue, then Get started in the Bug report section.
    temp
    temp

  3. Go to the section for your device

Element Web and Desktop

  1. Go to Element All settings
    temp

  2. Under Help & About, click Submit debug logs
    temp

  3. Enter a GitHub issue link and a description. Then click Send logs
    temp

  4. Click OK
    temp

Element iOS

  1. Tap the cog in the top left of Element
    temp

  2. Scroll down to the OTHER section, then tap Report bug
    temp

  3. Enter a GitHub issue link and a description, make sure Send logs is checked, then click Send
    temp

Element Android

  1. Tap the three stacked dots in the top right
    temp

  2. Tap Report bug
    temp

  3. Enter a GitHub issue link and a description, make sure Send logs, and Send crash logs are checked, then tap the send arrow in the top right
    temp