Preside

https://docs.preside.org/
Admin
Preside is a content management system (CMS) platform for developers, offering tools for building...
Tokens:126,114
Snippets:582
Trust Score:7.9
Update:1 year ago
Show doc for...
Tokens:
Raw
### Preside CMS Server Setup Guides Overview

Source: https://docs.preside.org/upgradenotes/10-18

This section covers server setup guides for Preside CMS, including Lucee setup and proxy examples for Nginx and Apache2.

```markdown
* Lucee setup
* Nginx Proxy example
* Apache2 Proxy example
```

--------------------------------

### Install Preside Commands

Source: https://docs.preside.org/quickstart

Installs the custom Preside commands into your CommandBox environment, enabling you to manage Preside applications.

```CommandBox
CommandBox> install preside-commands
```

--------------------------------

### Start Preside Development Server

Source: https://docs.preside.org/quickstart

Starts an ad-hoc Preside server for your local development machine. This command should be run from the webroot of your Preside site. It may prompt for database configuration on the first run.

```CommandBox
CommandBox> preside start
```

--------------------------------

### Apache2 Proxy Example

Source: https://docs.preside.org/serverguides

An example configuration for setting up Apache2 as a reverse proxy for Preside CMS. This guide helps in directing traffic to your Preside application.

```Markdown
Apache2 Proxy example
```

--------------------------------

### Lucee Setup Guide

Source: https://docs.preside.org/serverguides

Instructions for setting up the Lucee server environment required for Preside CMS. This guide is crucial for ensuring Preside runs correctly on your server.

```Markdown
Lucee setup
As always, if you need more help than the docs can provide, please join our community forums where we'll be happy to help you out.
```

--------------------------------

### Preside CMS Server Setup Guides Overview

Source: https://docs.preside.org/reference/systemforms

This section provides guides for setting up the Preside CMS server environment, including specific configurations for Lucee and proxy examples for Nginx and Apache2.

```English
Lucee setup
Nginx Proxy example
Apache2 Proxy example
```

--------------------------------

### Preside CMS Contributor Guides Overview

Source: https://docs.preside.org/reference/systemforms

This section details the guides for contributing to the Preside CMS project, including local development setup, testing, contribution guidelines, and release strategy.

```English
Building Preside locally
Running the test suite
Submitting fixes, improvements and awesome new features
Our git branching model and release strategy
```

--------------------------------

### Nginx Proxy Example

Source: https://docs.preside.org/serverguides

An example configuration for setting up Nginx as a reverse proxy for Preside CMS. This is useful for managing traffic and SSL termination.

```Markdown
Nginx Proxy example
```

--------------------------------

### Create New Preside Site

Source: https://docs.preside.org/quickstart

Scaffolds a new Preside application from the command line, including the Preside dependency. This command should be run from an empty directory where you want to create the site.

```CommandBox
CommandBox> preside new site
```

--------------------------------

### Preside Developer Guides - Working with Multiple Sites

Source: https://docs.preside.org/upgradenotes/10-21

Guides on managing and configuring multiple websites within a single Preside installation.

```APIDOC
Working with Multiple Sites:
  - Configure and manage multiple independent websites.
  - Share or isolate content and configurations between sites.
  - Define site-specific settings and domains.
  - Examples of multi-site setup.
```

--------------------------------

### Install Tuckey URL Rewrite Filter for Lucee

Source: https://docs.preside.org/serverguides/serversetupfoundation

Instructions for installing the Tuckey URL rewrite filter, including downloading the JAR file and configuring the Lucee web.xml file.

```Java
<!-- ====================================================================
-->
<!-- URL ReWriting Filter                                                 -->
<!-- ====================================================================
-->
<filter>
    <filter-name>UrlRewriteFilter</filter-name>
    <filter-class>org.tuckey.web.filters.urlrewrite.UrlRewriteFilter</filter-class>

    <!--
       the confPath param below tells the filter to look
       for urlrewrite.xml in the webroot of each of your applications
    -->
    <init-param>
        <param-name>confPath</param-name>
        <param-value>/urlrewrite.xml</param-value>
    </init-param>

    <!--
       the confReloadCheckInterval param below means that changes
       to urlrewrite.xml will take effect almost immediately.
       Has minor performance implications, so you may wish to exclude it.
    -->
    <init-param>
        <param-name>confReloadCheckInterval</param-name>
        <param-value>1</param-value>
    </init-param>
</filter>

<!--
    Map the defined filter to all incoming URL patterns
-->
<filter-mapping>
    <filter-name>UrlRewriteFilter</filter-name>
    <url-pattern>/*</url-pattern>
    <dispatcher>REQUEST</dispatcher>
    <dispatcher>FORWARD</dispatcher>
</filter-mapping>
```

--------------------------------

### Preside REST Resource Handler Example

Source: https://docs.preside.org/devguides/restframework

