ChestnutCMS

The following resources are available for deployment, configuration, and usage:

• Getting Started: Quickstart Guide
• Configuration: Common Configuration
• Deployment:
  • JAR Deployment
  • Docker Deployment
  • Site Access Configuration
• Manuals:
  • User Manual
  • Template Manual (Variables & Tags)
• Troubleshooting: FAQ
• Changelog: Version Changes

UEditorPlus supports extensible AI functions via the aiFunctions array in window.UEDITOR_CONFIG. Each function defines how the AI interacts with the selected text or the entire HTML content.

Function Properties:

• name: Unique identifier for the function.
• text: The label/icon displayed in the UI (supports HTML).
• systemPrompt: The instructions sent to the AI driver.
• prompt: The template for the user's input. Supports placeholders like {selectText} (for selected text) or {html} (for the entire document content).
• enable: A predicate function (context) => boolean to determine if the function should be active.
• param: (Optional) Configuration for UI behavior, such as showInsert, showReplace, or showReplaceAll.

Available Built-in Functions:

• translate: Translates selected text.
• continueWrite: Continues writing from the selection.
• summarize: Simplifies the selected text.
• extend: Expands the selected text with more detail.
• optimizeWhole: Optimizes the entire document's HTML/content (uses {html} prompt).

// Example of adding a custom AI function
window.UEDITOR_CONFIG.aiFunctions.push({
  name: "myCustomAI",
  text: "<i class="edui-iconfont"></i> Custom",
  systemPrompt: "You are a helpful assistant.",
  prompt: "{selectText}",
  enable: function(context) {
    return !!context.selectText;
  }
});

The chestnut-search module provides a docker-compose.yml configuration to deploy a single-node Elasticsearch instance.

Key Configuration Details:

• Image: Uses a placeholder {{DOCKER_IMAGE}} which must be replaced with a valid Elasticsearch image.
• Ports: Exposes 9200 (HTTP interface) and 9300 (Transport interface).
• Environment Variables:
  • discovery.type: single-node: Configures Elasticsearch to run without cluster discovery requirements.
  • ES_JAVA_OPTS: Sets JVM heap size. The default is -Xms1024m -Xmx1024m.
• Volumes: Requires the following local directory structure to persist data and configurations:
  • ./elasticsearch/config/elasticsearch.yml: Configuration file.
  • ./elasticsearch/data: Data persistence.
  • ./elasticsearch/logs: Log files.
  • ./elasticsearch/ik-config: Configuration for the IK analyzer plugin.
• Resource Limits: Sets memlock ulimits to -1 (unlimited) to allow Elasticsearch to lock memory.
• Healthcheck: Uses curl against localhost:9200/_cluster/health to monitor service availability.

version: '3'
services:
  cc-elasticsearch:
    image: {{DOCKER_IMAGE}}
    restart: unless-stopped
    container_name: cc-elasticsearch
    ports:                                                
      - 9200:9200                                          
      - 9300:9300                                         
    environment:
      discovery.type: single-node
      ES_JAVA_OPTS: -Xms1024m -Xmx1024m
    volumes:
      - ./elasticsearch/config/elasticsearch.yml:/usr/share/elasticsearch/config/elasticsearch.yml
      - ./elasticsearch/data:/usr/share/elasticsearch/data
      - ./elasticsearch/logs:/usr/share/elasticsearch/logs
      - ./elasticsearch/ik-config:/usr/share/elasticsearch/plugins/ik/config
    ulimits:
      memlock:
        soft: -1
        hard: -1

The bin/docker-deploy.sh script automates the deployment process for ChestnutCMS using Docker. It performs the following sequence of operations:

1. Authentication: Logs into the specified Docker Hub URL using provided credentials.
2. Image Pulling: Pulls the specific image version defined by IMAGE_REPOSITORY and IMAGE_TAG.
3. Cleanup of <none> Images:
   • Identifies dangling/intermediate images associated with the repository.
   • Stops any containers currently running from those <none> images.
   • Removes the stopped containers.
   • Deletes the <none> images themselves.
4. Deployment: Starts the application using docker compose up -d.

Note: This script uses template placeholders (e.g., {{DOCKERUSER}}) which must be replaced with actual values before execution.

# Ensure the following variables are populated in the script:
DOCKERUSER={{DOCKERUSER}}
DOCKERPWD={{DOCKERPWD}}
DOCKER_HUB_URL={{DOCKER_HUB_URL}}
IMAGE_REPOSITORY={{IMAGE_REPOSITORY}}
IMAGE_TAG={{IMAGE_TAG}}

# Execute the deployment script
./bin/docker-deploy.sh