文档AEM 6.4开发指南

如何使用VLT工具 how-to-use-the-vlt-tool

Last update: Thu May 04 2023 00:00:00 GMT+0000 (Coordinated Universal Time)

创建对象：

  • Developer
CAUTION
AEM 6.4已结束扩展支持，本文档将不再更新。 有关更多详细信息，请参阅 技术支助期. 查找支持的版本 此处.

Jackrabbit FileVault工具(VLT)是由 Apache Foundation 将Jackrabbit/AEM实例的内容映射到您的文件系统。 VLT工具具有与源控制系统客户端(如Subversion(SVN)客户端)类似的功能，提供正常的签入、签出和管理操作，以及用于灵活表示项目内容的配置选项。

从命令行运行VLT工具。 本文档介绍如何使用该工具，包括如何入门和获取帮助，以及所有工具的列表 命令 可用 选项.

概念和架构 concepts-and-architecture

请参阅 Filevault概述 和 保管库FS 官方 Apache Jackrabbit Filevault文档 以全面了解Filevault工具的概念和结构。

VLT快速入门 getting-started-with-vlt

要开始使用VLT，您需要执行以下操作：

  1. 安装VLT、更新环境变量和更新全局忽略的subversion文件。
  2. 设置AEM存储库（如果尚未设置）。
  3. 查看AEM存储库。
  4. 与存储库同步。
  5. 测试同步是否正常工作。

安装VLT工具 installing-the-vlt-tool

要使用VLT工具，您首先需要安装该工具。 默认情况下，它不会安装，因为它是一个附加工具。 此外，您还需要设置系统的环境变量。

  1. 从下载FileVault存档文件 Maven对象存储库。

    note note
    NOTE
    VLT工具的来源是 在GitHub上提供。

    1. 提取存档。

  2. 添加 <archive-dir>/vault-cli-<version>/bin 到您的环境 PATH 这样命令文件 vlt 或 vlt.bat 会根据需要进行访问。 例如：

    <aem-installation-dir>/crx-quickstart/opt/helpers/vault-cli-3.1.16/bin>

  3. 打开命令行外壳并执行 vlt --help. 确保输出与以下帮助屏幕类似：

    code language-shell 
    vlt --help
-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------
Jackrabbit FileVault [version 3.1.16] Copyright 2013 by Apache Software Foundation. See LICENSE.txt for more information.
-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------
Usage:
  vlt [options] <command> [arg1 [arg2 [arg3] ..]]
-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------

Global options:

  -Xjcrlog <arg>           Extended JcrLog options (omit argument for help)
  -Xdavex <arg>            Extended JCR remoting options (omit argument for help)
  --credentials <arg>      The default credentials to use
  --update-credentials     if present the credentials-to-host list is updated in the ~/.vault/auth.xml
  --config <arg>           The JcrFs config to use
  -v (--verbose)           verbose output
  -q (--quiet)             print as little as possible
  --version                print the version information and exit
  --log-level <level>      the log4j log level
  -h (--help) <command>    print this help

安装后，您需要更新全局忽略的subversion文件。 编辑svn设置并添加以下内容：

[miscellany]
### Set global-ignores to a set of whitespace-delimited globs
### which Subversion will ignore in its 'status' output, and
### while importing or adding files and directories.
global-ignores = .vlt

配置行字符的结尾 configuring-the-end-of-line-character