An example of a Preside REST resource handler demonstrating how to define GET methods with parameters for handling URL patterns like /events/ and /events/{id}/.

```cfml
/**
 * @restUri /events/,/events/{id}/
 *
 */
component {

	private void function get(
		  string  id       = ""
		, numeric page     = 1
		, numeric pageSize = 50
	) {
		// here we expect URLs like /events/?page=3&pageSize=10
		// or /events/34583745/
	}
}
```

--------------------------------

### Preside CMS Lucee Application Mapping

Source: https://docs.preside.org/serverguides/serversetupfoundation

Creates a web mapping in Lucee for the Preside CMS application. This maps a logical path to the physical directory where Preside is downloaded.

```APIDOC
Lucee Web Admin -> Mappings
Logical Path: /preside
Physical Directory: [Path to Preside download directory]
```

--------------------------------

### Start Preside Test Server

Source: https://docs.preside.org/contribguides/runningtests

Instructions for starting the Preside test server through a web browser.

```bash
/preside> ./support/tests/startserver.sh
```

--------------------------------

### Preside Upgrade Guides

Source: https://docs.preside.org/upgradenotes

Provides guidance on upgrading Preside installations. It advises users to consult individual upgrade notes for each version transition, especially when skipping multiple releases.

```APIDOC
Upgrade Process:
  - Consult 'General upgrade guides' for preparation.
  - For updates spanning multiple versions (e.g., 10.6.x to 10.8.x), review upgrade notes for all intermediate releases.
  - Individual upgrade notes are listed for specific version transitions (e.g., 10.26 -> 10.27).
```

--------------------------------

### Lucee Null Support Setting

Source: https://docs.preside.org/serverguides/serversetupfoundation

Ensures Preside CMS runs correctly by setting Lucee's Null Support to 'Partial Support (CFML Default)'. Full NULL support is not compatible.

```APIDOC
Lucee Server Admin -> Settings -> Language/Compiler
Null Support: Partial Support (CFML Default)
```

--------------------------------

### Preside View Example

Source: https://docs.preside.org/devguides/dataobjectviews

A complete example of a Preside view template that uses declared arguments and renders content, including links and assets.

```cfml
<cf_presideparam name="args.label"                                  />
<cf_presideparam name="args.teaser"                                 />
<cf_presideparam name="args.image"                                  />
<cf_presideparam name="args.event_type_id" field="event_type"       />
<cf_presideparam name="args.event_type"    field="event_type.label" />

<cfparam name="_counter" type="numeric" />
<cfparam name="_records" type="numeric" />

<cfoutput>
    <div class="preview-pane">
        <h3>#args.label#</h3>
        <p class="event-type">
            <a href="#event.buildLink( pageId=args.event_type_id )#">
                #args.event_type#
            </a>
        </p>

        #renderAsset( assetId=args.image, context="previewPane" )#

        <p>#args.teaser#</p>
    </div>
</cfoutput>
```

--------------------------------

### Preside CMS Contributor Guides Overview

Source: https://docs.preside.org/upgradenotes/10-18

This section details the guides for contributing to Preside CMS, including local building, running tests, submitting changes, and understanding the branching model.

```markdown
* Building Preside locally
* Running the test suite
* Submitting fixes, improvements and awesome new features
* Our git branching model and release strategy
```

--------------------------------

### Preside Asset Manager Routing

Source: https://docs.preside.org/devguides/routing

Explains how URLs starting with '/asset' are routed to the asset download action in Preside. Shows how asset IDs and derivative IDs are mapped to ColdBox RC variables. Includes examples of building asset links.

```cfml
Coldbox event : core.assetDownload
Coldbox RC    : { assetId : "F4554E4C-9347-4F7E-B5F862595BFC9EBF" }
```

```cfml
Coldbox event : core.assetDownload
Coldbox RC    : { assetId : "F4554E4C-9347-4F7E-B5F862595BFC9EBF", derivativeId : "headerImage" }
```

```cfml
event.buildAdminLink( assetId=myAssetId )
or
event.buildLink( assetId=myAssetId, derivative=derivativeId )
```

--------------------------------

### Preside Developer Guides - Sitetree Navigation Menus

Source: https://docs.preside.org/upgradenotes/10-21

Guides on creating and managing sitetree navigation menus in Preside.

```APIDOC
Sitetree Navigation Menus:
  - Build hierarchical navigation structures.
  - Manage menu items, links, and visibility.
  - Render navigation menus in templates.
  - Examples of sitetree configuration.
```

--------------------------------

### Preside Developer Guides Overview

Source: https://docs.preside.org/devguides

This section provides a comprehensive list of developer guides for the Preside platform. It covers topics such as configuring Preside, working with data objects and views, routing, security features (XSS, CSRF), form handling, internationalization (i18n), and extending the platform.

