From ffab0bc09bfe3848a1b6e3b35d4f11e23c708014 Mon Sep 17 00:00:00 2001 From: John Szaszvari Date: Sat, 8 Apr 2017 19:41:50 +1000 Subject: [PATCH 1/2] Updated README with servers.json instructions --- README.md | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) diff --git a/README.md b/README.md index 4271c79910f2..5f1852508fb7 100644 --- a/README.md +++ b/README.md @@ -135,6 +135,35 @@ 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 will define what servers the client will connect 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. + +servers.json 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 From 53abff60655baf72fdeaa1b9df56ca7df65be90b Mon Sep 17 00:00:00 2001 From: Alex Brazier Date: Sun, 9 Apr 2017 22:50:37 +0100 Subject: [PATCH 2/2] Formatting changes to readme --- README.md | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 5f1852508fb7..275199172bf0 100644 --- a/README.md +++ b/README.md @@ -137,11 +137,11 @@ All packaging actions are handled by [electron-builder](https://github.com/elect # Post Release Configuration ## Deploying with pre-configured servers -You can bundle a 'servers.json' with the install will define what servers the client will connect and will populate the server list in the sidebar. +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. +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. -servers.json needs to be placed in the %APPDATA% folder for the User not the System wide one. +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 @@ -150,8 +150,8 @@ servers.json needs to be placed in the %APPDATA% folder for the User not the Sys The syntax/layout of servers.json is as follows: ``` { -"MyRocketChatServer": "https://my-chat-server-url.com", -"Server2": "https://demo.rocket.chat" + "MyRocketChatServer": "https://my-chat-server-url.com", + "Server2": "https://demo.rocket.chat" } ``` @@ -164,6 +164,7 @@ and on windows: ``` C:\Users\\AppData\Roaming\Rocket.Chat+\servers.json ``` + # Useful links http://developerthing.blogspot.com.br/2017/01/awesome-electron.html