Skip to main content
Version: 4.49.0-beta

Installation Guide

Welcome to Xill4!

This guide will help you to set up the Xill4 application as a background service.

Prerequisites​

As a prerequisite, you need to have a MongoDB instance (5.x or higher) running. If you don't have one, you can install it using the MongoDB installer from the MongoDB website.

By default, Xill4 will try to connect to mongodb://localhost:27017/xill4_system. If you want to change this, you can do so by setting the XILL4_SYSTEM_MONGO_CONNECTION system environment variable.

Installation​

  1. Verify or add the following environment variables:
  • XILL4_LICENSE_KEY (required)
  • XILL4_KEYCLOAK_DISABLED (optional, default: false). Set to true to disable authentication. For more information on how to set up authentication, see the documentation
  • XILL4_WORKDIRS (optional, default: n/a). Set if file system access is required. For more information on how to set up file system access, see the documentation
  • XILL4_ENVIRONMENT_SECRET (required) A string that is used to encrypt and decrypt secrets. This is used to store sensitive data. To be safe try to come up with a unique string Example: MyFavoriteSongIsAlejandroByLadyGaga
  • XILL4_DATABASE_CONNECTION_STRING (required). The connection string to the MongoDB instance. This is used both for the system database.

Although not required, we recommend setting the following environment variables XILL4_PROJECT_DIRECTORY and XILL4_VAULT_PATH to change the default locations of the project and vault directories. This eases the upgrade process.

  1. Run the install.bat file to install Xill4 as a service from the command line with administrator privileges.

Upgrade​

  1. Back up your project folder.
  2. Run the uninstall.bat file to uninstall Xill4 as a service from the command line with administrator privileges.
  3. Run the upgrade.exe tool to upgrade your existing projects.
  4. Run the install.bat file to install Xill4 as a service from the command line with administrator privileges.
note

There is currently a hard limit of 34 projects while upgrading. If you need to upgrade more projects, separate them in multiple folders.

Uninstalling​

  1. Run the uninstall.bat file to uninstall Xill4 as a service from the command line with administrator privileges.

Usage​

By default, the application will be accessible using the browser and is running using the Local System account. The account can be changed using the Windows Services Manager. Further configuration can be done using environment variables described in the built-in documentation, which is accessible from the front page of the application and on the Xillio website.