Installation

Method 1: Composer Installation (Recommended)

For Composer-based TYPO3 installations, use the following command:

composer require mrg/dashbash

This will:

• Download the extension and its dependencies
• Register the extension in your TYPO3 installation
• Make it available for activation

After installation, activate the extension:

# Via TYPO3 Console (if available)
vendor/bin/typo3 extension:activate dashbash

# Or via TYPO3 CLI
vendor/bin/typo3 extension:activate dashbash

Method 2: TYPO3 Extension Repository (TER)

For Classic Mode installations:

1. Access Extension Manager

   • Go to Admin Tools > Extensions in your TYPO3 backend
   • Make sure you're in "Get Extensions" mode

2. Search and Install

   • Search for "dashbash" in the extension repository
   • Click "Import and Install" next to the DashBash extension
   • The extension will be downloaded and made available

3. Activate Extension

   • Switch to "Installed Extensions" mode
   • Find "DashBash" in the list
   • Click the activation icon to enable the extension

Method 3: Manual Installation

For development or special deployment scenarios:

1. Download Extension

   • Download the extension from the TYPO3 Extension Repository
   • Or clone from the Git repository: git clone [repository-url]

2. Place Files

   • Extract/copy the extension files to typo3conf/ext/dashbash/
   • Ensure proper file permissions are set

3. Clear Cache

   # Clear all caches
   vendor/bin/typo3 cache:flush

   Copied!

4. Activate Extension

   • Go to Admin Tools > Extensions
   • Find "DashBash" and activate it

Basic Setup

No initial configuration is required. The extension works out-of-the-box with default settings.

Optional Configuration

For advanced features, you may configure:

TSConfig Filtering (Optional)

Enable advanced TSConfig management capabilities:

# In LocalConfiguration.php or AdditionalConfiguration.php
$GLOBALS['TYPO3_CONF_VARS']['EXTENSIONS']['dashbash']['enableTsConfigFiltering'] = 1;

Development Logging (Development Only)

For development environments, debug logging is automatically enabled in Development/ddev context.

Common Issues

Extension Not Appearing in Dashboard

1. Clear all caches: vendor/bin/typo3 cache:flush
2. Verify dashboard system extension is active
3. Check browser console for JavaScript errors

Composer Installation Fails

1. Verify your composer.json allows the required TYPO3 versions
2. Update Composer: composer self-update
3. Try: composer require mrg/dashbash --no-scripts

Permission Errors (Manual Installation)

Ensure proper file permissions:

# Example for typical web server setup
sudo chown -R www-data:www-data typo3conf/ext/dashbash/
sudo chmod -R 755 typo3conf/ext/dashbash/

JavaScript/CSS Not Loading

1. Clear browser cache
2. Verify Resources/Public/ folder has proper permissions
3. Check TYPO3's resource handling configuration

Database Issues

DashBash uses TYPO3's built-in caching system. If you encounter cache-related issues:

# Flush specific cache
vendor/bin/typo3 cache:flush --group=system

# Or flush all caches
vendor/bin/typo3 cache:flush