Initial Setup
This chapter guides you through all the relevant steps to configure aqilink and start a container based on the image. It covers the necessary configuration files that must be present and properly configured to store documents from SAP in the related repository.
Make sure to have the following files and packages available from the Download, at least:
- aqilink Docker image
- License Key
Configuration Files
The configuration is split across several YAML files. Make sure these files are set up in the right structure and kept up to date to ensure aqilink runs smoothly.
Filename | Description |
---|---|
app.yaml | This file is crucial for the basic startup process as it contains essential settings needed to run aqilink successfully, such as the license key, the port number of the application or even logging. |
sapHttp.yaml | Defines all connections from the SAP Content Repository administration and maps them to the corresponding storage section of the storage.yaml . |
storage.yaml | This file specifies the connection details for the related storage systems (Hyland Nuxeo, Microsoft SharePoint or AWS S3). |
File Association & Flow
To better understand how the configuration files are linked, refer to the image below. Once you have a clear grasp, you can move forward with the configuration.
Overview of File Structure
The example below shows the recommended structure that should be created and mapped into the container. We suggest setting up this structure with the necessary configuration files inside. The following sections in this chapter will reference and build upon this structure.
/configs/
|
+ app.yaml
+ storage.yaml
+ sapHttp.yaml
Create File Structure from Scratch
To create the recommended structure select the operating system and copy the script.
- Unix
- Windows PowerShell
To create the recommended structure, navigate to the directory where you want the /configs/
directory to be created and paste the commands below into your Unix terminal:
# Create files in the configs directory
touch configs/app.yaml
touch configs/storage.yaml
touch configs/sapHttp.yaml
On Windows, open a PowerShell and navigate to the directory where you want the /configs/
directory to be created and execute the follwing commands in the given order:
# Create files in the configs directory
New-Item -ItemType File -Path "configs\app.yaml"
New-Item -ItemType File -Path "configs\storage.yaml"
New-Item -ItemType File -Path "configs\sapHttp.yaml"