Magnolia CMS

https://docs.magnolia-cms.com/
Admin
Magnolia CMS is a powerful, open-source content management system designed for enterprise-level...
Tokens:3,346,125
Snippets:23,851
Trust Score:10
Update:1 week ago
Show doc for...
Tokens:
Raw
### Install and start React app

Source: https://docs.magnolia-cms.com/product-docs/apps/developing-an-app/Developing-a-custom-pages-app

Navigate to the React application directory and install dependencies, then start the development server. Run after starting Magnolia with `mgnl start`.

```bash
cd spa/spa-react-app
```

```bash
npm install && npm run start
```

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

### Start the React app

Source: https://docs.magnolia-cms.com/product-docs/magnolia-front-end-development/Jumpstarting-a-headless-magnolia-project

Commands to install dependencies and start the React development server.

```bash
cd spa
npm install
npm run dev
```

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

### Install start plugin manually

Source: https://docs.magnolia-cms.com/magnolia-cli/plugins/available-plugins/start-plugin

Manually install the start plugin via npm. Run this command in the project folder before modifying mgnl.config.js.

```bash
npm install @magnolia/cli-start-plugin
```

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

### Start Magnolia with mgnl start

Source: https://docs.magnolia-cms.com/product-docs/administration/Language/My-first-translation

Run this command in the parent directory of light-modules to install and start Magnolia. Wait for the message 'Server startup in 112737 ms' to confirm completion.

```bash
mgnl start

```

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

### Get content for a given category with catfn.getContentByCategory

Source: https://docs.magnolia-cms.com/product-docs/developing/Templating/Template-scripts/Templating-functions/catfn

Gets content for a given category using catfn.getContentByCategory(). The example starts from the root page node and lists all pages tagged with the category "sports", rendering them as links with their titles.

```freemarker
[#assign rootPage = cmsfn.asJCRNode(cmsfn.root(content, "mgnl:page"))!]
[#assign sportsContent = catfn.getContentByCategory(rootPage, "sports")]
[#if sportsContent??]
    [#list sportsContent as catNode ]
        [#if catNode.isNodeType("mgnl:page")]
            [#assign link=cmsfn.link(catNode)]
            [#assign title=cmsfn.asContentMap(catNode).title!catNode.getName()]
            <a href="${link}">${title}</a><br/>
        [/#if]
    [/#list]
[/#if]
```

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

### Start the server and tail logs

Source: https://docs.magnolia-cms.com/product-docs/administration/Troubleshooting/Memory-issues

Command to start the server and follow the catalina.out log to verify startup after increasing the heap size.

```bash
./magnolia_control.sh start && tail -f ../logs/catalina.out
```

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

### Example output from running plugin

Source: https://docs.magnolia-cms.com/magnolia-cli/plugins/developing-plugins/testing-plugins

The following should be displayed when running the plugin with the example command.

```text
Plugin started
options { name: 'John' }
Hello John
```

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

### Navigate to project directory

Source: https://docs.magnolia-cms.com/vercel/nextjsproject

Change into the newly created project directory.

```bash
cd my-nextjs-project
```

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

### Successful installation output

Source: https://docs.magnolia-cms.com/product-docs/developing/headless/getting-started-with-magnolia-headless/installation

Example output shown after a successful installation of Magnolia CLI.

```text
/usr/bin/mgnl -> /usr/lib/node_modules/@magnolia/cli/bin/mgnl.js

> spawn-sync@1.0.15 postinstall /usr/lib/node_modules/@magnolia/cli/node_modules/spawn-sync
> node postinstall

+ @magnolia/cli@2.2.0
added 209 packages in 11.40
```

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

### Set up project with Vite

Source: https://docs.magnolia-cms.com/ui-framework-javascript/samples/ds-jsfield-sample

Commands to create a new React project with Vite and install the required dependencies for the color picker sample.

```bash
npm create vite@latest color-field-source -- --template react-ts
cd color-field-source
npm install @magnolia/mgnl-ds-react lucide-react
```

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

### Example storage location

Source: https://docs.magnolia-cms.com/product-docs/getting-started-with-magnolia/Installing-Magnolia

Shows a Windows path example for storing the extracted Magnolia installation.

```plaintext
C:\Users\<username>\magnolia
```

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

### mgnl_cli_setup_project

Source: https://docs.magnolia-cms.com/magnolia-mcp-dev-server/plugins/cli-plugin

Analyzes a project and returns a CLI setup plan.

```APIDOC
## mgnl_cli_setup_project

### Description
Analyze a project and return a CLI setup plan.

### Parameters
No parameters documented.

### Response
Returns a CLI setup plan.
```

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

### Cache get example with getData

Source: https://docs.magnolia-cms.com/product-docs/modules/List-of-modules/Cache-modules/Caching-arbitrary-objects

Example method that retrieves a JsonNode from the cache using get, and if not present, reads it from another source and puts it in the cache. It catches exceptions and puts null to unblock the cache.

```java
public JsonNode getData(String productId) throws Exception {
    Cache cache = cacheFactoryProvider.get().get().getCache(CACHEKEY);
    try {
        JsonNode jsonNode = (JsonNode) cache.get(productId);
        if (jsonNode != null) {
            return jsonNode;
        } else {
            jsonNode = readJson(productId);
            cache.put(productId, jsonNode);
            return jsonNode;
        }
    } catch (Exception e) {
        cache.put(productId, null); //unblock cache!
        throw e;
    }
}
```

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