```English
Developer guides:
  * Configuring Preside
  * Data objects
  * Data object views
  * Viewlets
  * Widgets
  * Working with page types
  * Working with multiple sites
  * Working with the richeditor
  * Data Manager
  * Routing
  * Feature flagging
  * CMS permissioning
  * Website users and permissioning
  * Editable system settings
  * Email centre
  * Notifications
  * Custom error pages & maintenance mode
  * Sitetree navigation menus
  * Modifying the administrator left hand menu
  * Modifying the administrator system menu
  * Configuring admin menu items
  * Working with the asset manager
  * Working with uploaded files
  * Multilingual content
  * Using the super class
  * XSS protection
  * REST framework
  * Working with the form builder
  * Working with spreadsheets
  * Session management and stateless requests
  * Forms system
  * i18n
  * Task manager
  * Using the audit trail system
  * Rules engine
  * Drafts system
  * Label renderers
  * Data exports
  * Admin record views
  * Task manager
  * Full page caching
  * Record cloning
  * External service health checks
  * Admin login providers
  * Reloading the application
  * Configuring admin 'gritter' notifications
  * Writing Extensions for Preside
  * SelectData views
  * Database Migrations
  * System Alerts
  * Admin development environment banner header
```

--------------------------------

### Preside Developer Guides - Website Users and Permissioning

Source: https://docs.preside.org/upgradenotes/10-21

Guides on managing website users and their associated permissions within Preside.

```APIDOC
Website Users and Permissioning:
  - Manage front-end website user accounts.
  - Assign roles and permissions to website users.
  - Control access to restricted content or features.
  - Examples of user management.
```

--------------------------------

### Preside Developer Guides - Editable System Settings

Source: https://docs.preside.org/upgradenotes/10-21

Guides on managing editable system settings within the Preside administrator interface.

```APIDOC
Editable System Settings:
  - Configure system-wide settings through the admin interface.
  - Manage settings for email, caching, security, etc.
  - Define custom editable settings.
  - Examples of system setting configuration.
```

--------------------------------

### Install Preside Dependencies

Source: https://docs.preside.org/contribguides/buildfromsource

Command to install Preside's external dependencies declared in its box.json file using CommandBox.

```bash
/preside> box install
```

--------------------------------

### Preside Developer Guides - Viewlets

Source: https://docs.preside.org/upgradenotes/10-21

Guides on developing and using viewlets in Preside for reusable UI components within views.

```APIDOC
Viewlets:
  - Create reusable UI components for views.
  - Pass data and context to viewlets.
  - Integrate viewlets into data object views.
  - Examples of viewlet development.
```

--------------------------------

### Preside Developer Guides - Working with the Asset Manager

Source: https://docs.preside.org/upgradenotes/10-21

Guides on using the Preside Asset Manager for organizing and managing site assets like images and files.

```APIDOC
Working with the Asset Manager:
  - Upload, organize, and manage site assets.

```

--------------------------------

### Preside CMS Developer Guides Overview

Source: https://docs.preside.org/reference/systemforms

This section outlines the various developer guides available for Preside CMS, covering configuration, data handling, UI components, routing, security, and more.

```English
Configuring Preside
Data objects
Data object views
Viewlets
Working with page types
Working with multiple sites
Working with the richeditor
Routing
CMS permissioning
Website users and permissioning
Editable system settings
Email centre
Notifications
Custom error pages & maintenance mode
Sitetree navigation menus
Modifying the administrator left hand menu
Working with uploaded files
Multilingual content
Using the super class
Configuring the developer console key
Working with the asset manager
XSS protection
REST framework
Working with the form builder
Working with spreadsheets
Session management and stateless requests
Validation framework
Creating multiple admin applications
Forms system
i18n
Task manager
Using the audit trail system
Widgets
Rules engine
Drafts system
Configuring data tenancy
Label renderers
Data exports
CSRF Protection
Data Manager
Full page caching
Record cloning
External service health checks
Admin login providers
Reloading the application
Configuring admin 'gritter' notifications
Writing Extensions for Preside
SelectData views
Modifying the administrator system menu
Configuring admin menu items
Database Migrations
System Alerts
Admin development environment banner header
Feature flagging
```

--------------------------------

### Preside Developer Guides - Working with Page Types

Source: https://docs.preside.org/upgradenotes/10-21

Guides on creating and managing different page types within Preside.

```APIDOC
Working with Page Types:
  - Define custom page templates and structures.
  - Assign specific layouts and functionalities to page types.
  - Manage page type inheritance and relationships.
  - Examples of page type creation.
```

--------------------------------

### Preside Developer Guides - Using the Super Class

Source: https://docs.preside.org/upgradenotes/10-21

Guides on utilizing the Preside super class for common functionalities and inheritance.

```APIDOC
Using the Super Class:
  - Leverage the base Preside super class for controllers and models.
  - Understand inheritance and method overriding.
  - Utilize common functionalities provided by the super class.
  - Examples of extending the super class.
```

--------------------------------

### Preside CMS Developer Guides Overview

