路径

配置、表单、playbook、上传文件和备份的存放位置

  1. 示例
  2. 变量

修改这些变量,以将部分数据保存在另一个卷上,例如将备份和上传文件放在更大或更便宜的存储上。


示例

备份和上传的文件放在单独的卷上,其余数据放在常用的持久化文件夹中。在 docker-compose.yml 中:

    environment:
      - BACKUP_PATH=/data/backups
      - FORMS_BACKUP_PATH=/data/forms_backups
      - UPLOAD_PATH=/data/uploads
    volumes:
      - /srv/ansibleforms-data:/data

新路径只对新文件生效:旧文件夹中已有的内容不会被移动,请自行复制过去。


变量

本组的所有变量,包括其类型、默认值和描述:

变量 可选值/默认值 说明
BACKUP_PATH
string
默认值:
%PERSISTENT_FOLDER%/backups

Backups folder
a valid directory path

AnsibleForms 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
默认值:
%PERSISTENT_FOLDER%/config.yaml

config.yaml path
a valid file path

The config.yaml file contains application configuration (categories, roles, constants).
Forms are not in this file: they are stored in the forms folder (FORMS_FOLDER_PATH).

FORMS_FOLDER_PATH
string
added in version 6.1.0
默认值:
%PERSISTENT_FOLDER%/forms

Forms folder
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
默认值:
%PERSISTENT_FOLDER%/forms_staging

Forms staging folder
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_BACKUP_PATH
string
added in version 4.0.3
默认值:
%PERSISTENT_FOLDER%/forms_backups

Form backups folder
a valid directory path

When backups are made, they end up in this path

HOME_PATH
string
added in version 3.0.0
默认值:
OS Homedir path

Home folder
a valid path

AnsibleForms 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
默认值:
%PERSISTENT_FOLDER%/repositories

Repositories folder
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
默认值:
%PERSISTENT_FOLDER%/vars

Vars files folder
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.

INVENTORY_PATH
string
added in version 7.0.0
默认值:
%PERSISTENT_FOLDER%/inventories

Inventories folder
a valid directory path

The local inventories folder: one folder per inventory (staging/inventory.yaml, with its group_vars and host_vars), edited in the designer’s Inventories section, next to the repositories used for inventories (each of them an inventory). A playbook form names one with inventory: <name>. Read by the RTE as well, where the playbook runs: set it there too (or mount the same folder) when the RTE runs elsewhere.

WORKFLOWS_PATH
string
added in version 7.0.0
默认值:
%PERSISTENT_FOLDER%/workflows

Workflows folder
a valid directory path

The local workflows folder: workflow files in the AWX export syntax (workflow_job_templates, a job template node running one of the designer’s playbooks), edited in the designer’s Workflows section, next to the repositories used for workflows. A workflow form runs one with workflow: <name>.

ANSIBLE_PATH
string
默认值:
%PERSISTENT_FOLDER%/playbooks

Where an RTE finds the playbooks
a valid path

Read by an RTE (AF_ROLE=rte): the folder its playbooks run from when no repository is marked for playbooks. Since 7 the app runs no playbook itself, so set this in the RTE container’s environment ; it is not editable on the Settings page.

UPLOAD_PATH
string
added in version 4.0.16
默认值:
%PERSISTENT_FOLDER%/uploads

Uploads folder
a valid path

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