README
¶
Arveld
Arveld is a self-hosted uptime monitor for homelabs and small teams. Monitor websites, APIs and network services from Agents on your own infrastructure.
- Check HTTP/HTTPS, TCP, ICMP and DNS targets.
- Track availability, response times and host metrics.
- Send alerts through email, Discord, Slack, Microsoft Teams, Telegram, PagerDuty or webhooks.
- Keep configuration, incident history and metrics on your infrastructure.
Documentation
Start with the user guide. It covers installation, Agents, Monitors and notifications, followed by HTTPS, backups and updates.
Read the documentation at arveld.com. Its source lives
in docs/; the website in website/ publishes that same Markdown alongside the
landing page.
Arveld is public and in prerelease. Check
GitHub Releases for published
Linux amd64 and arm64 candidates and their GHCR images. Install a candidate
using the versioned installation instructions.
The Getting Started convenience scripts are reserved
for stable releases and become available with the first stable promotion.
If no candidate is published, build from source.
Development
See the codebase map,
verification guide and
website guide. The product frontend lives in
web/; it is embedded in the controller executable when built.
Security and contributions
See SECURITY.md for private vulnerability reporting and CONTRIBUTING.md for the development workflow.
License
Arveld is licensed under the Apache License 2.0.
Copyright 2026 RSTCK Innovation. See NOTICE.
Release archives and images include generated THIRD_PARTY_NOTICES.txt files
with the dependency license texts; see release packaging.
Third-party components retain their own copyrights and licenses.
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
arveld
command
Arveld starts the Arveld controller.
|
Arveld starts the Arveld controller. |
|
internal
|
|
|
agent
Package agent models the collectors managed by Arveld.
|
Package agent models the collectors managed by Arveld. |
|
agentauth
Package agentauth authenticates machine requests from agents and collectors.
|
Package agentauth authenticates machine requests from agents and collectors. |
|
alert
Package alert owns persisted resource alert rules and their publication to Prometheus.
|
Package alert owns persisted resource alert rules and their publication to Prometheus. |
|
app
Package app owns the controller process lifecycle.
|
Package app owns the controller process lifecycle. |
|
auth
Package auth authenticates the local Arveld administrator.
|
Package auth authenticates the local Arveld administrator. |
|
components
Package components resolves the upstream executables managed by Arveld.
|
Package components resolves the upstream executables managed by Arveld. |
|
configuration
Package configuration compiles Arveld specifications into Collector configuration.
|
Package configuration compiles Arveld specifications into Collector configuration. |
|
database
Package database owns the controller's SQLite connection.
|
Package database owns the controller's SQLite connection. |
|
httpapi
Package httpapi exposes the controller HTTP API with standard net/http handlers and chi.
|
Package httpapi exposes the controller HTTP API with standard net/http handlers and chi. |
|
monitor
Package monitor owns persisted Monitor definitions and Agent assignments.
|
Package monitor owns persisted Monitor definitions and Agent assignments. |
|
notification
Package notification owns persisted notification destinations.
|
Package notification owns persisted notification destinations. |
|
opamp
Package opamp integrates the OpAMP server into the Arveld controller.
|
Package opamp integrates the OpAMP server into the Arveld controller. |
|
prometheus
Package prometheus calls the Prometheus HTTP API used by Arveld.
|
Package prometheus calls the Prometheus HTTP API used by Arveld. |
|
remoteconfig
Package remoteconfig owns desired collector configuration revisions.
|
Package remoteconfig owns desired collector configuration revisions. |
|
tests
|
|
|
testutil
Package testutil provides database fixtures shared by module and integration tests.
|
Package testutil provides database fixtures shared by module and integration tests. |
|
Package web serves the production frontend embedded when Arveld is built.
|
Package web serves the production frontend embedded when Arveld is built. |