### Install Java with SDKMAN

Source: https://docs.magnolia-cms.com/product-docs/administration/Language/My-first-translation

Example installation of Java 17.0.12-zulu using SDKMAN, as recommended for local development.

```bash
sdk install java 17.0.12-zulu
```

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

### Expected output after successful setup

Source: https://docs.magnolia-cms.com/product-docs/administration/Language/My-first-translation

Message shown after the setup operation completes, indicating success and next steps.

```text
info: Project successfully downloaded
info: Run "npm run mgnl" to see the list of registered commands
info: Start the project using: "npm run mgnl -- start"
info: If the "StartPlugin" is not available, install it using: "npm run mgnl -- add-plugin @magnolia/cli-start-plugin"
info: For additional plugins and features, refer to the Magnolia CLI documentation: https://docs.magnolia-cms.com/magnolia-cli
```

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

### Choose a starter project prompt

Source: https://docs.magnolia-cms.com/product-docs/magnolia-front-end-development/Jumpstarting-a-freemarker-based-magnolia-project

Interactive CLI prompt for selecting the starter project after choosing demo-webapps. Select 1) magnolia-community-demo-webapp for this guide.

```text
? Choose a template
  1) magnolia-community-demo-webapp
  2) magnolia-dx-core-demo-webapp
```

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

### Install CLI plugin

Source: https://docs.magnolia-cms.com/magnolia-mcp-dev-server/plugins/cli-plugin

Installs the CLI plugin into a new Magnolia MCP dev server setup.

```bash
npx @magnolia/mcp-dev-server-setup install --plugin @magnolia-ai/mcp-cli-plugin
```

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

### Install plugins with --plugin flag (Windows PowerShell)

Source: https://docs.magnolia-cms.com/magnolia-mcp-dev-server/local-development

PowerShell version of the setup installer command using backtick line continuations. Requires Nexus registry authentication for @magnolia-ai packages.

```powershell
npx @magnolia/mcp-dev-server-setup install `
  --plugin @magnolia-ai/mcp-cli-plugin `
  --plugin @magnolia-ai/mcp-magnolia-api-plugin `
  --plugin @magnolia-ai/mcp-designer-plugin `
  --plugin @magnolia-ai/mcp-log-plugin
```

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

### Install Log plugin with npx @magnolia/mcp-dev-server-setup install

Source: https://docs.magnolia-cms.com/magnolia-mcp-dev-server/plugins/log-plugin

Installs the Log plugin into a new or existing Magnolia MCP dev server setup. Run this command in the terminal.

```bash
npx @magnolia/mcp-dev-server-setup install --plugin @magnolia-ai/mcp-log-plugin
```

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

### Install Elasticsearch, Logstash, and Kibana with Brew

Source: https://docs.magnolia-cms.com/magnolia-elasticsearch-provider

Commands to install and start Elasticsearch, Logstash, and Kibana using Homebrew on macOS.

```bash
brew install elasticsearch
brew services start elasticsearch

brew install logstash
brew services start logstash
brew install kibana
brew services start kibana
```

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

### Run setup tool on Windows

Source: https://docs.magnolia-cms.com/magnolia-mcp-dev-server/getting-started

Execute the setup tool within your Magnolia project directory on Windows.

```bash
cd path\to\your-magnolia-project
npx @magnolia/mcp-dev-server-setup
```

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

### restore script example with options

Source: https://docs.magnolia-cms.com/product-docs/modules/List-of-modules/Backup-module

Example of running the `restore` script with required options: `-r` for repository location, `-s` for backup source, and `-c` for configuration. This example restores from a non-ZIP backup.

```bash
./bin/restore -r /Users/Name/Workspace/dev-project/magnolia-dev-webapp/target/magnolia-dev-webapp-1.0/repositories/magnolia -s /magnoliaBackups/Sept2016/01 -c /Users/Name/Workspace/dev-project/magnolia-dev-webapp/target/magnolia-dev-webapp-1.0/WEB-INF/config/repo-config/jackrabbit-bundle-mysql-search.xml
```

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

### Getting a search query from a request parameter

Source: https://docs.magnolia-cms.com/product-docs/developing/templating/Template-scripts/Rendering-context-objects

Example of getting a search query from a request parameter using the `ctx` object.

```freemarker
[#assign searchQuery = ctx.parameters['q']!]
```

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

### Build and run the sample webapp

Source: https://docs.magnolia-cms.com/product-docs/modules/List-of-modules/Blossom-module

Build the project and run the magnolia-blossom-sample-webapp using Maven.

```bash
mvn clean verify
cd magnolia-blossom-sample-webapp
mvn jetty:run-war
```

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

### Add API plugin to existing installation with add-plugin

Source: https://docs.magnolia-cms.com/magnolia-mcp-dev-server/plugins/api-plugin

Use this command to add the API plugin to an existing MCP dev server setup. It follows the same installer flow as the install command.

```bash
npx @magnolia/mcp-dev-server-setup add-plugin --plugin @magnolia-ai/mcp-magnolia-api-pluginCopy __
```

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

### Build and start local development containers

Source: https://docs.magnolia-cms.com/product-docs/modules/List-of-modules/Swift-publication-module/Swift-deployment

Run make build and make up to start containers for local development.

```bash
make build
make up
```
Tokens:
Raw