Condation CMS - The Modern Java Flat-File CMS / Documentation - Learn how to use Condation CMS / CondationCMS / Basics / Getting started

Getting started

This section covers the essential steps to get ConditionCMS up and running, including system requirements, installation procedures, and basic server management commands.

Requirements

ConditionCMS requires Java version 25 or later to be installed on your system. Java 25 provides the runtime environment necessary for the ConditionCMS server to execute.

If you do not have Java installed, you can download it from the official Java website or use your system's package manager.

Installation

To install ConditionCMS, follow these steps:

  1. Download the current latest release from the official GitHub repository.
  2. Unzip the release archive to a folder of your choice on your system.

Since version 8.0.0, ConditionCMS provides pre-built releases for all major operating systems, including Linux, Windows, and macOS. These releases include the required Java 25 runtime, eliminating the need to install Java separately if you use a pre-built release.

Configuration Files

After installation, you will need to configure three main configuration files to customize your ConditionCMS deployment:

  • Server configuration - Configure server settings such as port, IP address, IPC, and performance management
  • Site configuration - Configure individual site settings including hostname, theme, caching, and content processing
  • Media configuration - Configure media formats, image transformations, and compression settings

Starting the Server

Once ConditionCMS is installed and configured, you can start the server using the command-line interface:

./server.sh server start

This command launches the ConditionCMS server with the configuration settings defined in your configuration files. The server will begin listening for incoming requests on the configured port and IP address.

Installing Modules

Modules provide additional server-side functionality and must be installed before they can be activated in your site configuration.

To install a specific module:

./server.sh module get <module>

Replace `` with the module name you wish to install (for example, `thymeleaf-module`).

Installing All Required Modules

If you want to install all modules that are required or recommended for your configuration, you can use:

./server.sh module get-all

This command will download and install all available modules, ensuring that all potential dependencies are satisfied. After installation, you can then selectively activate the modules you need in your site configuration.

Installing Extensions

Extensions provide project-specific and theme-specific functionality built in JavaScript.

To install an extension for a specific site:

./server.sh extension install <extension> <host>

Replace `` with the extension identifier and `` with the hostname of the site where the extension should be installed. Extensions are site-specific and must be installed for each host that requires them.

Installing Themes

Themes provide pre-designed layouts and styling for your sites.

To install a theme:

./server.sh theme get <theme>

Replace `` with the theme name you wish to install. Once a theme is installed, you can activate it by setting the `theme` parameter in your site configuration file.

For more detailed information about each configuration aspect, refer to the specific documentation pages linked above.