Configuring AVAA Server

Using the SERVER element

AVAA Server can be activated by adding the <SERVER> element to the configuration file.

Edit avaa-config.xml and adapt the following sample to your needs.

<AVAA_CONFIG>
    <!-- ... -->
    <SERVER>
        <!-- a greeting message for the connecting user -->
        <GREET>
            Welcome to AVAA!
            This is a demo instance.
        </GREET>
        <!-- we use the "free" login method, so anyone can join without password -->
        <LOGIN type="free" />
        <!-- directory and public URL for generated user files -->
        <OUTPUT path="./tickets" url="https://demo.avaa-toolkit.org/tickets/" />
        <!-- a list of projects the users can access  -->
        <PROJECT id="test-project" root="projects/test" />
    </SERVER>
</AVAA_CONFIG>

Upon restart, AVAA will enter in server mode able to work on the specified project and its documents.

Using the PROJECT element

The <PROJECT /> element requires 2 attributes:

• id a unique id for the project, which must not be changed later
• root the root directory of the project

AVAA will look for a project.xml file in the project's root directory. This file can define additional settings for the project. These settings can also be set directly inside the <PROJECT> element in <SERVER>.

Using project.xml

A project can use a project.xml in its root directory:

<?xml version="1.0" encoding="utf-8"?>
<PROJECT name="My Test Project">
    <!-- a list of documents that will be made available as loadable corpus -->
    <CORPUS path="my-existing-corpus.xml" />
    <CORPUS path="another-corpus-document.xml" />
    <!-- categories can contain multiple folders of documents -->
    <CATEGORY 
        name="Test Exploration" 
        description="Some documents to quickly explore the corpus">
        <FOLDER path="exploration documents" />
        <FOLDER path="project-subfolder/my-docs" />
        <!-- it's also possible to add a single document -->
        <DOCUMENT path="project-subfolder/my-docs/foo.xml" />
    </CATEGORY>
    <!-- home style is a bit configurable with custom CSS -->
    <CSS>
        h2 { color:purple; }
    </CSS>
</PROJECT>