Source: https://docs.preside.org/upgradenotes/10-18

This section outlines the various developer guides available for Preside CMS, covering configuration, data objects, viewlets, routing, permissions, and more.

```markdown
* Configuring Preside
* Data objects
* Data object views
* Viewlets
* Working with page types
* Working with multiple sites
* Working with the richeditor
* Routing
* CMS permissioning
* Website users and permissioning
* Editable system settings
* Email centre
* Notifications
* Custom error pages & maintenance mode
* Sitetree navigation menus
* Modifying the administrator left hand menu
* Working with uploaded files
* Multilingual content
* Using the super class
* Configuring the developer console key
* Working with the asset manager
* XSS protection
* REST framework
* Working with the form builder
* Working with spreadsheets
* Session management and stateless requests
* Validation framework
* Creating multiple admin applications
* Forms system
* i18n
* Task manager
* Using the audit trail system
* Widgets
* Rules engine
* Drafts system
* Configuring data tenancy
* Label renderers
* Data exports
* CSRF Protection
* Data Manager
* Full page caching
* Record cloning
* External service health checks
* Admin login providers
* Reloading the application
* Configuring admin 'gritter' notifications
* Writing Extensions for Preside
* SelectData views
* Modifying the administrator system menu
* Configuring admin menu items
* Database Migrations
* System Alerts
* Admin development environment banner header
* Feature flagging
```

--------------------------------

### Apache2 Proxy Configuration Example

Source: https://docs.preside.org/contribguides

An example configuration for Apache2 to act as a reverse proxy for a Preside application.

```apache
<VirtualHost *:80>
    ServerName your_domain.com

    ProxyPreserveHost On
    ProxyRequests Off
    ProxyPass / http://localhost:8080/
    ProxyPassReverse / http://localhost:8080/

    ErrorLog ${APACHE_LOG_DIR}/error.log
    CustomLog ${APACHE_LOG_DIR}/access.log combined
</VirtualHost>
```

--------------------------------

### Preside Developer Guides - Working with Uploaded Files

Source: https://docs.preside.org/upgradenotes/10-21

Guides on handling file uploads in Preside, including storage, validation, and management.

```APIDOC
Working with Uploaded Files:
  - Handle file uploads through forms.
  - Configure allowed file types, sizes, and storage locations.
  - Manage uploaded files via the asset manager.
  - Examples of file upload handling.
```

--------------------------------

### Preside Developer Guides - Configuring Preside

Source: https://docs.preside.org/upgradenotes/10-21

Guides on configuring various aspects of the Preside CMS, including core settings, modules, and integrations.

```APIDOC
Configuring Preside:
  - Core configuration settings in Config.cfc.
  - Module-specific configurations.
  - Environment-specific settings.
  - Examples of common configuration adjustments.
```

--------------------------------

### Nginx Proxy Configuration Example

Source: https://docs.preside.org/contribguides

An example configuration for Nginx to act as a reverse proxy for a Preside application.

```nginx
server {
    listen 80;
    server_name your_domain.com;

    location / {
        proxy_pass http://localhost:8080; # Assuming Preside runs on port 8080
        proxy_set_header Host $host;
        proxy_set_header X-Real-IP $remote_addr;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_set_header X-Forwarded-Proto $scheme;
    }
}
```

--------------------------------

### Preside Developer Guides - Email Centre

Source: https://docs.preside.org/upgradenotes/10-21

Guides on configuring and using the email centre in Preside for sending system emails.

```APIDOC
Email Centre:
  - Configure email server settings (SMTP).
  - Send transactional and notification emails.
  - Manage email templates and content.
  - Examples of email sending.
```

--------------------------------

### Preside Apache2 Proxy Example

Source: https://docs.preside.org/upgradenotes/10-21

Example configuration for using Apache2 as a reverse proxy for Preside.

```APIDOC
Apache2 Proxy Example:
  - Configure Apache2 to proxy requests to Preside.
  - Set up SSL/TLS, virtual hosts, and rewrite rules.
  - Optimize Apache2 configuration for Preside.
  - Example Apache2 configuration file.
```

--------------------------------

### Preside Developer Guides - Configuring the Developer Console Key

Source: https://docs.preside.org/upgradenotes/10-21

Guides on configuring the developer console key for accessing debugging and development tools.

```APIDOC
Configuring the Developer Console Key:
  - Set a security key to access the developer console.
  - Configure the key in the Preside configuration files.
  - Importance of securing the developer console.
  - Examples of key configuration.
```

--------------------------------

### Preside Nginx Proxy Example

Source: https://docs.preside.org/upgradenotes/10-21

Example configuration for using Nginx as a reverse proxy for Preside.

```APIDOC
Nginx Proxy Example:
  - Configure Nginx to proxy requests to Preside.
  - Set up SSL/TLS, caching, and load balancing.
  - Optimize Nginx configuration for Preside.
  - Example Nginx configuration file.
```

--------------------------------

