Gentics CMS-OSS Documentation

This documentation contains information useful for Gentics CMS implementors, developers and users. Due to extensive changes introduced with Gentics CMS 6.0 some parts of the guides are currently work in progress.

General

Editor and Administration User Interfaces

Overview of Gentics CMS user interfaces

Features

Overview of Gentics CMS features

System Requirements

Gentics CMS System Requirements.

Compatibility List

Contains a list of supported browsers, databases and drivers

Changelog CMS OSS

The Gentics CMS OSS Changelog (online version)

Downloads

Gentics CMS related downloads

Support

Gentics CMS support related information

Publishing

How the publish process works

Third party licenses

List of used licenses

Administration

Installing Gentics CMS

Learn how to install Gentics CMS

Email Sending

Configuration settings for Email Sending capability

Backup

Learn how to backup Gentics CMS

CRSync

Synchronizing Content Repositories with the CRSync

Log Files

Learn where to find the log files of Gentics CMS

Configure & control the Scheduler

Configure & control the Scheduler including its API

Monitoring

ContentRepositories

Node specific settings

Explains how node specific settings can be configured and retrieved vir the REST API

Custom Tools

Add custom tools to the new UI

Custom Proxy

Forward calls to custom resources

Docker

Running the CMS docker image

Clustering

Information on the cluster support

Implementation

Updating implementations

Guide for safely updating implementations with the UpdateImplementation command-line tool

Meta Attributes

List of meta attributes that can be used in tagtypes and templates

Part Types

List of all existing part types

Rendering with Handlebars

Rendering in the CMS with Handlebars is an alternative to Velocity

Using Velocity in Tagtypes

Learn how to use velocity in Tagtypes

GenticsImageStore

Learn how to use the GenticsImageStore

Page variants

How page variants work

SEO URLs

Generating SEO URLs

GlobalIdSync Tool

Tool for synchronizing global IDs between systems

GCMSUI Bridge

Learn how and for what to use the GCMSUI Bridge in your custom UI implementations

Authentication

Authentication via REST API

Describes possible authentication methods for the REST API

Keycloak

How to authenticate Gentics CMS users using Keycloak

Fileupload

File upload

Explains the different file uploaders available

Java API

Java API JavaDoc

Contains the Gentics CMS Java API Documentation

REST API

API Documentation

Contains the REST API Documentation

API JavaDoc

Contains the REST API JavaDoc

Authentication

Describes possible authentication methods for the REST API

Java Client

Explains the functionality of the REST API Java Client

OpenAPI v.3.0 specification

Describes the details of the usage of OpenAPI specification files

Aloha Editor

Integration with Gentics CMS

Explains how the Aloha Editor is integrated in Gentics CMS

Aloha Editor Migration Guide

Update your existing projects to use Aloha Editor

Integration Plugin

Explains the configuration and features of the integration plugin

Aloha Editor Page Link Tag

How the Aloha Editor Page Link Tag should look like

Aloha Editor Plugins

Explains how to load plugins and add new ones

Aloha Editor Settings

Explains how to set plugin configurations within the node.conf

Persisting Aloha Editor plugin settings in pages

How to persist plugin settings in page object properties

Repository Browser configuration

Configuration of several options for the Repository Browser

Aloha Spellcheck Plugin

Explains the configuration of the spellcheck plugin

Gentics CMS JavaScript API

Overview

An overview of the Gentics CMS JavaScript API, and how to use it

API Documentation

Contains the API Documentation

Authentication

How authentication works

Frontend Editing

How to implement frontend editing from scratch

Pages

How to work with pages

Tags

About Tags and Tag Containers

Folders

How to work with folders

Messages

How to work with inbox messages

Nodes

How to work with nodes

Files and Images

How to work with files and images

Publish/Subscribe

How the message bus works

Publish/Subscribe Messages

A list of all pub/sub message and how to use them

Devtools

Overview

An overview of the Devtools

Configuration

Configuration of the Devtools

Synchronization details

Details of the synchronization mechanism

UI

Short description of the devtools UI