# CDelivery

English documentation for installing CDelivery and operating applications.

- [Platform management](https://cdelivery.dev/docs/administration/index.md): Manage servers, groups, accounts, permissions, and CDelivery maintenance.
- [Personal account and login security](https://cdelivery.dev/docs/administration/accounts/profile/index.md): Manage your profile, password, two-factor authentication, preferences, and connections.
- [Roles and permissions](https://cdelivery.dev/docs/administration/accounts/roles/index.md): Compare Reader, Operator, and Admin across the console, API keys, messaging, and AI on-call.
- [User management](https://cdelivery.dev/docs/administration/accounts/users/index.md): Create accounts, change roles, reset login credentials, and understand account deletion.
- [Group management](https://cdelivery.dev/docs/administration/groups/index.md): Organize applications and shared communication while understanding naming and deletion constraints.
- [Server management](https://cdelivery.dev/docs/administration/nodes/index.md): Join servers, interpret their state, and check dependencies before removal.
- [Server labels](https://cdelivery.dev/docs/administration/nodes/labels/index.md): Organize eligible servers for placement and understand complete label-set updates.
- [Volume management](https://cdelivery.dev/docs/administration/nodes/volumes/index.md): Enable the volume component and manage persistent data on a particular server.
- [Platform domain and access](https://cdelivery.dev/docs/administration/platform/access/index.md): Configure a domain and HTTPS for the console while preserving a verified management path.
- [Recover management access](https://cdelivery.dev/docs/administration/platform/recovery/index.md): Use the host management CLI to reset an account, add an administrator, or issue a temporary API key.
- [Uninstall and cleanup](https://cdelivery.dev/docs/administration/platform/uninstall/index.md): Preview resource removal and understand retained volumes and interrupted cleanup.
- [Upgrades and versions](https://cdelivery.dev/docs/administration/platform/upgrades/index.md): Update the main program and independent components, then verify each capability.
- [Deploy your first application](https://cdelivery.dev/docs/getting-started/first-app/index.md): Deploy Nginx with a published port and verify its response from a client.
- [Install CDelivery](https://cdelivery.dev/docs/getting-started/installation/index.md): Install CDelivery, create the first administrator, and open the dashboard.
- [Before installation](https://cdelivery.dev/docs/getting-started/requirements/index.md): Plan server addresses, network ports, console access, and data storage before installing.
- [Applications](https://cdelivery.dev/docs/guides/apps/index.md): Understand application configuration, runtime state, and the operations used throughout its lifecycle.
- [Startup commands and environment variables](https://cdelivery.dev/docs/guides/apps/container/index.md): Configure the container process and environment without confusing command parsing with shell execution.
- [Create and deploy an application](https://cdelivery.dev/docs/guides/apps/create/index.md): Choose an image or template, configure an application, and verify its first deployment.
- [Delete an application](https://cdelivery.dev/docs/guides/apps/delete/index.md): Remove an application and its checks and jobs while understanding retained data and asynchronous cleanup.
- [Images and registries](https://cdelivery.dev/docs/guides/apps/images/index.md): Select image versions, configure private registry credentials, and diagnose image pulls.
- [Update and restart applications](https://cdelivery.dev/docs/guides/apps/lifecycle/index.md): Distinguish saving configuration, restarting tasks, and rolling back a previous application change.
- [Data persistence](https://cdelivery.dev/docs/guides/apps/persistence/index.md): Choose storage for mutable data and distinguish volumes from configuration and application rollback.
- [Stateful applications](https://cdelivery.dev/docs/guides/apps/persistence/stateful/index.md): Deploy a single replica with local data on a fixed server and plan updates and recovery.
- [Server selection and placement](https://cdelivery.dev/docs/guides/apps/placement/index.md): Select eligible servers and per-server replica limits while accounting for capacity and local data.
- [Resource reservations and limits](https://cdelivery.dev/docs/guides/apps/resources/index.md): Set per-replica CPU and memory requirements and diagnose capacity-related failures.
- [Replicas and automatic scaling](https://cdelivery.dev/docs/guides/apps/scaling/index.md): Configure fixed or automatic replica counts and understand sampling, capacity, and scaling limits.
- [Configuration files with XConfig](https://cdelivery.dev/docs/guides/apps/xconfig/index.md): Upload application configuration, mount files, and understand their visibility and update behavior.
- [Mount and update configuration files](https://cdelivery.dev/docs/guides/apps/xconfig/mounting/index.md): Replace XConfig content, change mount paths, and verify that new tasks consume the intended file.
- [Automation](https://cdelivery.dev/docs/guides/automation/index.md): Schedule jobs, connect message channels, configure AI operations, and integrate external clients through API or MCP.
- [API and MCP access](https://cdelivery.dev/docs/guides/automation/api-mcp/index.md): Create a scoped API key, verify REST and MCP, and understand patch and error behavior.
- [Use the AI assistant](https://cdelivery.dev/docs/guides/automation/assistant/index.md): Connect a message channel, ask operational questions, and verify actions against your account permissions.
- [AI on-call](https://cdelivery.dev/docs/guides/automation/duty/index.md): Configure unattended analysis, check intervals, roles, notification language, and recipients.
- [Messages and notifications overview](https://cdelivery.dev/docs/guides/automation/im/index.md): Connect platform channels, bind your identity, and distinguish notifications from AI conversations.
- [Discord integration](https://cdelivery.dev/docs/guides/automation/im/discord/index.md): Configure a Discord bot and Gateway access, then bind your own Discord user ID.
- [Email integration](https://cdelivery.dev/docs/guides/automation/im/email/index.md): Configure SMTP notifications and IMAP conversations with trusted sender authentication.
- [Feishu integration](https://cdelivery.dev/docs/guides/automation/im/feishu/index.md): Configure a Feishu application bot, long-connection events, and your app-scoped open_id.
- [Lark integration](https://cdelivery.dev/docs/guides/automation/im/lark/index.md): Configure a Lark application bot, long-connection events, and your app-scoped open_id.
- [Notification settings and troubleshooting](https://cdelivery.dev/docs/guides/automation/im/notifications/index.md): Check platform channels, personal subscriptions, recipient roles, language, and delivery.
- [Slack integration](https://cdelivery.dev/docs/guides/automation/im/slack/index.md): Create a Slack app with Socket Mode, configure tokens and permissions, and bind your member ID.
- [Telegram integration](https://cdelivery.dev/docs/guides/automation/im/telegram/index.md): Create a dedicated bot, bind your numeric user ID, and understand polling and group behavior.
- [Model configuration](https://cdelivery.dev/docs/guides/automation/models/index.md): Choose a provider, endpoint, credentials, and a model suitable for platform tool use.
- [Create and manage XJob tasks](https://cdelivery.dev/docs/guides/automation/xjob/index.md): Run scheduled application commands in separate task containers and verify their outcomes.
- [XJob results and troubleshooting](https://cdelivery.dev/docs/guides/automation/xjob/results/index.md): Inspect current and last execution, next-run time, logs, and command side effects.
- [XJob intervals and timeouts](https://cdelivery.dev/docs/guides/automation/xjob/schedule/index.md): Set the waiting interval after each run and an independent execution timeout.
- [Domains and HTTPS](https://cdelivery.dev/docs/guides/networking/index.md): Choose internal communication, published ports, or domain routes and configure HTTPS in the right order.
- [Automatic certificates and renewal](https://cdelivery.dev/docs/guides/networking/automatic-certificates/index.md): Prepare DNS and HTTP validation, enable ACME, and diagnose certificate issuance and renewal.
- [Application connectivity and published ports](https://cdelivery.dev/docs/guides/networking/connectivity/index.md): Connect applications by name and expose container ports without confusing internal and public addresses.
- [Custom certificates](https://cdelivery.dev/docs/guides/networking/custom-certificates/index.md): Upload a matching certificate chain and private key, validate HTTPS, and manage renewal yourself.
- [Networking FAQ](https://cdelivery.dev/docs/guides/networking/faq/index.md): Troubleshoot IPv6, client addresses, DNS, routing, and certificates.
- [Domains and routing](https://cdelivery.dev/docs/guides/networking/routing/index.md): Route HTTP requests by domain, path prefix, headers, and cookies to an application port.
- [Logs, metrics, and events](https://cdelivery.dev/docs/guides/observability/index.md): Choose the right evidence for application, network, resource, and platform problems.
- [Operation events](https://cdelivery.dev/docs/guides/observability/events/index.md): Correlate platform changes with failures while distinguishing retained events from runtime diagnostics.
- [HTTP access logs](https://cdelivery.dev/docs/guides/observability/logs/access/index.md): Inspect Pingress requests, response status, backend selection, and timing.
- [Application logs](https://cdelivery.dev/docs/guides/observability/logs/application/index.md): Select application, check, job, or Guardian logs and understand log-driver retention.
- [Application metrics](https://cdelivery.dev/docs/guides/observability/metrics/application/index.md): Read resource series, distinguish missing samples, and use observations for scaling and diagnosis.
- [Server metrics](https://cdelivery.dev/docs/guides/observability/metrics/server/index.md): Inspect host CPU, memory, network, and filesystem observations and their different sampling rates.
- [Collection and retention settings](https://cdelivery.dev/docs/guides/observability/settings/index.md): Enable Insight, choose storage and placement, and understand sampling, flushing, and retained history.
- [Health checks and releases](https://cdelivery.dev/docs/guides/release-safety/index.md): Check application health, choose an update strategy, validate candidates, and recover from failed releases.
- [Release validation with Guardian](https://cdelivery.dev/docs/guides/release-safety/guardian/index.md): Validate a candidate before promoting application changes and handle failed validation explicitly.
- [Rollback and release failures](https://cdelivery.dev/docs/guides/release-safety/rollback/index.md): Restore a previous application configuration and verify recovery without confusing it with data restoration.
- [Application update strategies](https://cdelivery.dev/docs/guides/release-safety/update-strategy/index.md): Control update parallelism, task order, monitoring, and failure actions.
- [Configure XHealth checks](https://cdelivery.dev/docs/guides/release-safety/xhealth/index.md): Create Hurl or custom-command checks and understand what the check target actually tests.
- [XHealth status and troubleshooting](https://cdelivery.dev/docs/guides/release-safety/xhealth/status/index.md): Distinguish waiting, execution, success, failure, and checks that finished without a result.
- [CDelivery documentation](https://cdelivery.dev/docs/index.md): Install CDelivery, deploy applications, and manage networking, observability, automation, and your platform.