### Preside Developer Guides - CMS Permissioning

Source: https://docs.preside.org/upgradenotes/10-21

Guides on setting up and managing Content Management System (CMS) permissions within Preside.

```APIDOC
CMS Permissioning:
  - Define user roles and permissions for CMS access.
  - Control access to content, features, and administrative functions.
  - Assign permissions to specific user groups or roles.
  - Examples of permission configurations.
```

--------------------------------

### Preside Developer Guides - Working with the Richeditor

Source: https://docs.preside.org/upgradenotes/10-21

Guides on integrating and customizing the rich text editor (richeditor) in Preside.

```APIDOC
Working with the Richeditor:
  - Integrate and configure the rich text editor.
  - Customize toolbar options, plugins, and styling.
  - Handle rich text content in forms and templates.
  - Examples of richeditor integration.
```

--------------------------------

### Preside CMS: SQL for Field Selection Example

Source: https://docs.preside.org/devguides/dataobjects

Provides the equivalent SQL generated for the `selectFields` example, demonstrating joins across related objects.

```sql
select      news.id
          , news.title
          , Concat( category.label, tag.label ) as catandtag

from        pobj_news     as news
inner join  pobj_category as category on category.id = news.category
inner join  pobj_tag      as tag      on tag.id      = category.tag
```

--------------------------------

### Preside CMS ColdBox Handler Example

Source: https://docs.preside.org/devguides/adminapplications

Example of a ColdBox handler for Preside CMS, extending the base admin handler. It includes preHandler logic for feature checks and permissions, and a basic index action.

```Java
// /handlers/admin/Ems.cfc

// notice that we extend base admin handler
component extends="preside.system.base.AdminHandler" {

// PRE HANDLER

    // preHandler useful for doing basic security checks,
    // and any other handler-wide logic
    function preHandler( event, rc, prc ) {
        super.preHandler( argumentCollection = arguments );

        if ( !isFeatureEnabled( "ems" ) ) {
            event.notFound();
        }

        _checkPermissions( argumentCollection=arguments, key="access" );

        prc.pageIcon = "calendar";
    }

// DIRECT PUBLIC ACTIONS
    public void function index() {
        // any required logic for your landing page
    }

// PRIVATE HELPERS
    private void function _checkPermissions( event, rc, prc, required string key ) {
        var permKey   = "ems." & arguments.key;
        var permitted =  hasCmsPermission( permissionKey=permKey );

        if ( !permitted ) {
            event.adminAccessDenied();
        }
    }
}
```

--------------------------------

### Coldbox Viewlet Handler Example

Source: https://docs.preside.org/devguides/viewlets

An example of a private handler action in Coldbox that acts as a viewlet. It fetches data and renders a view using the renderer plugin.

```ColdFusion
private any function myViewlet( event, rc, prc, id=0 ) {
    prc.someData = getModel( "someService" ).getSomeData( id=arguments.id );
    return getPlugin( "renderer" ).renderView( "/my/viewlets/view" );
}
```

--------------------------------

### Preside Developer Guides - Data Object Views

Source: https://docs.preside.org/upgradenotes/10-21

Guides on creating and customizing views for data objects in Preside, including list views and detail views.

```APIDOC
Data Object Views:
  - Create custom views for displaying data object records.
  - Configure list views with sorting, filtering, and pagination.
  - Design detail views for individual records.
  - Examples of view configurations.
```

--------------------------------

### Example Preside Route Handler for My Profile

Source: https://docs.preside.org/devguides/routing

An example ColdFusion component implementing the iRouteHandler interface to manage custom URLs for a 'My Profile' section of a website.

```ColdFusion
component implements="preside.system.routeHandlers.iRouteHandler" {

    public boolean function match( required string path, required any event ) {
        return ReFindNoCase( "^/my-profile/", arguments.path );
    }

    public void function translate( required string path, required any event ) {
        var coldboxEventName = ReReplace( arguments.path, "^/my-profile/", "myprofilemodule:myprofile/" );

        coldboxEventName = ListChangeDelims( coldboxEventName, ".", "/" );

        if ( ListLen( coldboxEventName, "." ) lt 2 ) {
            coldboxEventName = coldboxEventName & "." & "index";
        }

        event.setValue( "event", coldboxEventName );
    }

    public boolean function reverseMatch( required struct buildArgs ) {
        return Len( Trim( buildArgs.linkTo ?: "" ) ) and ListFirst( buildArgs.linkTo, "." ) eq "myprofilemodule:myprofile";
    }

    public string function build( required struct buildArgs ) {
        var link = "/my-profile/#ListChangeDelims( ListRest( buildArgs.linkTo, "." ), "/", "." )#/";

        if ( Len( Trim( buildArgs.queryString ?: "" ) ) ) {
            link &= "?" & buildArgs.queryString;
        }

        return link;
    }
}
```

--------------------------------

### Preside Lucee Setup

