modules/

directory
v0.0.0-...-b380bb8 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 18, 2026 License: MIT

Directories

Path Synopsis
cellular
cmd/cellular command
internal/at
Package at manages a serial command session.
Package at manages a serial command session.
internal/modem
Package modem discovers Quectel modules and collects their cellular status.
Package modem discovers Quectel modules and collects their cellular status.
web
Package web exposes the cellular monitor through the panel module contract.
Package web exposes the cellular monitor through the panel module contract.
ci
api
Package api queues and runs builds, keeps their history and logs, takes webhooks from git hosts, and serves it all as a JSON API with relative routes.
Package api queues and runs builds, keeps their history and logs, takes webhooks from git hosts, and serves it all as a JSON API with relative routes.
cmd/ci-go command
Command ci-go serves the CI on its own: builds run in Docker containers on the daemon the docker CLI would use, and the UI and API manage them.
Command ci-go serves the CI on its own: builds run in Docker containers on the daemon the docker CLI would use, and the UI and API manage them.
docker
Package docker is the small part of the Docker Engine API that ci-go needs: pulling images, running containers and following their output, and removing what a build created.
Package docker is the small part of the Docker Engine API that ci-go needs: pulling images, running containers and following their output, and removing what a build created.
pipeline
Package pipeline reads a repository's .ci.yml and runs it: each step in a container of its own, sharing the checked-out workspace.
Package pipeline reads a repository's .ci.yml and runs it: each step in a container of its own, sharing the checked-out workspace.
store
Package store keeps repositories, builds and their step logs in SQLite.
Package store keeps repositories, builds and their step logs in SQLite.
web
Package web assembles the CI as a panel module: repositories and builds in SQLite, the build queue running steps in Docker containers, the JSON API with its webhook endpoint, and the browser UI (native ES modules in ui/, no build step).
Package web assembles the CI as a panel module: repositories and builds in SQLite, the build queue running steps in Docker containers, the JSON API with its webhook endpoint, and the browser UI (native ES modules in ui/, no build step).
cron
api
Package api schedules jobs, runs them on their targets and keeps their history, and serves all of it as a JSON API with relative routes.
Package api schedules jobs, runs them on their targets and keeps their history, and serves all of it as a JSON API with relative routes.
cmd/cron-go command
Command cron-go serves the job scheduler on its own: jobs run in this process, as its user, and the UI and API manage them.
Command cron-go serves the job scheduler on its own: jobs run in this process, as its user, and the UI and API manage them.
runner
Package runner defines where job commands run.
Package runner defines where job commands run.
schedule
Package schedule parses cron expressions and computes when they fire.
Package schedule parses cron expressions and computes when they fire.
store
Package store keeps jobs and their run history in SQLite.
Package store keeps jobs and their run history in SQLite.
web
Package web assembles the job scheduler as a panel module: jobs and their history in SQLite, the scheduler, the JSON API and the browser UI (native ES modules in ui/, no build step).
Package web assembles the job scheduler as a panel module: jobs and their history in SQLite, the scheduler, the JSON API and the browser UI (native ES modules in ui/, no build step).
diskmgr
api
Package api is the disk module's JSON API: capacity of the mounted file systems, software RAID arrays, and the disks with their SMART health and self-tests.
Package api is the disk module's JSON API: capacity of the mounted file systems, software RAID arrays, and the disks with their SMART health and self-tests.
cmd/diskmgr command
Command diskmgr serves the disk module on its own: the UI and API show capacity, RAID arrays and SMART health, and start self-tests; smartctl needs root.
Command diskmgr serves the disk module on its own: the UI and API show capacity, RAID arrays and SMART health, and start self-tests; smartctl needs root.
system
Package system reads a host's storage: block devices (lsblk on Linux, diskutil on macOS), mounted file systems and their capacity (df), software RAID arrays (/proc/mdstat, Linux) and disk health (smartctl, through smartctl-go).
Package system reads a host's storage: block devices (lsblk on Linux, diskutil on macOS), mounted file systems and their capacity (df), software RAID arrays (/proc/mdstat, Linux) and disk health (smartctl, through smartctl-go).
web
Package web assembles the disk module for a panel: the JSON API and the browser UI (native ES modules in ui/, no build step).
Package web assembles the disk module for a panel: the JSON API and the browser UI (native ES modules in ui/, no build step).
domains
api
Package api manages DNS provider accounts and the zones and records they hold, as a JSON API with relative routes, and publishes ACME DNS-01 records in them (see Challenges).
Package api manages DNS provider accounts and the zones and records they hold, as a JSON API with relative routes, and publishes ACME DNS-01 records in them (see Challenges).
cmd/domains command
Command domains serves the domains module on its own: DNS provider accounts (Cloudflare, …) and the zones and records they hold.
Command domains serves the domains module on its own: DNS provider accounts (Cloudflare, …) and the zones and records they hold.
provider
Package provider describes DNS hosting services (Cloudflare, …) through one interface: the zones an account holds and their records.
Package provider describes DNS hosting services (Cloudflare, …) through one interface: the zones an account holds and their records.
provider/cloudflare
Package cloudflare is the Cloudflare DNS provider, on the v4 REST API with an API token.
Package cloudflare is the Cloudflare DNS provider, on the v4 REST API with an API token.
provider/dnspod
Package dnspod implements DNSPod's traditional mainland API (DNSPod Token).
Package dnspod implements DNSPod's traditional mainland API (DNSPod Token).
provider/namecom
Package namecom manages Name.com DNS through its v4 REST API.
Package namecom manages Name.com DNS through its v4 REST API.
store
Package store keeps DNS provider accounts in SQLite.
Package store keeps DNS provider accounts in SQLite.
web
Package web assembles the domains module: DNS provider accounts in SQLite, the JSON API, and the browser UI (native ES modules in ui/, no build step).
Package web assembles the domains module: DNS provider accounts in SQLite, the JSON API, and the browser UI (native ES modules in ui/, no build step).
filemgr
api
Package api is the file manager's JSON API.
Package api is the file manager's JSON API.
cmd/filemgr command
Command filemgr serves the file manager on its own: the UI and API browse, view, edit, upload, download, move, copy and delete files under a root directory, as the user running it.
Command filemgr serves the file manager on its own: the UI and API browse, view, edit, upload, download, move, copy and delete files under a root directory, as the user running it.
files
Package files carries out file operations under a root directory: listing, reading and writing text, uploads, downloads (directories as tar.gz), creating folders, renaming, moving, copying and deleting.
Package files carries out file operations under a root directory: listing, reading and writing text, uploads, downloads (directories as tar.gz), creating folders, renaming, moving, copying and deleting.
web
Package web assembles the file manager for a panel: the JSON API and the browser UI (native ES modules in ui/, no build step).
Package web assembles the file manager for a panel: the JSON API and the browser UI (native ES modules in ui/, no build step).
fwmgr
api
Package api is the firewall manager's JSON API.
Package api is the firewall manager's JSON API.
cmd/fwmgr command
Command fwmgr serves the firewall manager on its own: the UI and API change interface settings, so it usually runs as root.
Command fwmgr serves the firewall manager on its own: the UI and API change interface settings, so it usually runs as root.
system
Package system renders and applies one nftables table: protection for the interfaces that face the internet, and NAT for what leaves through them.
Package system renders and applies one nftables table: protection for the interfaces that face the internet, and NAT for what leaves through them.
web
Package web assembles the firewall manager as a panel module: the JSON API and the browser UI (native ES modules in ui/, no build step).
Package web assembles the firewall manager as a panel module: the JSON API and the browser UI (native ES modules in ui/, no build step).
monitor
api
Package api samples every monitored host on an interval, keeps their history, and serves both as a JSON API with relative routes.
Package api samples every monitored host on an interval, keeps their history, and serves both as a JSON API with relative routes.
cmd/monitor-go command
Command monitor-go monitors this machine on its own: it samples CPU, memory, disks and network, keeps their history and serves the UI and API.
Command monitor-go monitors this machine on its own: it samples CPU, memory, disks and network, keeps their history and serves the UI and API.
collector
Package collector defines where readings come from.
Package collector defines where readings come from.
metrics
Package metrics defines what monitor-go measures: a Reading is what a collector reads from a host at one moment (with cumulative counters), and a Sample is what two consecutive readings say about the time between them (usage percentages and rates).
Package metrics defines what monitor-go measures: a Reading is what a collector reads from a host at one moment (with cumulative counters), and a Sample is what two consecutive readings say about the time between them (usage percentages and rates).
procfs
Package procfs reads a Linux host through a shell: Script prints what /proc and a few commands say, in one round trip, and Parse turns that output into a reading and host info.
Package procfs reads a Linux host through a shell: Script prints what /proc and a few commands say, in one round trip, and Parse turns that output into a reading and host info.
store
Package store keeps hosts and their samples in SQLite, at three resolutions: raw samples for a day, one-minute averages for a week and one-hour averages for three months, so the database stays small however long it runs.
Package store keeps hosts and their samples in SQLite, at three resolutions: raw samples for a day, one-minute averages for a week and one-hour averages for three months, so the database stays small however long it runs.
web
Package web assembles the host monitor as a panel module: the sampler, its SQLite history, the JSON API and the browser UI (native ES modules in ui/, no build step).
Package web assembles the host monitor as a panel module: the sampler, its SQLite history, the JSON API and the browser UI (native ES modules in ui/, no build step).
netmgr
api
Package api is the network manager's JSON API: interfaces, routes, DNS servers, listening ports and diagnostics to read, and interface settings to change.
Package api is the network manager's JSON API: interfaces, routes, DNS servers, listening ports and diagnostics to read, and interface settings to change.
cmd/netmgr command
Command netmgr serves the network manager on its own: the UI and API change interface settings, so it usually runs as root.
Command netmgr serves the network manager on its own: the UI and API change interface settings, so it usually runs as root.
system
Bridges join interfaces into one network, as a switch does.
Bridges join interfaces into one network, as a switch does.
web
Package web assembles the network manager as a panel module: the JSON API and the browser UI (native ES modules in ui/, no build step).
Package web assembles the network manager as a panel module: the JSON API and the browser UI (native ES modules in ui/, no build step).
notify
api
Package api is the notification center: it records what modules and scripts report, keeps track of the problems still open, and serves both as a JSON API with relative routes.
Package api is the notification center: it records what modules and scripts report, keeps track of the problems still open, and serves both as a JSON API with relative routes.
channels
Package channels sends messages out: to any web hook, with presets for the common services, and to Telegram.
Package channels sends messages out: to any web hook, with presets for the common services, and to Telegram.
cmd/notify-go command
Command notify-go serves the notification center on its own; a panel shell can mount the same module (web.New) beside others instead.
Command notify-go serves the notification center on its own; a panel shell can mount the same module (web.New) beside others instead.
store
Package store keeps events and issues in SQLite, in tables prefixed "notify_", so the database can be shared with other modules.
Package store keeps events and issues in SQLite, in tables prefixed "notify_", so the database can be shared with other modules.
web
Package web assembles the notification center as a panel module: events and issues in SQLite, the JSON API and the browser UI (native ES modules in ui/, no build step).
Package web assembles the notification center as a panel module: events and issues in SQLite, the JSON API and the browser UI (native ES modules in ui/, no build step).
pkgmgr
api
Package api is the package manager's service and JSON API.
Package api is the package manager's service and JSON API.
cmd/pkgmgr command
Command pkgmgr serves the package manager on its own: the UI and API install, remove and upgrade the system's packages with dnf or apt, so it usually runs as root.
Command pkgmgr serves the package manager on its own: the UI and API install, remove and upgrade the system's packages with dnf or apt, so it usually runs as root.
system
Package system drives the host's package manager through its command-line tools: dnf on Fedora and Enterprise Linux (RHEL, Rocky, AlmaLinux, Alibaba Cloud Linux, …), apt on Debian and Ubuntu, pacman on Arch Linux, and Homebrew on macOS.
Package system drives the host's package manager through its command-line tools: dnf on Fedora and Enterprise Linux (RHEL, Rocky, AlmaLinux, Alibaba Cloud Linux, …), apt on Debian and Ubuntu, pacman on Arch Linux, and Homebrew on macOS.
web
Package web assembles the package manager as a panel module: the JSON API and the browser UI (native ES modules in ui/, no build step).
Package web assembles the package manager as a panel module: the JSON API and the browser UI (native ES modules in ui/, no build step).
smbmgr
api
Package api is the Samba manager's JSON API: shares and server settings edited as parameters, smb.conf edited as text, Samba users, and who is connected.
Package api is the Samba manager's JSON API: shares and server settings edited as parameters, smb.conf edited as text, Samba users, and who is connected.
cmd/smbmgr command
Command smbmgr serves the Samba manager on its own: the UI and API edit smb.conf and Samba users, so it usually runs as root.
Command smbmgr serves the Samba manager on its own: the UI and API edit smb.conf and Samba users, so it usually runs as root.
system
Package system reads and changes a Samba server: its smb.conf, checked with testparm before it replaces the file, its users (smbpasswd and pdbedit) and who is connected (smbstatus).
Package system reads and changes a Samba server: its smb.conf, checked with testparm before it replaces the file, its users (smbpasswd and pdbedit) and who is connected (smbstatus).
web
Package web assembles the Samba manager as a panel module: the JSON API and the browser UI (native ES modules in ui/, no build step).
Package web assembles the Samba manager as a panel module: the JSON API and the browser UI (native ES modules in ui/, no build step).
ssh
api
Package api manages saved SSH hosts and opens terminals on them, as a JSON API with relative routes plus a WebSocket terminal.
Package api manages saved SSH hosts and opens terminals on them, as a JSON API with relative routes plus a WebSocket terminal.
cmd/ssh-go command
Command ssh-go serves the SSH terminal on its own: saved hosts and a web terminal on each.
Command ssh-go serves the SSH terminal on its own: saved hosts and a web terminal on each.
hosts
Package hosts describes saved SSH hosts and connects to them: password, private key or the panel's own key authentication, and host keys pinned on first use.
Package hosts describes saved SSH hosts and connects to them: password, private key or the panel's own key authentication, and host keys pinned on first use.
store
Package store keeps SSH hosts and the panel key in SQLite.
Package store keeps SSH hosts and the panel key in SQLite.
web
Package web assembles the SSH terminal as a panel module: saved hosts in SQLite, the JSON API with its WebSocket terminal, and the browser UI (native ES modules in ui/, no build step).
Package web assembles the SSH terminal as a panel module: saved hosts in SQLite, the JSON API with its WebSocket terminal, and the browser UI (native ES modules in ui/, no build step).
svcmgr
api
Package api is the service manager's JSON API: systemd services, their state, actions and unit files, and the journal, which it can also stream as server-sent events.
Package api is the service manager's JSON API: systemd services, their state, actions and unit files, and the journal, which it can also stream as server-sent events.
cmd/svcmgr command
Command svcmgr serves the service manager on its own: the UI and API start, stop and enable systemd services and read the journal, so it usually runs as root.
Command svcmgr serves the service manager on its own: the UI and API start, stop and enable systemd services and read the journal, so it usually runs as root.
system
Package system drives systemd through systemctl and journalctl: listing services, showing their state and unit files, starting and stopping them, and reading the journal.
Package system drives systemd through systemctl and journalctl: listing services, showing their state and unit files, starting and stopping them, and reading the journal.
web
Package web assembles the service manager as a panel module: the JSON API and the browser UI (native ES modules in ui/, no build step).
Package web assembles the service manager as a panel module: the JSON API and the browser UI (native ES modules in ui/, no build step).
xray
cmd/xray-go command
Command xray-go serves the Xray module on its own.
Command xray-go serves the Xray module on its own.
engine
Package engine manages one embedded Xray instance and its saved configuration.
Package engine manages one embedded Xray instance and its saved configuration.
web
Package web exposes the embedded Xray engine as a panel module.
Package web exposes the embedded Xray engine as a panel module.
zfsmgr
api
Package api is the ZFS snapshot manager's JSON API: snapshots to list, take, rename, compare, delete and roll back to, and the retention policies a scheduler applies to datasets.
Package api is the ZFS snapshot manager's JSON API: snapshots to list, take, rename, compare, delete and roll back to, and the retention policies a scheduler applies to datasets.
cmd/zfsmgr command
Command zfsmgr serves the ZFS snapshot manager on its own: it runs zfs, so it usually runs as root, and applies retention policies for as long as it runs.
Command zfsmgr serves the ZFS snapshot manager on its own: it runs zfs, so it usually runs as root, and applies retention policies for as long as it runs.
system
Package system drives the zfs and zpool commands.
Package system drives the zfs and zpool commands.
web
Package web assembles the ZFS snapshot manager as a panel module: the JSON API, what applies retention policies, and the browser UI (native ES modules in ui/, no build step).
Package web assembles the ZFS snapshot manager as a panel module: the JSON API, what applies retention policies, and the browser UI (native ES modules in ui/, no build step).

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL