Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Updated README with servers.json instructions #415

Merged
merged 2 commits into from
Apr 10, 2017
Merged

Updated README with servers.json instructions #415

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ffab0bc
Updated README with servers.json instructions
JSzaszvari Apr 8, 2017
53abff6
Formatting changes to readme
alexbrazier Apr 9, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 30 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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/<username>/Library/Application Support/Rocket.Chat+/servers.json
```

and on windows:
```
C:\Users\<username>\AppData\Roaming\Rocket.Chat+\servers.json
```

# Useful links

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