- Created by Unknown User (thomasseedorf), last modified by Unknown User (colin) on May 18, 2022
Directory Structure
The following tables contains the Agiloft directory structure with a description of each directory's or file's purpose. The table also indicates whether a directory or file is required to maintain on a replicated copy in order to restore a backup of the system.
Release 2019_01 (June 2019 / Version 6 R10.4 ) or newer
Path | Description | Required for Backup/Replication? |
---|---|---|
On Windows: C:\EnterpriseWizardConfig.xml | Main Agiloft configuration file. It contains all the parameters of the instance and is used by the installer for upgrades and reconfiguration. | Yes |
AGILOFT_HOME | Root directory of the Agiloft instance. | Yes |
All paths below are relative to AGILOFT_HOME . | ||
data | Main directory for non-database data. | No |
data/backups | Contains backups made by Agiloft on a knowledgebase level. It contains a directory for each knowledgebase on the server. The directory names match the knowledgebase names. | No |
data/<KB NAME>/scripts | Contains external scripts used by rules. | Yes |
data/<KB NAME>/largeObjects | Contains the content of attached files in a knowledgebase. Metadata is stored in a database, so if an OS-level backup of the database is done, the directories for each knowledgebase must also be stored. | Yes |
data/<KB NAME>/reports | Contains the results of scheduled reports that have been executed. | No |
data/<KB NAME>/wallet | Contains the private key used to decrypt knowledgebase data if the encrypt/decrypt feature is used. | No |
data/<KB NAME>/keystore | Contains a backup of the knowledgebase's private key. | Yes |
jre | Directory for the Java Runtime Environment shipped with Agiloft. It's used to avoid possible compatibility issues if Java is already installed on the server. | Yes |
wildfly | Root directory of the Wildfly Application Server. It contains the server itself and the deployed Agiloft code. The Agiloft configuration is stored in the wildfly/standalone/configuration/ directory. | Yes |
| Contains wildfly logs. Can be excluded from any backups. | No |
| Contains application temporary data and should be excluded from any backups. | No |
logs | Directory for log files of installation, upgrade, and configuration modifications. | No |
software | Directory for downloaded third-party software that is not included with the Agiloft distribution. | No |
spool | Directory for temporarily storing incoming and outgoing emails used by the Agiloft email subsystem. | No |
resources | Directory for all project information, scripts, and nginx-related items. | Yes |
alWinProperty.properties | Contains build and software update properties. | Yes |
bin | Directory for Agiloft internal executables, including installer utilities, start and stop scripts, diagnostics, and other management tools. | Yes |
issue/amd64-windows.xml /linux.xml | Contains the configuration of all software details and versions. | Yes |
lib | Directory for project-related jar files. | Yes |
htdocs | Directory for knowledgebase-specific login pages. | Yes |
EnvironmentVars | File used to set environment variables, such as "EW_STARTUPCHECKER_SKIP_CHECKS_UNLESS_PATCHED=true," and should move with the installation between servers if the Agiloft application is moved. If any environment variables are set when the application is installed, this file is used. | Yes |
Setup.exe | Utility for setting different configuration settings, such as Wildly and database configuration, web server integration, Agiloft services control, software updates, backups and restores, snapshots, mail settings, etc. | Yes |
uninstall.exe | Utility for uninstalling the Agiloft application. | Yes |
clamav | Root directory for ClamAv antivirus. | No |
Python | Python installation shipped with Agiloft and used by custom script actions. | No |
update/current/ | Directory used when upgrading that keeps a backup of the current system's configuration files and the latest installer resources. In case of an upgrade failure, the configuration files are restored to help rollback the application to its last working state. With a successful upgrade, the backup files and installer resources are removed from this folder. | No |
license | Directory for storing html files that describe the terms and conditions of Agiloft's End-user License Agreement. | No |
tmp | Directory for storing temporary files that are required during installation or when upgrading. Files in this directory are generally deleted after usage. | No |
build.xml | Ant build file with target actions that deploy configuration files and unzip the dependent software resources required to run Agiloft. | No |
conf | Directory storing the samplekbconf.xml file, which contains the knowledgebase's configuration of tables and features supported in the system. | No |
mysql | MySQL DB root directory. | Yes |
Release 2018_02 (November 2018 / Version 6 R10.3) / or older
Path | Description | Required for Backup? |
---|---|---|
On Windows: C:\EnterpriseWizardConfig.xml | Main Agiloft configuration file. It contains all the parameters of the instance and is used by the installer for upgrades and reconfiguration. | Yes |
AGILOFT_HOME | Root directory of the Agiloft instance. | Yes |
All paths below are relative to AGILOFT_HOME . | ||
data | Main directory for non-database data. | No |
data/backups | Contains backups made by Agiloft on a knowledgebase level. It contains a directory for each knowledgebase on the server. The directory names match the knowledgebase names. | No |
data/<KB NAME>/scripts | Contains external scripts used by rules. | Yes |
data/<KB NAME>/largeObjects | Contains the content of attached files in a knowledgebase. Metadata is stored in a database, so if an OS-level backup of the database is done, the directories for each knowledgebase must also be stored. | Yes |
data/<KB NAME>/reports | Contains the results of scheduled reports that have been executed. | No |
data/<KB NAME>/wallet | Contains the private key used to decrypt knowledgebase data if the encrypt/decrypt feature is used. | No |
data/<KB NAME>/keystore | Contains a backup of the knowledgebase's private key. | Yes |
jre | Directory for the Java Runtime Environment shipped with Agiloft. It's used to avoid possible compatibility issues if Java is already installed on the server. | Yes |
jboss | Root directory of the Jboss Application Server. It contains the server itself and the deployed
Agiloft code. The
Agiloft configuration and code is stored in the | Yes |
jboss/server/sw/log | Contains jboss logs. Can be excluded from any backups. | No |
jboss/server/sw/tmp | Contains application temporary data and should be excluded from any backups. | No |
jboss/server/sw/work | Contains application temporary data and should be excluded from any backups. | No |
logs | Directory for log files of installation, upgrade, and configuration modifications. | No |
software | Directory for downloaded third-party software that is not included with the Agiloft distribution. | No |
spool | Directory for temporarily storing incoming and outgoing emails used by the Agiloft email subsystem. | No |
resources | Directory for all project information, scripts, and nginx-related items. | Yes |
alWinProperty.properties | Contains build and software update properties. | Yes |
bin | Directory for Agiloft internal executables, including installer utilities, start and stop scripts, diagnostics, and other management tools. | Yes |
issue/amd64-windows.xml /linux.xml | Contains the configuration of all software details and versions. | Yes |
lib | Directory for project-related jar files. | Yes |
htdocs | Directory for knowledgebase-specific login pages. | Yes |
EnvironmentVars | File used to set environment variables, such as "EW_STARTUPCHECKER_SKIP_CHECKS_UNLESS_PATCHED=true," and should move with the installation between servers if the Agiloft application is moved. If any environment variables are set when the application is installed, this file is used. | Yes |
Setup.exe | Utility for setting different configuration settings, such as Jboss and database configuration, web server integration, Agiloft services control, software updates, backups and restores, snapshots, mail settings, etc. | Yes |
uninstall.exe | Utility for uninstalling the Agiloft application. | Yes |
clamav | Root directory for ClamAv antivirus. | No |
Python | Python installation shipped with Agiloft and used by custom script actions. | No |
update/current/ | Directory used when upgrading that keeps a backup of the current system's configuration files and the latest installer resources. In case of an upgrade failure, the configuration files are restored to help rollback the application to its last working state. With a successful upgrade, the backup files and installer resources are removed from this folder. | No |
license | Directory for storing html files that describe the terms and conditions of Agiloft's End-user License Agreement. | No |
tmp | Directory for storing temporary files that are required during installation or when upgrading. Files in this directory are generally deleted after usage. | No |
build.xml | Ant build file with target actions that deploy configuration files and unzip the dependent software resources required to run Agiloft. | No |
conf | Directory storing the samplekbconf.xml file, which contains the knowledgebase's configuration of tables and features supported in the system. | No |
mysql | MySQL DB root directory. | Yes |
CONTENTS
- No labels