Source: https://docs.preside.org/upgradenotes/10-21

Instructions for setting up Preside with the Lucee server.

```APIDOC
Lucee Setup:
  - Install and configure Lucee server for Preside.
  - Set up web server contexts and datasource connections.
  - Ensure compatibility and optimal performance.
  - Step-by-step installation guide.
```

--------------------------------

### Using the $helpers Object

Source: https://docs.preside.org/devguides/presidesuperclass

Starting from version 10.11.0, the `$helpers` object provides access to Coldbox helper UDFs. This example demonstrates using the `isTrue()` helper.

```ColdFusion
/**
 * @presideService true
 * @singleton      true
 */
component {
    function init() {
        return this;
    }

    function someMethod( required any someArg ) {
        if ( $helpers.isTrue( someArg ) ) {
            // do something
        }
    }
}
```

--------------------------------

### Asset Manager Configuration Example

Source: https://docs.preside.org/devguides/assetmanager

Provides an example of how to configure the asset manager in the `Config.cfc` file, setting maximum file size, defining allowed file types with MIME types and attachment behavior, configuring derivatives with transformations, and setting up system folders.

```Java
settings.assetmanager.maxFileSize = 10;

settings.assetmanager.types.video.ogv = { serveAsAttachment=true, mimeType="video/ogg" };

settings.assetmanager.derivatives.leadimage = {
      permissions     = "inherit"
    , inEditor        = true
    , transformations = [ { method="resize", args={ width=800, height=400 } } ]
    , autoQueue       = [ "image" ]
};

settings.assetmanager.folders.profileImages = {
      label  = "Profile images"
    , hidden = false
    , autoQueue = []
    , children = {
            members    = { label="Members"    , hidden=false }
          , nonMembers = { label="Non-Members", hidden=false }
      }
};

settings.assetmanager.location.public    = ExpandPath( "/uploads/public" );
settings.assetmanager.location.private   = ExpandPath( "/uploads/private" );
settings.assetmanager.location.trash     = ExpandPath( "/uploads/.trash" );
settings.assetmanager.location.publicUrl = "//static.mysite.com/";
```

--------------------------------

### Run Local Documentation Server

Source: https://docs.preside.org/docs/build

Starts a local development server using CommandBox on port 4040 to serve the Preside CMS documentation. Changes to source files will trigger automatic rebuilds.

```Shell
documentation>./serve.sh
```

--------------------------------

### Lucee Struct Case Preservation

Source: https://docs.preside.org/serverguides/serversetupfoundation

Configures Lucee to preserve the original case of keys in structs for proper Preside CMS operation. The setting differs between Lucee versions.

```APIDOC
Lucee 4.x:
Lucee Server Admin -> Settings -> Language/Compiler
Dot notation: Keep original case

Lucee 5.x:
Lucee Server Admin -> Settings -> Language/Compiler
Key case: Preserve case
```

--------------------------------

### Run Preside Test Suite

Source: https://docs.preside.org/contribguides/runningtests

Instructions for running the Preside test suite from the command line.

```bash
/preside> ./test.sh
```

--------------------------------

### Preside CMS Lucee Datasource Configuration

Source: https://docs.preside.org/serverguides/serversetupfoundation

Sets up the datasource for Preside CMS. The default name is 'preside'. Supports MySQL/MariaDB, and PostgreSQL/Microsoft SQL Server from version 10.5.0 onwards.

```APIDOC
Lucee Web Admin -> Datasources
Datasource Name: preside
Database Type: [MySQL/MariaDB/PostgreSQL/Microsoft SQL Server]
Connection Details: [Database connection information]
```

--------------------------------

### Derivative Configuration Example

Source: https://docs.preside.org/devguides/assetmanager

Shows how to configure a derivative named 'leadImage', including its permissions, editor visibility, auto-queue settings, and image transformations like resizing.

```Java
settings.assetmanager.derivatives.leadImage = {
      permissions     = "inherit"
    , inEditor        = true
    , autoQueue       = []
    , transformations = [ { method="shrinkToFit", args={ width=800, height=400 } } ]
};
```

--------------------------------

### Preside CMS Creating Multiple Admin Applications

Source: https://docs.preside.org/upgradenotes/10-22

Guide on creating multiple distinct administration applications within a single Preside CMS instance. This section covers modular admin setups.

```APIDOC
Creating Multiple Admin Applications:
  Allows for the development of separate, self-contained administration interfaces within a single Preside installation.
  Facilitates organization and modularity for complex projects or distinct functional areas.
  Details on structuring and configuring multiple admin applications.
```

--------------------------------

### Preside Admin Request Routing

Source: https://docs.preside.org/devguides/routing

Demonstrates how URLs starting with the admin path are routed to specific ColdBox events and how request context (RC) variables are populated. Includes examples of building admin links.

```cfml
Coldbox event : admin.sitetree.editPage
Coldbox RC    : { id : "F4554E4C-9347-4F7E-B5F862595BFC9EBF" }
```

