mattermost / docs

Mattermost documentation
https://docs.mattermost.com
BSD 3-Clause "New" or "Revised" License
211 stars 582 forks source link

Request for Documentation: Document client/server url schemas limitations for custom mobile apps #5024

Closed mm-cloud-bot closed 1 month ago

mm-cloud-bot commented 3 years ago

Mattermost user stu.doherty from https://community-daily.mattermost.com has requested the following be documented:

Due to changes in our SAML auth flow any customer building their own version of the mobile client (either because they need to host the Push Proxy themselves, OR they have their own customizations they're applying to the client) will need to be aware of a few things:

1. If they want to allow users to simultaneously run the App Store versions of Mattermost, in addition to the custom company version, they will need to adapt the URL schemes used for the app in the build, as well as configure those schemes on the server using [App Custom URL Schemes](https://docs.mattermost.com/configure/configuration-settings.html#app-custom-url-schemes).  Method to adapt on mobile is still to be improved, but requires modifications in a few `mattermost-mobile` source files for now.
They also need to be aware that the bundleid for the application should not include `rnbeta` (_exact restriction to be confirmed_)
2. This same change would be required in a custom build of the Mattermost Desktop Application (_To be confirmed_).
3. The mobile and desktop custom clients would no longer be able to log into other Mattermost servers (unless they had the same custom app schema configuration change).

NOTE:  I believe this is not an issue for customers who have `inAppSessionAuth == true` in their MDM configuration [App Config Docs](https://docs.mattermost.com/deploy/mobile-appconfig.html)

See the original post here.

This issue was generated from Mattermost using the Doc Up plugin.

QA Validation Criteria

In a generated docs preview:

cwarnermm commented 2 years ago

@sadohert - Can you help clarify what's needed for this docs request, please?

TomerPacific commented 1 month ago

@cwarnermm - What's the status of this issue? I see it is a bit old.

cwarnermm commented 1 month ago

@sadohert - Do you know if this is an active issue that needs docs updates?

TomerPacific commented 1 month ago

@cwarnermm - Should we post something on Mattermost about this?

cwarnermm commented 1 month ago

@TomerPacific - One way forward with this issue is to draft a docs PR and invite members of Engineering and Customer Reliability Engineering to provide a technical review of the docs PR. Updates are needed to this docs page. Are you interested in taking on this update?

TomerPacific commented 1 month ago

@cwarnermm - Indeed.

TomerPacific commented 1 month ago

@cwarnermm - I have created this draft PR. I tried getting the link there to point to the correct place, since it is not found here anymore ->https://docs.mattermost.com/configure/configuration-settings.html#app-custom-url-schemes. I tried doing :

:doc:App Custom URL Schemes </configure/site-configuration-settings:app custom url schemes>

but any variation of this didn't seem to work.

Leaving it up to you to add relevant personnel to the draft PR.