Site map

1. Home
   Nucleus is an open source application framework and content management system for .Net core.
2. Documentation
   1. Site Management
      Documentation for site administrators, including installation and management of your site.
      1. Getting Started
         Learn how to install Nucleus in Windows, Azure App Portal or Linux, and how to select your database provider and file system providers.
      2. Configuration Files
         About Nucleus configuration files.
      3. Site Settings
         Manage site settings, including logos, layout settings, aliases, user profile properties, email settings and email templates.
      4. 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.
      5. System Administrators
         Create and manage system administrator accounts.
      6. Roles
         Create and manage security roles.
      7. Users
         Create and manage site user accounts.
      8. Lists
      9. Install Extensions
         Extensions can add new layouts, modules, file system providers, scheduled tasks, and other components. Learn how to install them.
      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. Search Settings
          Manage search settings used by the search indexing system.
      13. Api Keys
          Manage Api Keys, which are used by applications when sending requests to Nucleus.
   2. Content Management
      Information for users who manage site content.
      1. Files and Folders
         Learn how to manage web site content files.
      2. Managing Pages
         Learn how to manage pages.
      3. Editing Content
         Learn how to edit content.
   3. 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. Static Content
            The Static Content module displays static content files inline in markdown, html or text file format.
         3. Documents
            The documents module lists specified documents in a table or tile layout with optional sorting, categories and control over meta-data display.
         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.
      2. Utility
         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. 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.
         4. Accept Terms
            The Accept Terms module displays a pop-up dialog to display terms, with an Accept and Cancel button.
      3. 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.
   4. Other Extensions
      Help for other extensions, like file system and search providers.
      1. Elastic Search
         The Elastic Search extension provides a search index manager and a search provider.
      2. 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.
      3. Google Analytics
         The Google Analytics extension adds elements to your page output to report analytics data to Google Analytics.
      4. Amazon S3
         The Amazon S3 extension is a file system provider which allows you to use the Amazon S3 storage service with Nucleus.
      5. OAuth Client
         The OAuth client allows users to sign on to Nucleus using an external OAuth2 provider.
   5. Reference Documents
      Nucleus administrator reference documents.
      1. Configuration Reference
         Nucleus configuration settings reference documentation.
      2. Release Notes - Version 1.x
         Release notes for all Nucleus versions 1.x.
   6. Hosting
      Special guidance for hosting Nucleus in various environments.
      1. Azure App Service
         Guidance for hosting in Azure App Service.
      2. Linux
         Guidance for hosting in Linux.
3. Developers
   Developer concepts, application programming interface (API) documentation, how to develop layouts, containers, modules and other extensions.
   1. Developing Extensions
      Extensions can add new layouts, modules, file system providers, scheduled tasks, content editors, entire line-of-business applications and other components. Read about extensibility options for Nucleus.
      1. Layouts and Containers
         Layouts control the visual presentation of modules on a page. Layouts are often called "Themes" or "Skins" in other content management systems. Containers control the visual presentation of specific modules that they are assigned to.
      2. Modules
         Modules are applications which run within Nucleus, which present information on pages.
      3. Scheduled Tasks
         Scheduled tasks perform their work periodically and are generally used to perform system maintenance, like expiring cache entries or updating a search index.
      4. Control Panel Extensions
         Some extensions do not have a user interface, but need to provide a way for site administrators to set configuration settings. Use a control panel extension to add an item to the Manage or Settings control panel.
      5. Other Examples
         Create client-side libraries, file system providers, search index managers and search providers, or other general-purpose extensions.
   2. Tutorials
      Developer walkthroughs/tutorials.
      1. Developing a Nucleus Module
         Walkthough - Developing a Nucleus Module.
   3. Topics
      Nucleus Extension development topics.
      1. Authorization
         Nucleus implements .Net Core Authorization policies in order to control access to controllers and/or controller actions. Learn about the Nucleus authorization policies here.
      2. Database Scripts
         Database scripts are used to create and manage your database schema (tables, indexes and other database objects). Learn how to create database scripts for your extension here.
      3. Saving Settings
         Documentation on using built-in Nucleus functionality to save and retrieve module and site settings.
      4. Extension Packaging
         An extension package is a zip file which contains all of the files needed for your extension, along with a Extension Packaging (package.xml) file with instructions for Nucleus on how to install your components. Read about the packaging and manifest format here.
      5. Razor Views
         The user interface for Nucleus modules and extensions are Razor views. Your views can make use of Nucleus view features (tag helpers, html helpers and url helpers) to make it easier to interact with Nucleus.
      6. Caching Data
         Nucleus core caches most data entities in memory in order to improve performance. Modules and extensions can use the Nucleus Cache Manager to cache their own data.
      7. Startup Classes
         Startup classes add functionality to Nucleus during startup.
      8. Data Providers
         Data providers are implemented by Nucleus extensions in order to interact with the database.
      9. Event Handlers
         The Nucleus core and Nucleus Extensions can raise system events for others to handle, or implement Event Handlers to execute code when a system or extension event is raised.
   4. Reference
      Nucleus developer reference documents.
      1. API Documentation
         Nucleus framework (API) documentation.
      2. CSS Reference
         Description of CSS classes which can be used by extensions.
      3. Third-Party Components
         Nucleus uses a number of third-party components. Their source and license types are listed here for reference.
      4. XML Schemas
         1. package.xsd
4. News
   Nucleus-related articles on various topics.
5. Forums
6. Downloads
7. Contact Us
   Contact us for enquiries.