Documentation

SpaceKonnect - DigitalOcean Space Cloud Storage Addon

Thank you so much for purchasing our item from CodeCanyon.

  • Created: 11 April, 2025

If you have any questions that are beyond the scope of this help file, please feel free to email via Item Support Page.

Things You Must Have:

These are prerequisites for SpaceKonnect.

  • Background Queue Job must be running on Lernen for this add-on to work. See documentation here
  • Configure this queue worker to have long timeout settings. This add-on copies all storage data from local storage to DigitalOcean Space in the background, and this process may take a few minutes to complete. You can set timeout in your /etc/supervisor/conf.d/ file as: 
                
                           
                              ...
                              php artisan queue:work --timeoute=3600     //Adjust the timeout as needed
                              ...
  • Lernen version: 2.2.3

Download & Installation

Follow these steps to install the SpaceKonnect add-on in your Lernen project:

  • Step 1: Download the Package

    When downloading the zip package file from CodeCanyon, you'll have all the files you need inside. The zip package contains the following files:

    • SpaceKonnect.zip contains the SpaceKonnect Add-on
    • documentation.zip contains documentation for the add-on
  • Step 2: Extract the Package
    • Extract the downloaded zip file i.e. SpaceKonnect.zip
  • Step 3: Install SpaceKonnect
    • Go to Admin > Manage Addons and click on Add new. Lernen Addons
    • Choose the SpaceKonnect.zip file and click on Install. Lernen Addons
    • Alternatively, Manual Installation

      If you prefer to manually install the SpaceKonnect add-on, follow these steps:

      • Upload SpaceKonnect.zip to the Modules/ directory and extract it in the same location. Run the following commands at the root of your project:
        • php artisan module:enable SpaceKonnect

Admin Settings

  • Maintenance Mode:
  • Go to Admin > Site management > Global settings > Maintenance and enable maintenance mode. Lernen Addons
  • Global Settings Overview:
    • In the DigitalOcean Space Setting section, you can access DigitalOcean Space settings:
    • Access Key ID: Set the Access Key ID for your DigitalOcean Space.
    • Secret Access Key: Set the Secret Access Key for your DigitalOcean Space.
    • Default Region: Select the Default Region for your DigitalOcean Space.
    • Bucket Name: Set the Bucket Name for your DigitalOcean Space.
  • Save Changes: After adding the settings, click the Save changes button to apply the updates.
  • Reset Options: You can reset specific sections or all settings using the Reset section or Reset all buttons.
Global Settings Panel
  • Disable maintenance mode after setting SpaceKonnect
  • Go to Admin > Site management > Global settings > Maintenance and disable maintenance mode. Lernen Addons
  • File Migration to DO Space:
    • Once settings are saved, SpaceKonnect will automatically migrate existing files from local storage to DO Space.
  • Usage:
    • After configuration, your application will handle files directly with DigitalOcean Space. You do not need to make any additional adjustments to file upload code in your application.

    • Insufficient Permissions

    When interacting with your DigitalOcean Space, SpaceKonnect requires that the configured access key has sufficient permissions. If you encounter errors like "Access Denied", "403 Forbidden", or failure to list, upload, or delete files, here are the common permission issues and how to fix them:

    • 1. Verify Access Key Permissions
      • Ensure the DigitalOcean Access Key ID you provided has full permission to the Space (bucket) and its contents. It should allow all these actions:
        • list — to enumerate files in the bucket
        • read — to download/serve files
        • write — to upload new or updated files
        • delete — to remove files when needed
        If any of these are missing, SpaceKonnect functionality may break.