Merge pull request from vector-im/t3chguy/local-config

Document some desktop app things
This commit is contained in:
J. Ryan Stinnett 2019-03-15 17:53:55 +00:00 committed by GitHub
commit faa9932c77
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 12 additions and 0 deletions

View File

@ -240,6 +240,18 @@ yarn global add nativefier
nativefier https://riot.im/app/ nativefier https://riot.im/app/
``` ```
Desktop app configuration
=========================
To run multiple instances of the desktop app for different accounts, you can launch the executable with the `--profile` argument followed by a unique identifier, e.g `riot-web --profile Work` for it to run a separate profile and not interfere with the default one.
To change the config.json for the desktop app, create a config file which will be used to override values in the config which ships in the package:
+ `%APPDATA%\$NAME\config.json` on Windows
+ `$XDG_CONFIG_HOME\$NAME\config.json` or `~/.config/$NAME/config.json` on Linux
+ `~Library/Application Support/$NAME/config.json` on macOS
In the paths above, `$NAME` is typically `Riot`, unless you use `--profile $PROFILE` in which case it becomes `Riot-$PROFILE`.
Development Development
=========== ===========