📄️ Daployi User Guide
Welcome to the Daployi User Guide. This section explains, step by step, how to use the Daployi web system to manage fleets of edge devices, deploy containers and scripts, monitor telemetry, and govern users and access.
📄️ Creating and Managing Projects
Projects are the top-level container for your devices, templates, and deployments. Most settings and permissions are scoped to a project.
📄️ Generating Agent Install Commands
Use the Agent install command to onboard devices to a project securely.
📄️ Project Device Registration Token
The Project Device Registration Token authorizes new devices to join a project when running the Edge Agent install command.
📄️ Daployi Settings
Daployi Settings the setting here apply to the entire system aswell as individual users. Themes and multi-factor authentication (MFA) are per user and pertain to the currenly looged in user. Admin users cannot change these settings for other users.
📄️ Registries and Supported Types
Registries allows users to add private registries to the syetm and use them in Templates and Container deployments.
📄️ Themes: System vs Terminal vs Editor
Daployi supports two theme layers to improve usability across the app and embedded consoles. You can set personal preferences
📄️ Device View and Tabs
The Device view is your single-device operations hub. Access it from Devices > select a device. Each tab provides focused controls and insights. Below is a comprehensive guide to actions, outputs, and tips for every tab.
📄️ Widgets, Telemetry, and Reports
Widgets
📄️ Batch Actions in Device View
Batch actions allow you to run the same operation across many devices with guardrails for concurrency, timeouts, and failure thresholds.
📄️ Container View
The Container view shows all containers on a device. Use it for day‑to‑day operations, break‑fix, and verification after deployments.
📄️ Scripts
Use Scripts to run commands or small programs across devices. Scripts can be parameterized, audited, and executed ad‑hoc or as part of deployments.
📄️ Uptime View
The Uptime view shows the device’s availability over time and helps quantify reliability for SLAs.
📄️ Templates and Tabs
Templates define repeatable deployments: containers, compose stacks, environment variables, ports, volumes, scripts. This page explains every tab, the Apply button behavior, and how merges work.
📄️ Events Module
The Events module provides an audit trail and operational visibility across the platform. It records everything from Terminal connections, Tunnel activity to deployments and device actions.
📄️ Users
Manage user accounts and access to projects.
📄️ Groups
Groups are collections of users used to assign access to projects and roles at scale.
📄️ Roles
Roles define sets of permissions that can be granted to users or groups. Roles may be global or project-scoped.
📄️ Permissions
Permissions are the atomic capabilities (e.g., devices.read, templates.deploy) that are bundled into Roles. Advanced setups may customize role-to-permission mappings.
📄️ Licensing
Manage your Daployi license to unlock features and maintain compliance.
📄️ Multifactor Authentication (MFA)
MFA adds a second factor (TOTP app or hardware key) to protect accounts from password theft.
📄️ Batch Deployments and Common Errors
Batch deployments run a template across many devices simultaneously or in waves.
📄️ Template Editor Batch Functions
The Template editor includes batch functions to accelerate repetitive edits and deployments.
📄️ Waiting Room
The Waiting Room is where unapproved devices appear after running the Edge Agent without auto-approval enabled.
📄️ Updating the Edge Agent
Keep agents updated for security and new features. Updates can be targeted or rolled out in waves.
📄️ Updating the Daployi Web System
The websystem does have a update button in the UI, if a new version is detected it will prompt to install a new version. if this failes or you want to update manually you can follow the steps below. see bellow
📄️ Compose Stacks and Variables
Compose stacks let you define multi-container applications in a docker-compose style YAML within a Template. Stacks are deployed atomically per device and are the recommended way to model multi-service apps.
📄️ Files Tab (Device View)
The Files tab lets you browse and manage the device’s filesystem (within the agent’s allowed scope). Use it for quick inspections, config edits, and moving artifacts.
📄️ Terminal (Device View)
The Terminal tab opens an in‑browser shell session on the device host. Use it for quick diagnostics and break‑fix tasks.
📄️ Variables and How They Inject
Variables let you parameterize templates, compose stacks, and scripts so the same definition can run across many environments and devices.
📄️ Tunnel (Secure Port Forwarding)
The Tunnel tab creates a secure, on‑demand TCP tunnel from your browser to a service running on the device. Common use cases include accessing a local admin UI (e.g., http8080) or debugging a service that is not publicly exposed.