Documentation

Administration
Documentation for site administrators, including installation and management of your site.
1. Setup
  Special guidance for hosting Nucleus in various environments.
  1. Windows Setup Guide
    Instructions for installing Nucleus in Windows.
  2. Linux Setup Guide
    Instructions for installing Nucleus in Linux.
  3. Azure App Service Setup Guide
    Instructions for installing Nucleus in Azure App Service.
  4. Docker Setup Guide
    Instructions for installing Nucleus in a Docker container.
2. Content Management
  Information for users who manage site content.
  1. Managing Pages
    Learn how to manage pages.
  2. Editing Content
    Learn how to edit content.
  3. Files and Folders
    Learn how to manage web site content files.
3. Operations
  Information on operations support (OSS) functions.
  1. Instrumentation
    Information on how Nucleus implements OpenTelemetry and OpenMetrics telemetry reporting.
  2. Health Checks
    Health checks can be used by load balancers and other infrastructure components to check the status of Nucleus on a server.
  3. Logging
    Information on Nucleus logging functions.
Site Management
Documentation for site administrators, including installation and management of your site.
1. Configuration Files
  About Nucleus configuration files.
2. Site Settings
  Manage site settings, including logos, layout settings, aliases, user profile properties, email settings and email templates.
3. Roles
  Create and manage security roles.
4. Users
  Create and manage site user accounts.
5. Install Extensions
  Extensions can add new layouts, modules, file system providers, scheduled tasks, and other components. Learn how to install them.
6. Task Scheduler
  Scheduled tasks perform their work periodically and are generally used to perform system maintenance, like expiring cache entries or updating a search index.
7. System Administrators
  Create and manage system administrator accounts.
8. Search Settings
  Manage search settings used by the search indexing system.
9. Lists
  Manage lists.
10. System Status
  View environment and status information.
11. Mail Templates
  Documentation on how to create mail templates, which are used by the system to generate email messages.
12. Api Keys
  Manage Api Keys, which are used by applications when sending requests to Nucleus.
Modules
Help for core modules, which extend the functionality of Nucleus.
1. Content
  Modules which display on-screen content.
  1. Text/Html
    The Text/HTML module renders HTML or text content.
  2. Documents
    The documents module lists specified documents in a table or tile layout with optional sorting, categories and control over meta-data display.
  3. Static Content
    The Static Content module displays static content files inline in markdown, html or text file format.
  4. Links
    The links module displays a lists of links to specified pages, files or Urls.
  5. Multi-Content
    The multi-content module displays content in an accordion, tab, pills, carousel or alert layout.
  6. Media
    The media module adds a video, image or PDF document to a page.
  7. Shadow
    The Shadow Module displays a copy of a module from another page. This allows the user to share content across pages.
  8. IFrame
    The IFrame module embeds another HTML page in your site.
  9. Accept Terms
    The Accept Terms module displays a pop-up dialog to display terms, with an Accept and Cancel button.
2. Navigation
  1. Site Map
    The site map module displays a list of pages within your site. It can be used as a full site map for users, as a side-menu or on a landing page where it provides a summary of child pages with links.
  2. Page Links
    The page links module displays header links of another module to navigate to a section on a page.
  3. Files List
    The files list module displays a list of downloadable files from a selected folder.
3. Utility
  Documentation for utility modules (like search, error reporting).
  1. Error Report
    The error report module displays error details.
  2. Search
    The search module lists provides a user interface for searching your site.
  3. Contact Us
    The contact us module allows the end user to send a message to email recipients.
4. Applications
  Modules which are applications.
  1. Forums
    The forums module is a message board which allows your user community to participate in discussions, post questions and answers.
  2. Publish
    Use the publish module to publish news, blogs and other content.
Other Extensions
Help for other extensions, like file system and search providers.
1. Search
  Help for search providers.
  1. Search Providers Comparison
    The Azure Search extension provides a search index manager and a search provider.
  2. Azure Search
    The Azure Search extension provides a search index manager and a search provider.
  3. Elastic Search
    The Elastic Search extension provides a search index manager and a search provider.
  4. Typesense Search
    The Typesense Search extension provides a search index manager and a search provider.
  5. Bing Custom Search
    The Bing Custom Search extension is deprecated.
  6. Google Custom Search
    The Google Custom Search extension provides a search provider that retrieves search results using the Google custom search service.
  7. Advanced SiteMap
    The Advanced SiteMap extension replaces the built-in Nucleus component which generates a `sitemap.xml` file for use by external search engines.
  8. Tika Server Converter
    The Tika Server converter extension allows your search index managers to use a Tika Server for content conversion.
2. Authentication
  Help for Authentication extensions.
  1. SAML Client
    The SAML client allows users to sign on to Nucleus using an external SAML2 service (Identity Provider).
  2. OAuth Client
    The OAuth client allows users to sign on to Nucleus using an external OAuth2 provider.
3. File Systems
  Help for file system provider extensions.
  1. Azure Blob Storage
    The Azure Blob Storage extension is a file system provider which allows you to use the Microsoft Azure Blob storage service with Nucleus.
  2. Amazon S3
    The Amazon S3 extension is a file system provider which allows you to use the Amazon S3 storage service with Nucleus.
4. Mail Providers
  Help for email providers.
  1. SMTP Email
    The SMTP mail provider adds support for sending emails using the SMTP protocol.
  2. SendGrid
    The SendGrid mail provider adds support for sending emails using a Twilio SendGrid service.
  3. Azure Email
    The Azure Communication Services Mail Provider Extension adds support for sending emails using an Azure Email Communications service.
  4. Pickup Directory
    The Pickup Directory mail provider generates .eml files which are stored in the specified directory. This allows you to inspect the emails that would have been sent without actually sending them.
5. Google Analytics
  The Google Analytics extension adds elements to your page output to report analytics data to Google Analytics.
Reference Documents
Nucleus administrator reference documents.
1. Release Notes
  Release notes for all Nucleus versions.
2. Configuration Reference
  Nucleus configuration settings reference documentation.
3. Third-Party Components
  Nucleus uses a number of third-party components. Their source and license types are listed here for reference.

Developer concepts, application programming interface (API) documentation, how to develop layouts, containers, modules and other extensions.