docs icon indicating copy to clipboard operation
docs copied to clipboard

Help Wanted: Files used by Desktop App

Open matterdoc opened this issue 5 years ago • 6 comments

Mattermost user guillermo.vaya from https://community-release.mattermost.com has requested the following be documented:

I think the directory is `~/Library/Application Support/Mattermost` and I also wonder about the content so I searched and wrote some thoughts. I would like to know how Mattermost uses it.

* `IndexedDB` has several databases; one per Mattermost server where I assume the bulk content is stored.
  * The [LevelDB Wikipedia](https://en.wikipedia.org/wiki/LevelDB) says these are used as the backend for [Google Chrome's IndexedDB](https://developer.mozilla.org/en-US/docs/Web/API/IndexedDB_API).
* `GPUCache` and `blob_storage` 
  * part of the Chromium embedded framework?
  * Activity Monitor says Mattermost uses [Apple Metal](https://developer.apple.com/metal/) so maybe `GPUCache` is in support of that?
* `QuotaManager` (4 tables) and `Cookies` (2 tables) are SQL Lite databases.
  * part of the Chromium embedded framework?
  * Should people be concerned about YouTube and Doubleclick.net cookies here?
* `Cache` and `Code Cache` look to hold Javascript.
* Several `uncaughtException-XXXXXXXXXXXXX.txt` files from application crashes?
* `bounds-info.json` seems to be the main window screen size and location.
* `config.json` is the local configuration file for the application.
  * servers, notification settings, tray icon settings, etc.
* `Preferences` is a JSON object file.
  * settings for "brightray/devtools" (Electron stuff)
  * media device id salt
  * some kind of partition info that looks to be one for each server??
  * a last directory for file selection
* `app-state.json` holds the last application version.
* `permission.json` has a notification setting for one of my configured Mattermost servers.
* `Network Persistent State` is a JSON file with about 10, in my case, servers (e.g. api.segment.io, gstatic.com, googleapis.com, image-proxy.mattermost.com, etc.) and if they support the `SPDY` protocol or not.

See the original post here.

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

matterdoc avatar Feb 01 '20 08:02 matterdoc

Hi @Willyfrog, thanks for this. Do you have an idea of where this update should be added in terms of the documentation? If not, @icelander, do you have any suggestions? Thanks!

justinegeffen avatar Mar 30 '20 18:03 justinegeffen

I don’t think there is a documentation for how the desktop app is setup, is there? Something like the admin handbook but for apps? Maybe we should add a section there? Not really sure, sorry

Willyfrog avatar Mar 30 '20 19:03 Willyfrog

Thanks, @Willyfrog. The two places I had in mine were in the Deployment Guide and the Installation Guide. Would you be open to taking a look at those and letting me know whether either would be a good fit? :)

justinegeffen avatar Mar 31 '20 12:03 justinegeffen

I'd say that deployment guide is probably the better option

Willyfrog avatar Apr 01 '20 10:04 Willyfrog

Can I take this?

M-ZubairAhmed avatar Jul 27 '21 06:07 M-ZubairAhmed

sure! thanks!

Willyfrog avatar Jul 27 '21 07:07 Willyfrog

Documented by: https://developers.mattermost.com/contribute/more-info/desktop/

cwarnermm avatar Aug 17 '23 14:08 cwarnermm