Configuration
The following configuration parameters are valid for the Yak.
| Parameter | Description | Required | Default Value |
|---|---|---|---|
| api_key | Your unique Yak API key (retrieve from the user dashboard) | x | |
| api_secret | Your unique Yak API secret (retrieve from the user dashboard) | x | |
| host | Adapter host for Yak engine and node traffic | 127.0.0.1 | |
| port | Port for Yak engine and node traffic | 1238 | |
| web_port | Port for WebSocket traffic to the GUI | 1239 | |
| api_port | Port for REST API traffic | 1240 | |
| ui_port | Port for the user interface web server | 3501 | |
| enable_ssl | Enable SSL (recommended for production) | false | |
| db_driver | Database driver to use (currently only SQLite is supported) | SQLite | |
| log_path | Path to write yak.log file | yak.log | |
| log_to_file | Write log output to file | true | |
| log_to_console | Write log output to console | true |
Examples
-
Start a Yak with a default configuration
yak.exe --api_key MY_KEY --api_secret MY_SECRET -
Start a Yak on adapter 10.0.0.5
yak.exe --api_key MY_KEY --api_secret MY_SECRET --host 10.0.0.5 -
Start a Yak on adapter 10.0.0.5 and host the web GUI on port 80
yak.exe --api_key MY_KEY --api_secret MY_SECRET --host 10.0.0.5 --ui_port 80