Install it, run it, and the reference for every part
Documentation
How to install Vigile and run it, and the reference for every part.
New here? Install and first run ends with a board in a browser and an agent connected. For the ideas, read How it works.
This describes Vigile 0.1.0. The pages about operations, settings, commands and errors are made from what the program says of itself, with vigile describe, so they say what it does.
Contents
Start
- Install and first runFrom nothing to a running service, a board in the browser and an agent connected.
- The web pageThe board, the graph, History, the panel of an item, addresses, settings and themes.
Interfaces
- The command lineEvery command and option of vigile, its output for scripts, and its exit codes.
- The HTTP APIHow to call an operation, the shape of an error, and the stream of changes.
- MCP for agentsHow to connect an agent, a user and key for each, and what an agent is told.
Reference
- OperationsEvery operation, each with its input, an example that was run, and its errors.
- The modelStatuses and moves, types, link types, IDs and limits, for looking things up.
- Errors and refusalsEvery error code, every rule a change can be refused by, and what to do.
- ConfigurationEvery setting, its default, its environment variable, and when a change applies.
- The guide for agentsWhat the service tells an agent about itself, word for word.
Running it
- Storage, backup and restoreThe files of an instance, backup, restore, moving and upgrading.
- SecurityThe defaults, the two changes to make before it faces a network, and the limits.
- TroubleshootingThe doctor and its checks, the log, and what to do when a command gets no answer.
Find something
| Looking for | Go to |
|---|---|
An operation, such as set_task_status | Operations |
A setting, such as listen.port | Configuration |
| A command or an option | The command line |
An error code or a rule, such as unfinished_dependencies | Errors and refusals |
| A status, a link type or a limit | The model |
The search in the header looks through every page.