Requirements
-------------------------------------
1. JDK 7 bit for your platform, or newer.
2. Supported browsers: Chrome, Firefox, Safari, Edge.
3. Ignite cluster should be started with `ignite-rest-http` module in classpath. For this copy `ignite-rest-http` folder from `libs\optional` to `libs` folder.


How to run
-------------------------------------
1. Unpack ignite-web-console-x.x.x.zip to some folder.
2. Start ignite-web-console-xxx executable for you platform:
	For Linux: ignite-web-console-linux
	For MacOS: ignite-web-console-macos
	For Windows: ignite-web-console-win.exe

Note: on Linux and Mac OS X `root` permission is required to bind to 80 port, but you may always start Web Console on another port if you don't have such permission.

3. Open URL `localhost` in browser.
4. Login with user `admin@admin` and password `admin`.
5. Start web agent from folder `web agent`. For Web Agent settings see `web-agent\README.txt`.
Cluster URL should be specified in `web-agent\default.properties` in `node-uri` parameter.

Technical details
-------------------------------------
1. Package content:
	`libs` - this folder contains Web Console and MongoDB binaries.
	`user_data` - this folder contains all Web Console data (registered users, created objects, ...) and should be preserved in case of update to new version.
2. Package already contains MongoDB for Mac OS X, Windows, RHEL, CentOs and Ubuntu on other platforms MongoDB will be downloaded on first start. MongoDB executables will be downloaded to `libs\mogodb` folder.
3. Web console will start on default HTTP port `80` and bind to all interfaces `0.0.0.0`.
3. To bind Web Console to specific network interface:
	On Linux: `./ignite-web-console-linux --server:host 192.168.0.1`
	On Windows: `ignite-web-console-win.exe --server:host 192.168.0.1`
4. To start Web Console on another port, for example `3000`:
	On Linux: `sudo ./ignite-web-console-linux --server:port 3000`
	On Windows: `ignite-web-console-win.exe --server:port 3000`

All available parameters with defaults:
	Web Console host:           --server:host 0.0.0.0
	Web Console port:           --server:port 80
	Enable HTTPS:               --server:ssl false
	HTTPS key:                  --server:key "serve/keys/test.key"
	HTTPS certificate:          --server:cert "serve/keys/test.crt"
	HTTPS passphrase:           --server:keyPassphrase "password"
	MongoDB URL:                --mongodb:url mongodb://localhost/console
	Mail service:               --mail:service "gmail"
	Signature text:             --mail:sign "Kind regards, Apache Ignite Team"
	Greeting text:              --mail:greeting "Apache Ignite Web Console"
	Mail FROM:                  --mail:from "Apache Ignite Web Console <someusername@somecompany.somedomain>"
	User to send e-mail:        --mail:auth:user "someusername@somecompany.somedomain"
	E-mail service password:    --mail:auth:pass ""

Troubleshooting
-------------------------------------
1. On Windows check that MongoDB is not blocked by Antivirus/Firewall/Smartscreen.
2. Root permission is required to bind to 80 port under Mac OS X and Linux, but you may always start Web Console on another port if you don't have such permission.
3. For extended debug output start Web Console as following:
	On Linux execute command in terminal: `DEBUG=mongodb-* ./ignite-web-console-linux`
	On Windows execute two commands in terminal:
		`SET DEBUG=mongodb-*`
		`ignite-web-console-win.exe`
