Installation Guide

Complete guide to installing and configuring the Mattermost PDF Dekont Parser Plugin.

Table of contents

  1. Prerequisites
    1. Compatibility Matrix
  2. Installation Methods
    1. Method 1: Pre-built Release (Recommended)
      1. Step 1: Download
      2. Step 2: Upload to Mattermost
      3. Step 3: Enable Plugin
    2. Method 2: Build from Source
      1. Step 1: Clone Repository
      2. Step 2: Install Dependencies
      3. Step 3: Build Plugin
      4. Step 4: Install Built Plugin
  3. Configuration
    1. System Console Settings
    2. Plugin Settings
  4. Verification
    1. Test Installation
  5. Troubleshooting
    1. Common Issues
      1. Plugin Not Activating
      2. PDF Files Not Being Processed
      3. Missing Transaction Fields
    2. Error Messages
      1. “Plugin failed to start”
      2. “PDF processing failed”
      3. “Permission denied”
  6. Uninstallation
  7. Next Steps
  8. Support

Prerequisites

Before installing the plugin, ensure you have:

Compatibility Matrix

Mattermost Version Plugin Version Status
v6.0.0+ v1.0.0+ ✅ Supported
v5.x - ❌ Not supported

Installation Methods

This is the easiest way to install the plugin.

Step 1: Download

  1. Go to the Releases page
  2. Download the latest mattermost-dekont-plugin-X.X.X.tar.gz file

Step 2: Upload to Mattermost

  1. Navigate to System Console → Plugins → Management
  2. Click Choose File and select the downloaded .tar.gz file
  3. Click Upload
  4. Wait for the upload progress to complete

Step 3: Enable Plugin

  1. Find “PDF Dekont Parser” in the installed plugins list
  2. Click Enable button
  3. Verify the plugin status shows as “Running”

Method 2: Build from Source

For developers or advanced users who want to build from source.

Step 1: Clone Repository

git clone https://github.com/SkyLostTR/mattermost-dekont-plugin.git
cd mattermost-dekont-plugin

Step 2: Install Dependencies

go mod download

Step 3: Build Plugin

# Using Make (recommended)
make build
make bundle

# Or manually
GOOS=linux GOARCH=amd64 go build -o plugin
mkdir -p dist/server
cp plugin dist/server/plugin-linux-amd64
chmod +x dist/server/plugin-linux-amd64
cp plugin.json dist/
cd dist && tar -czf ../mattermost-dekont-plugin-1.0.0-linux.tar.gz *

Step 4: Install Built Plugin

Follow steps 2-3 from Method 1 using your built .tar.gz file.

Configuration

System Console Settings

After installation, you can configure the plugin:

  1. Go to System Console → Plugins → PDF Dekont Parser
  2. Configure available settings (currently minimal configuration required)

Plugin Settings

Setting Default Description
Enable Plugin false Enable/disable the plugin
Debug Logging false Enable detailed debug logs

Verification

Test Installation

  1. Upload a Test PDF:
    • Go to any Mattermost channel
    • Upload a PDF bank receipt
    • Check if the plugin processes it automatically
  2. Check Server Logs: 
    Look for entries like:
[INFO] PDF Dekont Parser: Plugin activated successfully
[INFO] PDF Dekont Parser: Processing PDF file: filename.pdf
  3. Verify Plugin Status:
    • System Console → Plugins → Management
    • Plugin should show status “Running” with green indicator

Troubleshooting

Common Issues

Plugin Not Activating

Symptoms: Plugin shows as “Failed” or doesn’t start

Solutions:

  1. Check Mattermost server logs: 
    tail -f /opt/mattermost/logs/mattermost.log
  2. Verify Mattermost version compatibility
  3. Ensure plugin uploads are enabled in System Console
  4. Try re-uploading the plugin

PDF Files Not Being Processed

Symptoms: PDFs upload but no extraction occurs

Solutions:

  1. Check file format (must be PDF)
  2. Verify the PDF contains text (not scanned images)
  3. Check server logs for processing errors
  4. Ensure the PDF is from a supported bank

Missing Transaction Fields

Symptoms: Some fields not extracted from PDF

Solutions:

  1. Check if your bank format is supported
  2. Submit a bank support request
  3. Enable debug logging for detailed extraction info

Error Messages

“Plugin failed to start”

“PDF processing failed”

“Permission denied”

Uninstallation

To remove the plugin:

  1. Go to System Console → Plugins → Management
  2. Find “PDF Dekont Parser” in the list
  3. Click Disable to stop the plugin
  4. Click Remove to uninstall completely

Next Steps

After successful installation:

  1. Learn how to use the plugin
  2. Check supported banks
  3. Explore development options

Support

Need help with installation?