```cfml
event.buildAdminLink( linkTo="sitetree.editPage", queryString="id=#pageId#" )
or
event.buildLink( linkTo="admin.sitetree.editPage", queryString="id=#pageId#" )
```

--------------------------------

### Lucee Admin API Password Security

Source: https://docs.preside.org/serverguides/serversetupfoundation

Sets Lucee Admin API security to 'Open' to allow Preside version updates via the Admin interface without requiring a password. This affects general API access.

```APIDOC
Lucee Server Admin -> Security -> Access -> General Access
API Access: Open
Websocket Access: Open
```

--------------------------------

### Filtering Records with renderView

Source: https://docs.preside.org/devguides/dataobjectviews

Demonstrates advanced filtering and pagination options for the renderView function, including using complex filter strings, filter parameters, start row, max rows, and order by clauses.

```cfml
rendered = renderView(
      view          = "event/detail"
    , presideObject = "event"
    , id            = eventId
);

rendered = renderView(
      view          = "event/preview"
    , presideObject = "event"
    , filter        = "event_type != :event_type or comment_count < :comment_count"
    , filterParams  = { event_type=rc.type, comment_count=10 }
    , startRow      = 11
    , maxRows       = 10
    , orderBy       = "datepublished desc"
);
```

--------------------------------

### Preside Creating Multiple Admin Applications

Source: https://docs.preside.org/upgradenotes/10-21

Guides on setting up and managing multiple distinct administrator applications within a single Preside instance.

```APIDOC
Creating Multiple Admin Applications:
  - Set up separate admin interfaces for different purposes.
  - Configure distinct dashboards, menus, and permissions for each app.
  - Manage multiple admin applications within one Preside installation.
  - Examples of multi-app configuration.
```

--------------------------------

### Preside Developer Guides - Notifications

Source: https://docs.preside.org/upgradenotes/10-21

Guides on implementing and managing notifications within Preside.

```APIDOC
Notifications:
  - Implement in-app and email notifications.
  - Define notification events and triggers.
  - Manage user notification preferences.
  - Examples of notification implementation.
```

--------------------------------

### Preside Developer Guides - Routing

Source: https://docs.preside.org/upgradenotes/10-21

Guides on configuring and managing URL routing within Preside.

```APIDOC
Routing:
  - Define custom URL structures and patterns.
  - Map URLs to specific controllers and actions.
  - Implement SEO-friendly URLs and redirects.
  - Examples of routing configurations.
```

--------------------------------

### Preside Developer Guides - Multilingual Content

Source: https://docs.preside.org/upgradenotes/10-21

Guides on implementing and managing multilingual content within Preside.

```APIDOC
Multilingual Content:
  - Support for multiple languages in content.
  - Manage translations for pages, labels, and other content elements.
  - Configure language settings and user preferences.
  - Examples of multilingual content implementation.
```

--------------------------------

### Compile Static Assets

Source: https://docs.preside.org/contribguides/buildfromsource

Commands to install Node.js dependencies and compile static assets using Grunt in the system/assets directory.

```bash
/preside/system/assets> npm install && grunt all
```

--------------------------------

### Rendering a Coldbox Viewlet

Source: https://docs.preside.org/devguides/viewlets

An example of how to render a Coldbox viewlet using the runEvent() method, passing specific arguments.

```ColdFusion
#runEvent( event="SomeHandler.myViewlet", prePostExempt=true, private=true, eventArguments={ id=2454 } )#
```

--------------------------------

### Apache2 Proxy Configuration Example

Source: https://docs.preside.org/upgradenotes/10-15

An example configuration for Apache2 to act as a reverse proxy for a Preside CMS application.

```apache
<VirtualHost *:80>
    ServerName your_domain.com

    ProxyPreserveHost On
    ProxyRequests Off
    ProxyPass / http://localhost:8080/ # Assuming Preside runs on port 8080
    ProxyPassReverse / http://localhost:8080/

    ErrorLog ${APACHE_LOG_DIR}/error.log
    CustomLog ${APACHE_LOG_DIR}/access.log combined
</VirtualHost>
```

--------------------------------

### Create and Download Spreadsheet - CFML

Source: https://docs.preside.org/devguides/spreadsheets

This snippet demonstrates how to create a new spreadsheet workbook, add rows from a query, and download it as an Excel file using Preside's injected 'spreadsheetLib'.

```CFML
component {

    // Preside makes the library available as 'spreadsheetLib'
    // that can be injected with wirebox
    property name="spreadsheetLib" inject="spreadsheetLib";

    function index() {
        var workbook    = spreadSheetLib.new();
        var data        = QueryNew( "First,Last", "VarChar,VarChar", [
              [ "Susi"  , "Sorglos"  ] 
            , [ "Frumpo", "McNugget" ]
        ] );

        spreadSheetLib.addRows( workbook, data );
        spreadSheetLib.download( workbook, "testfile.xls" );
    }

}
```

