AVTool 4

AVTool Operations

Details about installing and operating the AVTool.

Installation

When you install the AVTool, it is recommended to use the following folder hierarchy:

cms-install-directory/
	avtool/
		avtool-app-4.4.0executable.conf
		avtool-app-4.4.0-executable.jar
		application.properties
		mediaconfig.xml
		data/
		groovy/
		logs/
	...

We also provide a Docker image and Helmchart for deployment.

Starting and Stopping

You can use init.d to start and stop the AVTool. Simply create a symlink in /etc/init.d which points to the jar. It should be started by root but will use the owning user of the jar file for running the application.

To start the AVTool directly as non-root user, you have to change the location of the pid and log files to a place accessible by the user. Put a .conf file with the same name as the jar alongside the jar with a content like the following:

JAVA_OPTS="-Xmx1g -Davtool.groovy.dir=/cms-install-directory/avtool/groovy"
PID_FOLDER="/cms-install-directory/avtool/logs/"
LOG_FOLDER="/cms-install-directory/avtool/logs/"

To start the AVTool invoke the avtool-app-4.4.0-executable.jar as follows:

> cd cms-install-directory/avtool
> ./avtool-app-4.4.0-executable.jar start

To stop the AVTool, enter the following:

> cd cms-install-directory/avtool
> ./avtool-app-4.4.0-executable.jar stop

For all possible options look at the Spring Boot documentation.

Last modified on 9/6/24

The content of this page is licensed under the CC BY 4.0 License. Code samples are licensed under the MIT License.

Icon