VLT会根据以下规则自动处理行结尾(EOF):

  • 在Windows端签出的文件行(带 CRLF
  • 在Linux/Unix端上以 LF
  • 提交到存储库的文件行以 LF

要确保VLT和SVN配置匹配，您应将 svn:eol-style 属性 native 对于存储库中存储的文件的扩展名。 编辑svn设置并添加以下内容：

[auto-props]
*.css = svn:eol-style=native
*.cnd = svn:eol-style=native
*.java = svn:eol-style=native
*.js = svn:eol-style=native
*.json = svn:eol-style=native
*.xjson = svn:eol-style=native
*.jsp = svn:eol-style=native
*.txt = svn:eol-style=native
*.html = svn:eol-style=native
*.xml = svn:eol-style=native
*.properties = svn:eol-style=native

签出存储库 checking-out-the-repository

使用源控制系统检查存储库。 例如，在svn中，键入以下内容（将URI和路径替换为您的存储库）：

svn co https://svn.server.com/repos/myproject

与存储库同步 synchronizing-with-the-repository

您需要将文件与存储库同步。 要执行此操作：

  1. 在命令行中，导航到 content/jcr_root.

  2. 通过键入以下内容(将端口号替换为 4502 和您的管理员密码):

    code language-shell 
    vlt --credentials admin:admin co --force http://localhost:4502/crx
    note note
    NOTE
    在初次结帐时，只能指定一次凭据。 然后，这些文件将存储在您的主目录中 .vault/auth.xml.

测试同步是否正常工作 testing-whether-the-synchronization-worked

签出存储库并同步存储库后，应进行测试以确保所有内容都正常运行。 要实现此目的，一种简单的方法是编辑 .jsp ，并查看在提交更改后是否反映了您所做的更改。

要测试同步，请执行以下操作：

  1. 导航到 .../jcr_content/libs/foundation/components/text。
  2. 在 text.jsp.
  3. 通过键入 vlt st
  4. 通过键入 vlt diff text.jsp
  5. 提交更改： vlt ci test.jsp.
  6. 重新加载包含文本组件的页面，并查看所做的更改是否存在。

获取VLT工具帮助 getting-help-with-the-vlt-tool

安装VLT工具后，可以从命令行访问其帮助文件：

vlt --help
-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------
Jackrabbit FileVault [version 3.1.16] Copyright 2013 by Apache Software Foundation. See LICENSE.txt for more information.
-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------
Usage:
  vlt [options] <command> [arg1 [arg2 [arg3] ..]]
-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------

Global options:
  -Xjcrlog <arg>           Extended JcrLog options (omit argument for help)
  -Xdavex <arg>            Extended JCR remoting options (omit argument for help)
  --credentials <arg>      The default credentials to use
  --update-credentials     if present the credentials-to-host list is updated in the ~/.vault/auth.xml
  --config <arg>           The JcrFs config to use
  -v (--verbose)           verbose output
  -q (--quiet)             print as little as possible
  --version                print the version information and exit
  --log-level <level>      the log4j log level
  -h (--help) <command>    print this help
Commands:
  export                   Export the Vault filesystem
  import                   Import a Vault filesystem
  checkout (co)            Checkout a Vault file system
  status (st)              Print the status of working copy files and directories.
  update (up)              Bring changes from the repository into the working copy.
  info                     Displays information about a local file.
  commit (ci)              Send changes from your working copy to the repository.
  revert (rev)             Restore pristine working copy file (undo most local edits).
  resolved (res)           Remove 'conflicted' state on working copy files or directories.
  propget (pg)             Print the value of a property on files or directories.
  proplist (pl)            Print the properties on files or directories.
  propset (ps)             Set the value of a property on files or directories.
  add                      Put files and directories under version control.
  delete (del,rm)          Remove files and directories from version control.
  diff (di)                Display the differences between two paths.
  rcp                      Remote copy of repository content.
  sync                     Control vault sync service
  console                  Run an interactive console
-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------

要获得特定命令的帮助，请键入help命令，然后键入该命令的名称。 例如：

vlt --help export
Usage:
 export -v|-t <arg>|-p <uri> <jcr-path> <local-path>

Description:
  Export the Vault filesystem mounted at <uri> to the local filesystem at <local-path>. An optional <jcr-path> can be specified in order to export just a sub tree.
  Example:
    vlt export http://localhost:4502/crx /apps/geometrixx myproject

Options:
  -v (--verbose)          verbose output
  -t (--type) <arg>       specifies the export type. either 'platform' or 'jar'.
  -p (--prune-missing)    specifies if missing local files should be deleted.
  <uri>                   mountpoint uri
  <jcr-path>              the jcr path
  <local-path>            the local path

在VLT中执行的常见任务 common-tasks-performed-in-vlt

以下是VLT中执行的一些常见任务。 有关每个命令的详细信息，请参见 命令.

签出子树 checking-out-a-subtree

例如，如果您只想签出存储库的子树， /apps/geometrixx，则可以通过键入以下内容来执行此操作：

vlt co http://localhost:4502/crx/-/jcr:root/apps/geometrixx geo

这样做会创建新的导出根 geo 带有 META-INF 和 jcr_root 目录，并将所有文件放在下面 /apps/geometrixx in geo/jcr_root.

执行过滤结账 performing-a-filtered-checkout

如果您现有的工作区过滤器，并且希望将其用于签出，则可以先创建 META-INF/vault 并将筛选器放置到此处，或在命令行中指定，如下所示：

$ vlt co --filter filter.xml http://localhost:4502/crx/-/jcr:root geo

示例过滤器：

<?xml version="1.0" encoding="UTF-8"?>
<workspaceFilter version="1.0">
    <filter root="/etc/designs/geometrixx" />
    <filter root="/apps/geometrixx"/>
</workspaceFilter>

使用导入/导出，而不是.vlt控件 using-import-export-instead-of-vlt-control

您可以在JCR存储库和本地文件系统之间导入和导出内容，而无需使用控制文件。

无需使用 .vlt 控制：

  1. 最初设置存储库：

    code language-shell 
    $ cd /projects
$ svn mkdir https://svn.server.com/repos/myproject
$ svn co https://svn.server.com/repos/myproject
$ vlt export -v http://localhost:4502/crx /apps/geometrixx geometrixx
$ cd geometrixx/
$ svn add META-INF/ jcr_root/
$ svn ci

  2. 更改远程副本并更新JCR:

    code language-shell 
    $ cd /projects/geometrixx
$ vlt -v import http://localhost:4502/crx . /

  3. 更改远程副本并更新文件服务器：

    code language-shell 
    $ cd /projects/geometrixx
$ vlt export -v http://localhost:4502/crx /apps/geometrixx .
$ svn st
M      META-INF/vault/properties.xml
M      jcr_root/apps/geometrixx/components/contentpage/.content.xml
$ svn ci

使用VLT using-vlt

要在VLT中发出命令，请在命令行中键入以下内容：

vlt [options] <command> [arg1 [arg2 [arg3] ..]]

选项和命令在以下各节中有详细描述。

VLT全局选项 vlt-global-options

以下是VLT选项列表，所有命令均可用。 有关其他可用选项的信息，请参阅各个命令。

选项
描述
-Xjcrlog <arg>
扩展的JcrLog选项
-Xdavex <arg>
扩展的JCR远程处理选项
--credentials <arg>
要使用的默认凭据
--config <arg>
要使用的JcrFs配置
-v (--verbose)
详细输出
-q (--quiet)
尽可能少地打印
--version
打印版本信息并退出VLT
--log-level <level>
指示日志级别，例如log4j日志级别。
-h (--help) <command>
打印该特定命令的帮助

VLT命令 vlt-commands

下表描述了所有可用的VLT命令。 有关语法、可用选项和示例的详细信息，请参阅各个命令。

命令
缩写命令
描述
export
从JCR存储库（保险存储文件系统）导出到本地文件系统，而不使用控制文件。
import
将本地文件系统导入JCR存储库（保险存储文件系统）。
checkout
co
签出Vault文件系统。 将其用于本地文件系统的初始JCR存储库。 (注：必须先在subversion中签出存储库。)
analyze
分析包。
status
st
打印工作副本文件和目录的状态。
update
up
将更改从存储库导入工作副本。
info
显示有关本地文件的信息。
commit
ci
将工作副本中的更改发送到存储库。
revert
rev
将工作副本文件还原为其原始状态，并取消大多数本地编辑。
resolved
res
删除工作副本文件或目录上存在冲突的状态。
propget
pg
在文件或目录上打印属性的值。
proplist
pl
在文件或目录上打印属性。
propset
ps
设置文件或目录上属性的值。
add
将文件和目录置于版本控制下。
delete
del 或 rm
从版本控制中删除文件和目录。
diff
di
显示两个路径之间的差异。
console
运行交互式控制台。
rcp
将节点树从一个远程存储库复制到另一个远程存储库。
sync
允许控制电子仓库同步服务。

导出 export

导出装载在 <uri> 到本地文件系统(位于 <local-path>. 可选 <jcr-path> 可以指定，以便仅导出子树。

语法 syntax

export -v|-t <arg>|-p <uri> <jcr-path> <local-path>

选项 options

-v (--verbose)
详细输出
-t (--type) <arg>
指定导出类型（平台或jar）。
-p (--prune-missing)
指定是否应删除缺少的本地文件
<uri>
mountpoint uri
<jcrPath>
JCR路径
<localPath>
本地路径

示例 examples

vlt export http://localhost:4502/crx /apps/geometrixx myproject

导入 import

导入本地文件系统(从 <local-path> 保险库文件系统(位于 <uri>. 您可以指定 <jcr-path> 作为导入根。 如果 --sync 已指定，则导入的文件会自动置于保管库控制下。

语法 syntax-1

import -v|-s <uri> <local-path> <jcr-path>

选项 options-1

-v (--verbose)
详细输出
-s (-- sync)
将本地文件置于保险存储控制下
<uri>
mountpoint uri
<jcrPath>
JCR路径
<localPath>
本地路径

示例 examples-1

vlt import http://localhost:4502/crx . /

结账(co) checkout-co

从JCR存储库向本地文件系统执行初始签出，开始于 <uri> 到本地文件系统(位于 <local-path>. 您还可以添加 <jcrpath> 用于检出远程树的子目录的参数。 可以指定将复制到META-INF目录中的工作区筛选器。

语法 syntax-2

checkout --force|-v|-q|-f <file> <uri> <jcrPath> <localPath>

选项 options-2

--force
强制签出覆盖本地文件（如果已存在）
-v (--verbose)
详细输出
-q (--quiet)
尽可能少地打印
-f (--filter) <file>
如果未定义任何过滤器，则指定自动过滤器
<uri>
mountpoint uri
<jcrPath>
（可选）远程路径
<localPath>
（可选）本地路径

示例 examples-2

使用JCR远程处理：

vlt --credentials admin:admin co http://localhost:8080/crx/server/crx.default/jcr_root/

使用默认工作区：

vlt --credentials admin:admin co http://localhost:8080/crx/server/-/jcr_root/

如果URI不完整，则将展开该URI:

vlt --credentials admin:admin co http://localhost:8080/crx

分析 analyze

分析包。

语法 syntax-3

analyze -l <format>|-v|-q <localPaths1> [<localPaths2> ...]

选项 options-3

-l (--linkFormat) <format>
修补程序链接的printf格式（名称、id），例如 `[CQ520_HF_%s
-v (--verbose)
详细输出
-q (--quiet)
尽可能少地打印
<localPaths> [<localPaths> ...]
本地路径

状态 status

打印工作副本文件和目录的状态。

如果 --show-update 已指定，则会针对远程版本检查每个文件。 然后，第二个字母指定将由更新操作执行的操作。

语法 syntax-4

status -v|-q|-u|-N <file1> [<file2> ...]

选项 options-4

-v (--verbose)
详细输出
-q (--quiet)
尽可能少地打印
-u (--show-update)
显示更新信息
-N (--non-recursive)
在单个目录上运行
<file> [<file> ...]
显示状态的文件或目录

更新 update

将更改从存储库复制到工作副本中。

语法 syntax-5

update -v|-q|--force|-N <file1> [<file2> ...]

选项 options-5

-v (--verbose)
详细输出
-q (--quiet)
尽可能少地打印
--force
强制覆盖本地文件
-N (--non-recursive)
在单个目录上运行
<file> [<file> ...]
要更新的文件或目录

信息 info

显示有关本地文件的信息。

语法 syntax-6

info -v|-q|-R <file1> [<file2> ...]

选项 options-6

-v (--verbose)
详细输出
-q (--quiet)
尽可能少地打印
-R (--recursive)
操作递归
<file> [<file> ...]
显示信息的文件或目录

提交 commit

将工作副本中的更改发送到存储库。

语法 syntax-7

commit -v|-q|--force|-N <file1> [<file2> ...]

选项 options-7

-v (--verbose)
详细输出
-q (--quiet)
尽可能少地打印
--force
即使修改了远程副本，也强制提交
-N (--non-recursive)
在单个目录上运行
<file> [<file> ...]
提交文件或目录

还原 revert

将工作副本文件恢复为原始状态，并取消大多数本地编辑。

语法 syntax-8

revert -q|-R <file1> [<file2> ...]

选项 options-8

-q (--quiet)
尽可能少地打印
-R (--recursive)
递归降阶
<file> [<file> ...]
提交文件或目录

已解决 resolved

删除 冲突 处于工作副本文件或目录的状态。

NOTE
此命令在语义上不会解决冲突或删除冲突标记；它仅删除与冲突相关的对象文件并允许再次提交PATH。

语法 syntax-9

resolved -q|-R|--force <file1> [<file2> ...]

选项 options-9

-q (--quiet)
尽可能少地打印
-R (--recursive)
递归降阶
--force
已解析，即使存在冲突标记
<file> [<file> ...]
要解析的文件或目录

普罗佩特 propget

在文件或目录上打印属性的值。

语法 syntax-10

propget -q|-R <propname> <file1> [<file2> ...]

选项 options-10

-q (--quiet)
尽可能少地打印
-R (--recursive)
递归降阶
<propname>
属性名称
<file> [<file> ...]
从获取属性的文件或目录

Proplist proplist

在文件或目录上打印属性。

语法 syntax-11

proplist -q|-R <file1> [<file2> ...]

选项 options-11

-q (--quiet)
尽可能少地打印
-R (--recursive)
递归降阶
<file> [<file> ...]
要列出属性的文件或目录

Propset propset

设置文件或目录上属性的值。

NOTE
VLT可识别以下特殊版本控制属性：
vlt:mime-type
文件的mimetype。 用于确定是否合并文件。 以“text/”开头的mimetype（或缺少mimetype）将被视为文本。 任何其他内容都会被视为二进制文件。

语法 syntax-12

propset -q|-R <propname> <propval> <file1> [<file2> ...]

选项 options-12

-q (--quiet)
尽可能少地打印
-R (--recursive)
递归降阶
<propname>
属性名称
<propval>
属性值
<file> [<file> ...]
要将属性设置为的文件或目录

添加 add

将文件和目录置于版本控制下，并安排它们添加到存储库。 将在下次提交时添加它们。

语法 syntax-13

add -v|-q|-N|--force <file1> [<file2> ...]

选项 options-13

-v (--verbose)
详细输出
-q (--quiet)
尽可能少地打印
-N (--non-recursive)
在单个目录上运行
--force
迫使行动开始
<file> [<file> ...]
要添加的本地文件或目录

删除 delete

从版本控制中删除文件和目录。

语法 syntax-14

delete -v|-q|--force <file1> [<file2> ...]

选项 options-14

-v (--verbose)
详细输出
-q (--quiet)
尽可能少地打印
--force
迫使行动开始
<file> [<file> ...]
删除本地文件或目录

差异 diff

显示两个路径之间的差异。

语法 syntax-15

diff -N <file1> [<file2> ...]

选项 options-15

-N (--non-recursive)
在单个目录上运行
<file> [<file> ...]
显示与

控制台 console

运行交互式控制台。

语法 syntax-16

console -F <file>

选项 options-16

-F (--console-settings) <file>
指定控制台设置文件。 默认文件为console.properties。

Rcp rcp

将节点树从一个远程存储库复制到另一个远程存储库。 <src> 指向源节点和 <dst> 指定必须存在父节点的目标路径。 Rcp通过流式传输数据来处理节点。

语法 syntax-17

rcp -q|-r|-b <size>|-t <seconds>|-u|-n|-e <arg1> [<arg2> ...] <src> <dst>

选项 options-17

-q (--quiet)
尽可能少地打印。
-r (--recursive)
递归下降。
-b (--batchSize) <size>
中间保存之前要处理的节点数。
-t (--throttle) <seconds>
中间保存后等待的秒数。
-u (--update)
覆盖/删除现有节点。
-n (--newer)
请遵循lastModified属性进行更新。
-e (--exclude) <arg> [<arg> ...]
排除的源路径的正则表达式。
<src>
源树的存储库地址。
<dst>
目标节点的存储库地址。

示例 examples-3

vlt rcp http://localhost:4502/crx/-/jcr:root/content  https://admin:admin@localhost:4503/crx/-/jcr:root/content_copy
NOTE
的 --exclude 选项后面需要有另一个选项 <src> 和 <dst> 参数。 例如：
vlt rcp -e ".*\.txt" -r

同步 sync

允许控制电子仓库同步服务。 如果没有任何参数，此命令将尝试将当前工作目录置于同步控制下。 如果在vlt结账中执行，则会使用相应的过滤器和主机来配置同步。 如果在vlt结帐外执行，则仅当目录为空时，才会注册当前文件夹以进行同步。

语法 syntax-18

sync -v|--force|-u <uri> <command> <localPath>

选项 options-18

-v (--verbose)
详细输出。
--force
强制执行某些命令。
-u (--uri) <uri>
指定同步主机的URI。
<command>
执行同步命令。
<localPath>
要同步的本地文件夹。

状态代码 status-codes

VLT使用的状态代码为：

  • ' '无修改
  • 添加了“A”
  • “C”冲突
  • 已删除“D”
  • “I”被忽略
  • 已修改“M”
  • 已替换“R”
  • “？” 项目不在版本控制下
  • '!' 缺少项目（由非svn命令删除）或项目不完整
  • “~”受不同类型项目阻碍的版本化项目

设置FileVault同步 setting-up-filevault-sync

保管库同步服务用于将存储库内容与本地文件系统表示同步，反之亦然。 这是通过安装OSGi服务来实现的，该服务将侦听存储库更改并将定期扫描文件系统内容。 它使用与存储库相同的序列化格式将存储库内容映射到磁盘。

NOTE
保险存储同步服务是一种开发工具，我们强烈建议不要将其用于生产系统。 另请注意，该服务只能与本地文件系统同步，不能用于远程开发。

使用vlt安装服务 installing-the-service-using-vlt

的 vlt sync install 命令可用于自动安装保险存储同步服务包和配置。

包安装在下面 /libs/crx/vault/install 且配置节点是在 /libs/crx/vault/com.day.jcr.sync.impl.VaultSyncServiceImpl. 最初，服务处于启用状态，但未配置同步根。

以下示例将同步服务安装到给定uri可访问的CRX实例。

$ vlt --credentials admin:admin sync --uri http://localhost:4502/crx install

显示服务状态 displaying-the-service-status

的 status 命令可用于显示有关正在运行的同步服务的信息。"

$ vlt sync status --uri http://localhost:4502/crx
Connecting via JCR remoting to http://localhost:4502/crx/server
Listing sync status for http://localhost:4502/crx/server/-/jcr:root
- Sync service is enabled.
- No sync directories configured.
NOTE
的 status 命令不会从服务中获取任何实时数据，而是读取 /libs/crx/vault/com.day.jcr.sync.impl.VaultSyncServiceImpl.

添加同步文件夹 adding-a-sync-folder

的 register 命令用于添加要与配置同步的文件夹。

$ vlt sync register
Connecting via JCR remoting to http://localhost:4502/crx/server
Added new sync directory: /tmp/workspace/vltsync/jcr_root
NOTE
的 register 在您配置 sync-once 配置。

删除同步文件夹 removing-a-sync-folder

的 unregister 命令用于从配置中删除要同步的文件夹。

$  vlt sync unregister
Connecting via JCR remoting to http://localhost:4502/crx/server
Removed sync directory: /tmp/workspace/vltsync/jcr_root
NOTE
在删除同步文件夹之前，必须先取消注册该文件夹。

配置同步 configuring-synchronization

服务配置 service-configuration

服务运行后，可使用以下参数对其进行配置：

  • vault.sync.syncroots:定义同步根的一个或多个本地文件系统路径。

  • vault.sync.fscheckinterval:应扫描文件系统以进行更改的频率（以秒为单位）。 默认值为5秒。

  • vault.sync.enabled:启用/禁用服务的常规标记。

NOTE
该服务可以使用Web控制台或 sling:OsgiConfig 节点(具有名称 com.day.jcr.sync.impl.VaultSyncServiceImpl)。
使用AEM时，可通过多种方法来管理此类服务的配置设置；请参阅 配置OSGi 以了解完整详细信息。

同步文件夹配置 sync-folder-configuration

每个同步文件夹都将配置和状态存储在三个文件中：

  • .vlt-sync-config.properties:配置文件。

  • .vlt-sync.log:日志文件，其中包含有关同步期间执行的操作的信息。

  • .vlt-sync-filter.xml:用于定义同步存储库哪些部分的过滤器。 此文件的格式由 执行过滤结账 中。

的 .vlt-sync-config.properties 文件允许您配置以下属性：

已禁用 打开或关闭同步。 默认情况下，此参数设置为false以允许同步。

sync-once 如果为非空，则下次扫描将按给定方向同步文件夹，则将清除该参数。 支持两个值：

  • JCR2FS:导出JCR存储库中的所有内容并写入本地磁盘。
  • FS2JCR:将磁盘中的所有内容导入JCR存储库。

sync-log 定义日志文件名。 默认情况下，值为.vlt-sync.log

使用VLT同步进行开发 using-vlt-sync-for-development

要基于同步文件夹设置开发环境，请按如下步骤操作：

  1. 使用vlt命令行签出您的存储库：

    code language-shell 
    $ vlt --credentials admin:admin co --force http://localhost:4502/crx dev
    note note
    NOTE
    您可以使用过滤器仅签出相应的路径。 请参阅 执行过滤结账 中。

  2. 转到工作副本的根文件夹：

    code language-shell 
    $ cd dev/jcr_root/

  3. 将同步服务安装到您的存储库：

    code language-xml 
    $ vlt sync install
Connecting via JCR remoting to http://localhost:4502/crx/server
Preparing to install vault-sync-2.4.24.jar...
Updated bundle: vault-sync-2.4.24.jar
Created new config at /libs/crx/vault/config/com.day.jcr.sync.impl.VaultSyncServiceImpl

  4. 初始化同步服务：

    code language-shell 
    $ vlt sync
Connecting via JCR remoting to http://localhost:4502/crx/server
Starting initialization of sync service in existing vlt checkout /Users/colligno/Applications/cq5/vltsync/sandbox/dev/jcr_root for http://localhost:4502/crx/server/-/jcr:root
Added new sync directory: /Users/trushton/Applications/aem/vltsync/sandbox/dev/jcr_root

The directory /Users/trushton/Applications/aem/vltsync/sandbox/dev/jcr_root is now enabled for syncing.
You might perform a 'sync-once' by setting the
appropriate flag in the /Users/trushton/Applications/aem/vltsync/sandbox/dev/jcr_root/.vlt-sync-config.properties file.

  5. 编辑 .vlt-sync-config.properties 隐藏文件并配置同步以同步存储库的内容：

    code language-xml 
    sync-once=JCR2FS
    note note
    NOTE
    此步骤将根据您的过滤器配置下载整个存储库。

  6. 检查日志文件 .vlt-sync.log 要查看进度：

    code language-xml 
    ***
30.04.2017 14:39:10 A file:///Users/trushton/Applications/aem/vltsync/sandbox/dev/jcr_root/apps/geometrixx-outdoors/src/core/src/main/java/info/geometrixx/outdoors/
30.04.2017 14:39:10 A file:///Users/trushton/Applications/aem/vltsync/sandbox/dev/jcr_root/apps/geometrixx-outdoors/src/core/src/main/java/info/geometrixx/outdoors/core/
30.04.2017 14:39:10 A file:///Users/trushton/Applications/aem/vltsync/sandbox/dev/jcr_root/apps/geometrixx-outdoors/src/core/src/main/java/info/geometrixx/outdoors/core/product/
30.04.2017 14:39:10 A file:///Users/trushton/Applications/aem/vltsync/sandbox/dev/jcr_root/apps/geometrixx-outdoors/src/core/src/main/java/info/geometrixx/outdoors/core/product/GeoProduct.java
***

您的本地文件夹现已与存储库同步。 同步是双向的，因此从存储库进行的修改将应用于本地同步文件夹，反之亦然。

NOTE
VLT同步功能仅支持简单的文件和文件夹，但会检测特殊的电子仓库序列化文件（.content.xml、dialog.xml等），并静默忽略它们。 因此，可以在默认vlt结账时使用保险存储同步。
recommendation-more-help
2315f3f5-cb4a-4530-9999-30c8319c520e