|
19 | 19 | 1. Configure a `.env` file
|
20 | 20 | ```bash
|
21 | 21 | LIVETL_API_KEY=
|
22 |
| - CONTROLLER_URL=wss://api.livetl.app/kanatran/ |
23 |
| - WATCHER_IMAGE=ghcr.io/livetl/watcher |
24 |
| - API_URL=https://api.livetl.app |
25 | 22 | INTERCOM_NETWORK=kanatran
|
26 | 23 | MAX_CPU=50%
|
27 | 24 | MAX_MEM=4GB
|
28 | 25 | ```
|
29 |
| - |
30 |
| - | Variable | Description | Default | Required | Values | |
31 |
| - |:---------|:------------|:--------|:---------|:-------| |
32 |
| - | `LIVETL_API_KEY` | LiveTL API Key | ` ` | ✅ | String | |
33 |
| - | `WATCHER_IMAGE` | Watcher Image Name | `ghcr.io/livetl/watcher` | ❌ | String | |
34 |
| - | `API_URL` | API URL | `https://api.livetl.app` | ❌ | String | |
35 |
| - | `INTERCOM_NETWORK` | Inter-container Bridge Network Name | `kanatran` | ❌ | String | |
36 |
| - | `CONTROLLER_URL` | Controller Address | `wss://api.livetl.app/kanatran/controller` | ❌ | String | |
37 |
| - | `INTERCOM_PORT` | Inter-container Bridge Port | `6969` | ❌ | Integer | |
38 |
| - | `MAX_CPU` | Max CPU Usage | `100%` | ❌ | Percentage (`__%`) | |
39 |
| - | `MAX_MEM` | Max Memory Usage | `100%` | ❌ | Bytes (`__GB`, `__MB`, etc.), Percentage (`__%`) | |
| 26 | + [View All Configurable Environment Variables](#Environment-Variables) |
40 | 27 |
|
41 | 28 | 1. Run the pre-built image
|
42 | 29 | ```bash
|
43 | 30 | docker run -v /var/run/docker.sock:/var/run/docker.sock --env-file .env ghcr.io/livetl/runner
|
44 | 31 | ```
|
45 | 32 |
|
| 33 | +## Environment Variables |
| 34 | + |
| 35 | +| Variable | Description | Required | Values | Default | |
| 36 | +|:---------|:------------|:---------|:-------|:--------| |
| 37 | +| `LIVETL_API_KEY` | LiveTL API Key | ✅ | String | ` ` | |
| 38 | +| `WATCHER_IMAGE` | Watcher Image Name | ❌ | String | `ghcr.io/livetl/watcher` | |
| 39 | +| `API_URL` | API URL | ❌ | String | `https://api.livetl.app` | |
| 40 | +| `INTERCOM_NETWORK` | Inter-container Bridge Network Name | ❌ | String | `kanatran` | |
| 41 | +| `CONTROLLER_URL` | Controller Address | ❌ | String | `wss://api.livetl.app/kanatran/controller` | |
| 42 | +| `INTERCOM_PORT` | Inter-container Bridge Port | ❌ | Integer | `6969` | |
| 43 | +| `MAX_CPU` | Max CPU Usage | ❌ | Percentage (`__%`) | `100%` | |
| 44 | +| `MAX_MEM` | Max Memory Usage | ❌ | Bytes (`__GB`, `__MB`, etc.), Percentage (`__%`) | `100%` | |
| 45 | + |
46 | 46 | ## Development
|
47 | 47 |
|
48 | 48 | #### Requirements
|
|
0 commit comments