Paths

Where the configuration, forms, playbooks, uploads and backups live

Variable Choices/Defaults Comments
BACKUP_PATH
string
Default:
%PERSISTENT_FOLDER%/backups

Backup path
a valid directory path

Ansible Forms can backup the database and forms. This is the path where the backups are stored. The backup folder is created at first start if not present and a timestamp folder is created for each backup.
CONFIG_PATH
string
added in version 6.1.0
Default:
%PERSISTENT_FOLDER%/config.yaml

config.yaml path
a valid file path

The config.yaml file contains application configuration (categories, roles, constants).
This replaces the deprecated config.yaml file. Forms should now be stored in the forms/ folder.
FORMS_FOLDER_PATH
string
added in version 6.1.0
Default:
%PERSISTENT_FOLDER%/forms

Forms folder path
a valid directory path

The directory where individual form YAML files are stored. Forms can be organized in subdirectories within this folder.
FORMS_STAGING_PATH
string
added in version 6.1.0
Default:
%PERSISTENT_FOLDER%/forms_staging

Forms staging folder path
a valid directory path

When forms come from a git repository, a form created or edited in the designer is written here first and only lands in the repository once it is pushed. The loader reads this folder alongside the repository ones, so a staged form is usable immediately.
FORMS_PATH
string
Default:
%PERSISTENT_FOLDER%/forms.yaml

forms.yaml path (DEPRECATED)
a valid file path

DEPRECATED in v6.0.0 - Use CONFIG_PATH and FORMS_FOLDER_PATH instead.

The forms.yaml file was the legacy configuration file that combined both configuration and forms. Please migrate to the new structure:

  • Configuration (categories, roles, constants) → config.yaml (CONFIG_PATH)
  • Forms → individual files in forms/ folder (FORMS_FOLDER_PATH)
LOCK_PATH
string
Default:
%PERSISTENT_FOLDER%/ansibleForms.lock

Designer lock file path
a valid file path

Only 1 user can use the designer, so we use a locking file to hold the current owners information.
FORMS_BACKUP_PATH
string
added in version 4.0.3
Default:
%PERSISTENT_FOLDER%/form_backups

Backup path for form backups
a valid directory path

When backups are made, they end up in this path
HOME_PATH
string
added in version 3.0.0
Default:
OS Homedir path

The users home directory
a valid path

Ansible Forms generates an sshkey at first start, is one is not present, so you can have a git connection or other password-less connection.
Typically this key is stored in the users home-directory under /.ssh/id_rsa. You can set this homedirectory path manually with this property.
REPO_PATH
string
added in version 3.0.0
Default:
%PERSISTENT_FOLDER%/repositories

Repositories path
a valid path

This path is the root path for your local repositories, allowing you to integrate data with git repositories.
VARS_FILES_PATH
string
added in version 6.1.0
Default:
%PERSISTENT_FOLDER%/vars

Base path for vars files
a valid directory path

Base directory for resolving relative paths in form varsFiles property. Absolute paths in varsFiles are used as-is. Relative paths are resolved against this directory. Allows centralized management of shared variable files across forms.
ANSIBLE_PATH
string
Default:
%PERSISTENT_FOLDER%/playbooks

The path of the ansible playbooks (local instance)
a valid path

Ansible Forms can have a local ansible instance. This path says where the playbooks are.
UPLOAD_PATH
string
added in version 4.0.16
Default:
%PERSISTENT_FOLDER%/uploads

The path for file uploads
a valid path

Since 4.0.16, a new field type is introduced that allows file uploads. The files are uploaded in this path.