Note: development on this repository has primarily moved to the gekidou branch
This master branch is mostly in maintenance mode while we're working to getting our "v2" (code named "gekidou") to the GA stage. To contribute check out the gekidou branch in this repository.
Mattermost Mobile App
- Minimum Server versions: Current ESR version (6.3.0)
- Supported iOS versions: 12.1+
- Supported Android versions: 7.0+
Mattermost is an open source platform for secure collaboration across the entire software development lifecycle. This repo is for the mobile app that runs on Android and iOS. You can download our apps from the App Store or Google Play Store, or build them yourself.
New features are released monthly - check the changelog for currently-supported features!
Important: If you self-compile the Mattermost Mobile apps you also need to deploy your own Mattermost Push Notification Service.
How to Contribute
Testing
To help with testing app updates before they're released, you can:
- Sign up to be a beta tester
- Install the
Mattermost Betaapp. New updates in the Beta app are released periodically. You will receive a notification when the new updates are available. - File any bugs you find by filing a GitHub issue with:
- Device information
- Repro steps
- Observed behavior (including screenshot / video when possible)
- Expected behavior
- (Optional) Sign up for our team site
- Join the Native Mobile Apps channel to see what's new and discuss feedback with other contributors and the core team
You can leave the Beta testing program at any time:
- On Android, click this link while logged in with your Google Play email address used to opt-in for the Beta program, then click Leave the program.
- On iOS, access the
Mattermost Betaapp page in TestFlight and click Stop Testing.
Contribute Code
- Look in GitHub issues for issues marked as [Help Wanted]
- Comment to let people know you’re working on it
- Follow these instructions to set up your developer environment
- Join the Native Mobile Apps channel on our team site to ask questions
Frequently Asked Questions
How is data handled on mobile devices after a user account is deactivated?
App data is wiped from the device when a user logs out of the app. If the user is logged in when the account is deactivated, then within one minute the system logs the user out, and as a result all app data is wiped from the device.
Can I connect to multiple Mattermost servers using the mobile apps?
At the moment, we only support connecting to one server at a time. If you need to connect to multiple servers, please upvote the feature request so we can track demand for it.
As a work around, you can install both the released "Mattermost" app and sign up to be a tester for the "Mattermost Beta" app so you can connect to two servers at once.
Will there be second generation apps available for tablets?
We plan to add support for tablets in the future, but the timeline depends on how many people have a need for it. If you're looking for a tablet version, please help us out by upvoting the feature request!
Troubleshooting
I keep getting a message "Cannot connect to the server. Please check your server URL and internet connection."
This sometimes appears when there is an issue with the SSL certificate configuration.
To check that your SSL certificate is set up correctly, test the SSL certificate by visiting a site such as https://www.ssllabs.com/ssltest/index.html. If there’s an error about the missing chain or certificate path, there is likely an intermediate certificate missing that needs to be included.
Please note that the apps cannot connect to servers with self-signed certificates, consider using Let's Encrypt instead.
I see a “Connecting…” bar that does not go away
If your app is working properly, you should see a grey “Connecting…” bar that clears or says “Connected” after the app reconnects.
If you are seeing this message all the time, and your internet connection seems fine:
Ask your server administrator if the server uses NGINX or another webserver as a reverse proxy. If so, they should check that it is configured correctly for supporting the websocket connection for APIv4 endpoints.