DocsEveryday tasks
Workflows
Short guides to the everyday tasks, with links to the pages that cover each one in detail.
Set up the hub#
| Task | Where |
|---|---|
| Install the hub with Docker Compose or as one executable | install.md |
| Create the admin account in the first hour, or recover a hub with a PIN | auth.md, quickstart.md |
| Run it on a NAS (Unraid, Synology, UGOS) | install.md |
| Sign in, sign out and change your password | auth.md. Sign-out is on the account page (click your avatar in the header). |
| Change the port or allow other computers on your network | Config, then Network, in the app: configuration.md. Keys are in config-reference.md. |
| Upgrade, back up and restore the hub | upgrade-backup-restore.md |
| Try it with fictional data | YARRIX_DEMO=1 (or calm), see settings |
Add machines#
| Task | Where |
|---|---|
| Add a host with an agent (copy-paste command, "Install it for me", PIN) | install.md, AGENT.md |
| Join with a PIN and let the agent find the hub | AGENT.md |
| Run the agent in Docker | install.md |
| Windows | platforms/windows.md |
| Read a host without an agent over SSH, or through a relay | collection-methods.md |
| Keep agents up to date (notify, one click, automatic) | AGENT.md |
| Open a shell on a host from the browser | terminal.md |
Watch things#
| Task | Where |
|---|---|
Heartbeats for jobs: yarrix run and ping URLs | heartbeats.md |
| App checks | app-checks.md |
| Backup checks | backups.md |
| Where alerts go, test an alert, acknowledge, snooze, silence | alert-routing.md |
| Edit the configuration (Config page, files, errors) | configuration.md |
Use it from scripts and tools#
| Task | Where |
|---|---|
| API tokens, the API tab, the REST API | mcp-and-cli.md |
The yarrix command and the MCP server | mcp-and-cli.md |
Security#
How passwords, tokens and SSH keys are handled: security.md.