diff --git a/README.md b/README.md index 4271c79910..275199172b 100644 --- a/README.md +++ b/README.md @@ -135,6 +135,36 @@ You can create Windows installer only when running on Windows, the same is true All packaging actions are handled by [electron-builder](https://github.com/electron-userland/electron-builder). It has a lot of [customization options](https://github.com/electron-userland/electron-builder/wiki/Options), which you can declare under ["build" key in package.json file](https://github.com/szwacz/electron-boilerplate/blob/master/package.json#L2). +# Post Release Configuration +## Deploying with pre-configured servers +You can bundle a `servers.json` with the install which will define what servers the client will connect to and will populate the server list in the sidebar. + +If this file is found, the initial "Connect to server" screen will be skipped and it will attempt to connect to the first server in the array that has been defined and drop the user right at the login screen. + +The `servers.json` file needs to be placed in the `%APPDATA%` folder for the User not the System wide one. + +``` +%APPDATA%/Rocket.Chat+/servers.json +``` + +The syntax/layout of servers.json is as follows: +``` +{ + "MyRocketChatServer": "https://my-chat-server-url.com", + "Server2": "https://demo.rocket.chat" +} +``` + +On MacOS the full path of servers.json is: +``` +/Users//Library/Application Support/Rocket.Chat+/servers.json +``` + +and on windows: +``` +C:\Users\\AppData\Roaming\Rocket.Chat+\servers.json +``` + # Useful links http://developerthing.blogspot.com.br/2017/01/awesome-electron.html