🛠️ How to Integrate a Plugin

1️⃣ Explore Available Plugins

Before integrating a plugin, check the Available Plugins table. Each plugin entry includes:

• 📌 Name: The identifier used in configuration.
• 📝 Description: A brief summary of its function.
• ⚙️ Configuration Requirement: Indicates whether the plugin requires a separate configuration file.
• 📂 Config File Name: The expected filename for plugin-specific configurations.

2️⃣ Enabling a Plugin

You can enable a plugin by specifying it in the plugins setting of aw-sync-agent. There are multiple ways to do this:

🏗️ A. Using Command-Line Flags

./aw-sync-agent --plugins "PluginName1|PluginName2"

📝 B. Using YAML Configuration (aw-sync-settings.yaml)

plugins:
  - PluginName1
  - PluginName2

🌍 C. Using an Environment Variable

export PLUGINS="PluginName1|PluginName2"

3️⃣ Configuring Plugins

Some plugins require additional configurations. If a plugin has a configuration file specified (as seen in the Config File Name column), follow these steps:

📁 A. Create the Configuration File

Navigate to the configs directory and create the necessary file:

cd ./configs
touch aw-plugin-{filterName}.yaml

✏️ B. Edit the Configuration File

Modify aw-plugin-{filterName}.yaml as per the plugin’s requirements. Refer to the plugin’s documentation for specific configuration details.

4️⃣ Testing Your Configuration

Before running the agent, ensure your configuration is correctly set up by running:

./aw-sync-agent -testConfig

✅ This will validate the configuration and report any errors.

❓ Need Help?

If you run into any issues:

• 🔍 Check the logs for errors (./aw-sync-agent -testConfig).
• 📌 Ensure your configuration files are correctly named and formatted.
• 🆘 Open an issue in the repository for further assistance.