Umbraco CMS Documentation
repository·main·Indexed 43 days ago
https://github.com/umbraco/umbracodocsDeveloper documentation for Umbraco CMS, including guides on extending the platform with custom health checks, configuring built-in health checks for security and data integrity, and implementing custom notification methods via IHealthCheckNotificationMethod.
What's inside Umbraco
- Umbraco Commerce Cart is a free, open-source add-on package designed for Umbraco Commerce. It provides a low-code solution for implementing an instant shopping cart within your Umbraco Commerce stores, significantly reducing the development effort required to manage customer baskets and checkout flows.
Overview of Umbraco Cloud
mainUmbraco Cloud is a fully managed hosting platform for Umbraco CMS, built on Microsoft Azure. It provides a managed environment for installation, infrastructure, and security, allowing developers to build and host websites with built-in scaling, backups, and a global CDN.
Key features include:
- Managed Hosting: Hosted on Azure with automatic backups, HTTPS, and scaling.
- DevOps Workflow: Git-based workflows with built-in CI/CD and structured environments (Development, Staging, Live).
- Local Development: Developers can clone projects from the Cloud to a local PC, Linux, or macOS machine for local development.
- Deployment: A safe mechanism to move, test, and deploy changes from local/development environments to the public live site.
Overview of Umbraco Engage AI
mainUmbraco Engage AI provides a marketing-focused Copilot within the Umbraco Engage section. It allows users to ask questions about marketing data—such as campaigns, segments, goals, personas, traffic, and A/B tests—using plain language instead of manual dashboard navigation.
Key Characteristics:
- Read-only: The AI reports and explains data; it cannot modify your Engage configuration or data.
- Dual Surface Support: Works via the Copilot sidebar in the backoffice and through Copilot Workspace.
- Configurable: The agent's behavior, tone, and model are shaped by configurable Instructions, AI Profiles, and Context resources rather than hardcoded logic.
Getting started with Umbraco
mainThis section provides a collection of guides designed to help new users navigate and manage content within the Umbraco CMS. It covers fundamental editor tasks including authentication, interface navigation, content lifecycle management (creating, saving, publishing), and content organization (finding, sorting, moving, copying, and deleting pages).Overview of Umbraco Engage for Marketers and Editors
mainUmbraco Engage provides a suite of tools designed for marketers and editors to optimize website performance and user experience. The platform includes capabilities for tracking visitor behavior, conducting experiments, and personalizing content.
Key functional areas include:
- Analytics: Monitor website traffic and visitor behavior.
- A/B Testing: Run experiments to compare different versions of content or layouts.
- Personalization: Tailor the website experience to specific user segments.
- Profiling: Track visitor sessions and manage the distinction between identified and anonymous visitors.
- Content Apps: Use specialized UI enhancements within the Umbraco backoffice to improve content management workflows.
- Settings: Configure global behaviors such as IP address exclusion and goal implementation.
Overview of the TaxJar sales tax provider
mainThe TaxJar sales tax provider for Umbraco Commerce enables real-time sales tax calculation by integrating with the TaxJar service. It provides full functionality for retrieving real-time tax rates during the checkout or order process.Overview of Umbraco Heartcore Client Libraries
mainUmbraco Heartcore provides official client libraries to simplify interaction with its API endpoints. Instead of manually implementing HTTP calls for every endpoint, you can use these libraries to connect directly to your Umbraco Heartcore project.
Key features:
- Pre-configured API endpoint implementations.
- Open source and free to use.
- Includes sample projects for rapid testing and exploration.
Connection to your Heartcore project typically requires configuring specific parameters (such as API keys or project identifiers) within the library setup.
Overview of Umbraco.AI
mainUmbraco.AI is a provider-agnostic AI integration layer for Umbraco CMS. It is built on top of
Microsoft.Extensions.AI(M.E.AI), allowing you to integrate various AI services like OpenAI or Azure OpenAI using a consistent API and backoffice experience.Key features include:
- Provider-agnostic architecture: Use specific provider packages for the services you need.
- Profile-based configuration: Create reusable profiles for different AI use cases.
- Standardized types: Uses standard M.E.AI types such as
IChatClientandChatMessage. - Extensible middleware: Supports adding logging, caching, rate limiting, and custom behaviors.
- Backoffice integration: Manage connections and profiles directly through the Umbraco UI.
Overview of Umbraco Engage
mainUmbraco Engage is a marketing suite designed for both marketers and developers to create personalized, data-driven website experiences. It provides capabilities for:
- Analytics: Tracking visitor behavior.
- A/B Testing: Running experiments to optimize content.
- Targeted Campaigns: Delivering personalized experiences based on visitor data.
For developers looking for headless implementations, refer to the Headless package documentation.
Getting Started with Umbraco Engage
mainUmbraco Engage provides tools for both marketers and developers. Marketers can use it to create personalized content, while developers can integrate the system into their existing infrastructure. The documentation is split into two primary tracks:
- For Marketers and Editors: Focuses on configuring the system, understanding features, and optimizing content personalization.
- For Developers: Focuses on technical integration, infrastructure setup, and implementation details.
Overview of Umbraco Commerce official packages
mainUmbraco Commerce can be extended using several official add-on packages. These packages are designed to add specific features and functionality to a core Umbraco Commerce installation:
- Cart: Provides a drop-in cart solution.
- Checkout: Adds additional functionality to the checkout flow.
- Portal: Adds customer-specific functionalities.
- Deploy: Enables the use of Umbraco Deploy with Umbraco Commerce.
- Product feeds: An XML feed generator plugin that extracts product data from Umbraco nodes to generate structured XML feeds.
Overview of Umbraco Workflow
mainUmbraco Workflow is an extension for the Umbraco CMS that enables multi-stage, configurable approval workflows for content creation and publishing. It extends the standard publishing model by allowing you to define a process consisting of multiple steps and assigning specific users or groups to provide approvals at each stage of the workflow.