--------------------------------

### Nginx Proxy Configuration Example

Source: https://docs.preside.org/upgradenotes/10-15

An example configuration for Nginx to act as a reverse proxy for a Preside CMS application.

```nginx
server {
    listen 80;
    server_name your_domain.com;

    location / {
        proxy_pass http://localhost:8080; # Assuming Preside runs on port 8080
        proxy_set_header Host $host;
        proxy_set_header X-Real-IP $remote_addr;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_set_header X-Forwarded-Proto $scheme;
    }

    # Optional: Serve static assets directly from Nginx
    location /static/ {
        alias /path/to/preside/static/;
    }
}
```

--------------------------------

### Preside CI/CD and Build Packaging

Source: https://docs.preside.org/contribguides/branchingmodel

Describes how Travis CI is used to automate testing and packaging of Preside builds. It explains where builds for different branches and tags are made available.

```APIDOC
CI/CD Process:

- Travis CI runs the test suite on every push.
- Travis CI creates packaged zip files for:
  - release branches
  - pushed tags

Build Locations:

- Tagged releases: 'stable' folder on downloads site.
- Release branches: 'bleeding-edge' folder on downloads site.
```

--------------------------------

### Dash/Zeal Documentation Feed

Source: https://docs.preside.org/download

Instructions for installing the Preside documentation as a docset for Dash or Zealdocs by adding a specific feed URL.

```APIDOC
Feed URL:
https://docs.preside.org/dash/presidecms.xml
```

--------------------------------

### Preside Developer Guides - Data Objects

Source: https://docs.preside.org/upgradenotes/10-21

Guides on defining and working with data objects in Preside, including schema definition and relationships.

```APIDOC
Data Objects:
  - Define data structures and their properties.
  - Establish relationships between data objects (one-to-one, one-to-many).
  - Configure data object metadata and validation rules.
  - Examples of data object definitions.
```

--------------------------------

### Preside System Alert Handler Example

Source: https://docs.preside.org/devguides/systemAlerts

A comprehensive example of a Preside system alert handler component written in ColdFusion (CFML). It demonstrates the required `runCheck` method for defining alert conditions and optional methods for rendering, scheduling, and configuring alert behavior.

```ColdFusion
component {

  /**
   * Required. The runCheck( check ) method is used to perform your health
   * check. Use the passed `check` object to report failure or success
   */
  private void function runCheck( required systemAlertCheck check ) {
    var type      = check.getType(); // optional
    var reference = check.getReference(); // optional, used for context specific checks

    if ( _someLogicFails( reference ) ) {
      check.fail(); // required to mark as failed
      check.setLevel( "critical" ); // not required
      check.setData( { customData="canBeAdded" } ); // not required
    }
	// Note that the check is in a "passing" state by default, so we do not need to
	// explicitly set it as passing, unless we are overriding a previous instruction
  }

  /**
   * Optional, but recommended. Renders the alert in the admin
   * Should provide detail for the user about how to resolve the
   * issue
   *
   * args struct contains any data passed to check.setData() in runCheck
   */
  private string function render( event, rc, prc, args={} ) {
    return renderView( view="/admin/systemAlerts/myAlert/render", args=args );
  }


// CONFIG SETTINGS
  /**
   * Optional. Implement this method and return true to have the check run at startup
   *
   */
  private boolean function runAtStartup() {
    return true;
  }

  /**
   * Optional. Implement this method to have your check run on a schedule.
   * Must return a valid 6 point cron expression.
   *
   */
  private string function schedule() {
    return "0 0 */2 * * *"; // every two hours
  }

  /**
   * Optional. Implement this method to return an array of system category settings
   * to watch. If the settings change, then the check is run.
   *
   */
  private array function watchSettingsCategories() {
    return [ "email" ];
  }

  /**
   * Optional (default is warning). Implement this method to set
   * the default level of alert for all alerts raised using this check
   *
   */
  private string function defaultLevel() {
    return "info";
  }

  /**
   * Optional (default to empty, meaning 'global'). should return
   * a string, denoting the area of the application for which the
   * alert is relevant. If not specified, the system alert will
   * relate to the application as a whole.
   */
  private string function context() {
    return "events";
  }

  /**
   * Optional. should return an array of reference values, which
   * will be passed in turn to the `runCheck()` function to run
   * multiple checks. This will be done IF the `references()` method
   * is defined AND the `runCheck()` method is called without otherwise
   * specifying a reference. So, as an example, the method might return
   * an array of IDs of all events set to take place in the future, and
   * the check can then be run against each in turn.
   *
   * The method is passed one argument, `trigger`, which tells you how the
   * check was called (for instance, you may want different logic if the
   * check is being run at startup).
   *
   */
  private array function references( string trigger ){
    return _getEventIdsToCheckForGlobalRecheck();
  }

}
```
Tokens:
Raw