NCW Tools

Utility app providing event listeners and extensible tools for system administration and maintenance tasks.

Description

NCW Tools enhances Nextcloud with advanced system utilities including event listeners for monitoring system events, and extensible tools designed to streamline system administration and maintenance workflows.

Installation

From Source

1. Clone this repository into your Nextcloud apps directory:

   cd nextcloud/apps
   git clone <repository-url> ncw_tools

2. Install dependencies:

   cd ncw_tools
   composer install

3. Enable the app in your Nextcloud admin panel or via command line:

   php occ app:enable ncw_tools

Configuration

Post-Installation Job Retry Interval

The app includes a background job that sends a welcome email to the admin user after installation. You can configure how often this job retries by setting the following system configuration value in your config/config.php:

'ncw_tools.post_setup_job.retry_interval' => 5, // Retry every 5 seconds (default: 2)

Configuration Options:

• Key: ncw_tools.post_setup_job.retry_interval
• Type: Integer (seconds)
• Default: 2 seconds
• Description: Interval in seconds between retry attempts for the post-installation welcome email job

Development

Prerequisites

• PHP 8.1+
• Composer

Setup

1. Clone the repository
2. Install dependencies:

   composer install

Available Scripts

• composer lint - Lint PHP files
• composer cs:check - Check coding style
• composer cs:fix - Fix coding style
• composer psalm - Run static analysis
• composer test:unit - Run unit tests

Testing

Run the unit tests:

composer test:unit

License

This project is licensed under the AGPL-3.0-or-later license. See the LICENSE file for details.