Skip to content

Commit a41f62b

Browse files
authored
Merge pull request #415 from jszaszvari/patch-1
Updated README with servers.json instructions
2 parents 5215afc + 53abff6 commit a41f62b

1 file changed

Lines changed: 30 additions & 0 deletions

File tree

README.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -135,6 +135,36 @@ You can create Windows installer only when running on Windows, the same is true
135135

136136
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).
137137

138+
# Post Release Configuration
139+
## Deploying with pre-configured servers
140+
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.
141+
142+
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.
143+
144+
The `servers.json` file needs to be placed in the `%APPDATA%` folder for the User not the System wide one.
145+
146+
```
147+
%APPDATA%/Rocket.Chat+/servers.json
148+
```
149+
150+
The syntax/layout of servers.json is as follows:
151+
```
152+
{
153+
"MyRocketChatServer": "https://my-chat-server-url.com",
154+
"Server2": "https://demo.rocket.chat"
155+
}
156+
```
157+
158+
On MacOS the full path of servers.json is:
159+
```
160+
/Users/<username>/Library/Application Support/Rocket.Chat+/servers.json
161+
```
162+
163+
and on windows:
164+
```
165+
C:\Users\<username>\AppData\Roaming\Rocket.Chat+\servers.json
166+
```
167+
138168
# Useful links
139169

140170
http://developerthing.blogspot.com.br/2017/01/awesome-electron.html

0 commit comments

Comments
 (0)