Skip to content

Latest commit

 

History

24,393 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Latest build Weblate Element Android Matrix room #element-android:matrix.org Quality Gate Status Vulnerabilities Bugs

Element Android

Element Classic Android is a previous-generation Matrix client provided by Element. The app can be run on every Android devices with Android OS Lollipop and more (API 21). This client is still supported and receives security updates but no new features or usability enhancements are made. It is recommended to use Element X that is the next-generation mobile app.

Get it on Google Play Get it on F-Droid

Build of develop branch: GitHub Action Nightly test status: allScreensTest

New Android SDK

Element is based on a new Android SDK fully written in Kotlin (like Element). In order to make the early development as fast as possible, Element and the new SDK currently share the same git repository.

At each Element release, the SDK module is copied to a dedicated repository: https://github.com/matrix-org/matrix-android-sdk2. That way, third party apps can add a regular gradle dependency to use it. So more details on how to do that here: https://github.com/matrix-org/matrix-android-sdk2.

Roadmap

The version 1.0.0 of Element still misses some features which was previously included in Riot-Android. The team will work to add them on a regular basis.

Releases to app stores

There is some delay between when a release is created and when it appears in the app stores (Google Play Store and F-Droid). Here are some of the reasons:

  • Not all versioned releases that appear on GitHub are considered stable. Each release is first considered beta: this continues for at least two days. If the release is stable (no serious issues or crashes are reported), then it is released as a production release in Google Play Store, and a request is sent to F-Droid too.
  • Each release on the Google Play Store undergoes review by Google before it comes out. This can take an unpredictable amount of time. In some cases it has taken several weeks.
  • In order for F-Droid to guarantee that the app you receive exactly matches the public source code, they build releases themselves. When a release is considered stable, Element staff inform the F-Droid maintainers and it is added to the build queue. Depending on the load on F-Droid's infrastructure, it can take some time for releases to be built. This always takes at least 24 hours, and can take several days.

If you would like to receive releases more quickly (bearing in mind that they may not be stable) you have a number of options:

  1. Sign up to receive beta releases via the Google Play Store.
  2. Install a release APK directly - download the relevant .apk file and allow installing from untrusted sources in your device settings. Note: these releases are the Google Play version, which depend on some Google services. If you prefer to avoid that, try the latest dev builds, and choose the F-Droid version.
  3. If you're really brave, install the very latest dev build - pick a build, then click on Summary to download the APKs from there: vector-Fdroid-debug and vector-Gplay-debug contains the APK for the desired store. Each file contains 5 APKs. 4 APKs for every supported specific architecture of device. In doubt you can install the universal APK.

Contributing

Please refer to CONTRIBUTING.md if you want to contribute on Matrix Android projects!

Come chat with the community in the dedicated Matrix room.

Also this documentation can hopefully help developers to start working on the project.

Triaging issues

Issues are triaged by community members and the Android App Team, following the triage process.

We use issue labels to sort all incoming issues.

Copyright and License

Copyright (c) 2018 - 2025 New Vector Ltd

This software is dual licensed by New Vector Ltd (Element). It can be used either:

(1) for free under the terms of the GNU Affero General Public License (as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version); OR

(2) under the terms of a paid-for Element Commercial License agreement between you and Element (the terms of which may vary depending on what you and Element have agreed to).

Unless required by applicable law or agreed to in writing, software distributed under the Licenses is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the Licenses for the specific language governing permissions and limitations under the Licenses.


Custom Server Configuration (Custom Build)

This fork is configured to use a custom Matrix homeserver.

Changing the Server Address

To change the homeserver address, modify only one line in:

vector-config/src/main/res/values/config.xml
<!-- Change this value to your server address -->
<string name="matrix_org_server_url" translatable="false">https://your-server.com:port</string>

All related URLs will be automatically derived:

Config Value
Server URL https://your-server.com:port
Push Gateway https://your-server.com:port/_matrix/push/v1/notify
API Endpoints https://your-server.com:port/_matrix/client/...

Building the APK

  1. Go to Actions
  2. Click "Run workflow" → "Run workflow"
  3. Wait for build to complete
  4. Download element-release-signed artifact

Features of This Custom Build

  • ✅ No LeakCanary (no debug memory leak detection app)
  • ✅ Release build with debug signing (directly installable)
  • ✅ Skips well-known lookup (faster connection to non-standard port servers)
  • ✅ Simplified configuration (single place to change server address)

自定义服务器配置(中文说明)

本分支已配置为使用自定义 Matrix 主服务器。

修改服务器地址

只需修改 一处 即可更换服务器地址:

vector-config/src/main/res/values/config.xml
<!-- 修改这一行的值为你的服务器地址 -->
<string name="matrix_org_server_url" translatable="false">https://你的服务器.com:端口</string>

所有相关地址会自动派生:

配置项
服务器地址 https://你的服务器.com:端口
推送网关 https://你的服务器.com:端口/_matrix/push/v1/notify
API 接口 https://你的服务器.com:端口/_matrix/client/...

构建 APK

  1. 打开 Actions
  2. 点击 "Run workflow" → "Run workflow"
  3. 等待构建完成
  4. 下载 element-release-signed 构建产物

此自定义版本特性

  • ✅ 无 LeakCanary(不会安装内存泄漏检测应用)
  • ✅ Release 版本使用 Debug 签名(可直接安装)
  • ✅ 跳过 well-known 查找(非标准端口服务器连接更快)
  • ✅ 简化配置(只需修改一处即可更换服务器地址)

About

Element Android - A Matrix client for Android

Resources

Contributing

Security policy

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages