Loading...
 
Skip to main content

Browser Automation

New to Tiki17

See Browser Automation for a list of use cases this opens up.

Browser Automation is based on PhantomJS and CasperJS

Headless Chromium Integration in Tiki with CasperJS

What is it ?

Headless Chromium refers to running the Chromium browser in a "headless" mode, meaning it operates without a graphical user interface (GUI). This allows automated browsing, testing, and rendering of web pages in the background. In Tiki, integrating Headless Chromium via CasperJS enables advanced scripting and automation capabilities, such as generating screenshots, running tests, or processing web content programmatically.

Purpose

The integration of Headless Chromium in Tiki enhances its functionality by providing a robust, scriptable browser engine. CasperJS, a navigation scripting and testing utility, acts as the bridge to enable this feature, making it accessible within Tiki’s ecosystem.

How It Works

CasperJS leverages a headless browser engine (Chromium in this case) to execute scripts and interact with web pages. In Tiki, this integration is configured through a plugin and package installation. Once enabled, Tiki can use CasperJS to perform tasks like automated page rendering or testing without requiring a visible browser window. The feature is controlled via Tiki’s settings, where administrators can activate and configure it.

Requirements

  • Administrative access to Tiki.
  • Chromium installed on the server (required for CasperJS to utilize Headless Chromium functionality).

Setup Process

1. Enable the CasperJS Plugin

  • Navigate to: Settings > General Settings > Editing and Plugins > PluginTab
  • Locate the CasperJS Plugin and enable it.
  • Note: This activates CasperJS support within Tiki’s plugin system.

2. Install the CasperJS Package

  • Go to: Settings > Advanced > Packages
  • Search for and install the package jerome-breton/casperjs-installer.
  • Note: This installs the necessary CasperJS files and dependencies.

3. Enable Headless Browser Integration

  • Access: Settings > General Settings
  • Find the Headless Browser Integration setting (headlessbrowser_integration_type).
  • Set it to CasperJS to activate the integration.
  • Note: This configures Tiki to use CasperJS as the headless browser engine.

How to test?

After completing the setup, test the integration by running a CasperJS-supported task in Tiki (e.g., generating a page screenshot, downloading a PDF or executing a script). Successful execution confirms that Headless Chromium is operational.

With these steps, Headless Chromium integration is fully enabled in Tiki via CasperJS, allowing for advanced automation and scripting capabilities within the platform.