26 lines
744 B
Markdown
26 lines
744 B
Markdown
# Folyo Client
|
|
|
|
The Folyo client is a small agent that connects to the Folyo server over WebSockets and registers itself as a device. Once connected and authenticated, it waits for command execution requests, runs them locally through `sh -c`, and sends the exit code, stdout, and stderr back to the server.
|
|
|
|
## Building
|
|
|
|
Build the binary:
|
|
|
|
```bash
|
|
cargo build --release
|
|
```
|
|
|
|
Build the image:
|
|
|
|
```bash
|
|
docker build -t client .
|
|
```
|
|
|
|
## Configuration
|
|
|
|
- `TOKEN` is required and is sent as `Authorization: Bearer <token>`
|
|
- `BASE_URL` is optional and defaults to `ws://127.0.0.1:8000`
|
|
- `DEVICE_ID` is optional and defaults to `device`
|
|
- `PING_INTERVAL_SECS` is optional and defaults to `30`
|
|
- `PING_TIMEOUT_SECS` is optional and defaults to `10`
|