|
| 1 | +--- |
| 2 | +id: connect-to-platform |
| 3 | +title: 2. Connect to Runnerty Platform |
| 4 | +--- |
| 5 | + |
| 6 | +[Runnerty Platform](https://app.runnerty.io/) offers a platform to manage your runnerty projects, visualize your chains and processes in real time and much more. |
| 7 | + |
| 8 | +#### 1. Access [Runnerty Platform](https://app.runnerty.io/) and create your project: |
| 9 | + |
| 10 | + |
| 11 | + |
| 12 | +#### 2. Get your project's API Key: |
| 13 | + |
| 14 | + |
| 15 | + |
| 16 | +```json {4} title="Enter the API Key in the configuration file of your runnerty project (config.json)" |
| 17 | +{ |
| 18 | + "general": { |
| 19 | + "runnerty.io": { |
| 20 | + "apikey": "YOUR_APIKEY_HERE!" |
| 21 | + } |
| 22 | + } |
| 23 | +} |
| 24 | +``` |
| 25 | + |
| 26 | +#### 3. Enjoy Runnerty Platform |
| 27 | + |
| 28 | +In the next start of your project you will be able to visualize and control your processes and chains from Runnerty Platform. |
| 29 | + |
| 30 | +🎉🎉 Congratulations, you are know connected to Runnerty Platform! |
| 31 | + |
| 32 | +You can now visualize your executions |
| 33 | + |
| 34 | + |
| 35 | + |
| 36 | +And your chains definitions |
| 37 | + |
| 38 | + |
| 39 | + |
| 40 | +### Runnerty.io Parameters |
| 41 | + |
| 42 | +| Parameter | Default | Description | |
| 43 | +| :------------ | :----------------------- | :------------------------------------------------------------------------ | |
| 44 | +| disable | false | disable Runnerty Platform connection | |
| 45 | +| host | ws-telemetry.runnerty.io | Runnerty Platform enpoint | |
| 46 | +| healthChecker | true | enables health signal communication | |
| 47 | +| remoteControl | true | enable remote control from Runnerty platform | |
| 48 | +| debug | false | enables the debug mode of the communication module (for development only) | |
0 commit comments