Skip to content

Commit dd5c36c

Browse files
committed
updated readme
1 parent a7bdef0 commit dd5c36c

File tree

1 file changed

+21
-13
lines changed

1 file changed

+21
-13
lines changed

README.md

Lines changed: 21 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -132,14 +132,21 @@ sudo rpm -e blxrep
132132

133133
blxrep uses a configuration file located at `/etc/blxrep/config.yaml` by default. You can specify a different configuration file using the `--config` flag.
134134

135-
Example configuration:
135+
Example configuration for agent:
136136

137137
```yaml
138-
mode: "dispatcher" # or "agent"
139-
id: "agent1" # required for agent mode
140-
dispatcher-addr: "localhost:8080" # required for agent mode
141-
data-dir: "/data" # required for dispatcher mode
142-
policy-dir: "/etc/blxrep/policies" # required for dispatcher mode
138+
mode: "agent"
139+
id: "hostname"
140+
dispatcher-addr: "localhost:8080"
141+
data-dir: "/data"
142+
```
143+
144+
Example configuration for dispatcher:
145+
146+
```yaml
147+
mode: "dispatcher"
148+
data-dir: "/data"
149+
policy-dir: "/etc/blxrep/policies"
143150
```
144151

145152
## Usage
@@ -153,13 +160,14 @@ blxrep start [flags]
153160
```
154161

155162
Flags:
156-
- `--mode`: Start mode ('dispatcher' or 'agent')
157-
- `--id`: Agent ID (required for agent mode)
158-
- `--dispatcher-addr`: Dispatcher address (required for agent mode, format: host:port)
159-
- `--data-dir`: Data directory (required for dispatcher mode)
160-
- `--sync-freq`: Sync frequency in minutes (required for dispatcher mode)
161-
- `--policy-dir`: Policy directory (required for dispatcher mode)
162-
- `--config`: Configuration file (optional)
163+
| Flag | Description | Required For |
164+
|------|-------------|--------------|
165+
| `--mode` | Start mode ('dispatcher' or 'agent') | Both |
166+
| `--id` | Agent ID | Agent mode |
167+
| `--dispatcher-addr` | Dispatcher address (format: host:port) | Agent mode |
168+
| `--data-dir` | Data directory | Dispatcher mode |
169+
| `--policy-dir` | Policy directory | Dispatcher mode |
170+
| `--config` | Configuration file | Optional |
163171

164172

165173
## Modes of Operation

0 commit comments

Comments
 (0)