README.md

KanboardSupport

Display the environment and configuration settings of your Kanboard instance all from one dedicated page. View and compare all options from the config file directly from the interface. Users will benefit from identifying problems caused by missing extensions and server misconfigurations without needing backend access to the server.

Made for both regular users and administrators, this privacy and user friendly plugin provides a range of features including integrated webhook documentation and downloading backup copies of the config file.

Works smoothly with PluginManager and ContentCleaner.

[↓ Bottom] [→ Next] [↑ Top]

Features

• Hide sensitive data before sharing technical information
  • A single privacy button hides all sensitive information
  • Enhanced privacy for regular users displaying selective information for sensitive values
• Troubleshoot plugins with PluginManager
• Shows the required PHP modules for Mailmagik
• Display and Backup Config Files
  • Display raw versions of the current and default config files for easy comparison
  • Easily download a .zip archive file containing both config files named according to the current Kanboard version and date
  • Requires PHP zip extension to be installed
• Display and Backup Debug Log File
  • Display up to the last 50 entries from the debug log file (regardless of whether the setting is enabled)
  • Download the log file in a compressed zip file for archiving
  • Download the log file in raw format
  • Delete the log file (automatically recreates the log)
  • Display the file size
• Webhooks Information
  • New improved webhooks page
  • Display alert in webhooks page to avoid potential token issues
  • Comprehensive documentation explaining how to work with webhooks
• Directory Permissions
  • Check if directories are writeable or not
  • Display folder owner to Admins
  • Display detected folder permissions to Admins
  • Display permissions also in Linux format to Admins
• User Configuration
  • Displays basic settings about the logged in user (including user ID, IP address and browser details) which may be useful to support professionals
  • IP Lookup button for Admin
• Application Information
  • Displays Kanboard name, version and (if admin user) direct link to GitHub releases for Kanboard
  • Display all values from the config.php file
• Database Connection
  • Display database information (without password) from the config file
  • Display advanced database SSL connection information
  • Relocated SQLite database (upload/download) options from the About page
• Email Connection
  • Show basic mail server settings
  • BCC field value only displayed for Admins
  • Show SMTP details
  • Show Sendmail details
• Server Configuration
  • Show useful path locations
  • Display operating system, versions and ports
  • IP Lookup button for Admin
  • Apache Configuration
    • Display installed Apache modules
    • HIghlight relevant module for URL rewriting
  • Hypertext Access File
    • Display the .htaccess file to admin users
• PHP Information
  • Display general PHP settings based on the Kanboard installation requirements
  • Check if both required and optional PHP extensions are installed
  • Check PHP minimum requirement
  • Display useful file paths for configuration files

[↓ Bottom] [← Previous] [→ Next] [↑ Top]

Screenshots

Directory Permissions

User Configuration Section

Application Information Section

Debug Log File

Database Connection Section

Email Connection Section

Server Configuration Section

PHP Section

Webhooks Section

[↓ Bottom] [← Previous] [→ Next] [↑ Top]

Usage

Go to Settings ⥂ Configuration

or

Go to User Menu (top right) ⥂ Configuration

or

Go to Settings ⥂ Webhooks

[↓ Bottom] [← Previous] [→ Next] [↑ Top]

Installation & Compatibility

Installation

• Install via the Kanboard Plugin Directory or see INSTALL.md
• Read the full Changelog to see the latest updates

Compatibility

• Requires Kanboard ≥1.2.20
• Other Plugins & Action Plugins
  • No known issues
  • Compatible with PluginManager, ApplicationBranding, ContentCleaner, MailMagik
• Core Files & Templates
  • 01 Template override
  • No database changes

Translations

• English (UK), French, German, Spanish
• Starter template available

[↓ Bottom] [← Previous] [→ Next] [↑ Top]

Authors & Contributors

• @aljawaid - Author
• RainerBielefeld - Contributor
• Contributors welcome

[↓ Bottom] [← Previous] [↑ Top]

License

• This project is distributed under the MIT License

---

[↑ Top]