EC-CUBE

【EC-CUBE3】Plugin Upload Error: config.yml not found or syntax error – Solution

When building an e-commerce site with EC-CUBE3, the “plugin” feature is frequently utilized. However, when uploading a plugin, you might encounter an upload error with the message “config.yml not found or syntax error.” This issue can be a significant obstacle, particularly for those managing an online store.
This article provides a clear explanation of the causes and solutions for this error message. As a result, it was resolved quickly and easily.

Cause of the Error Message “config.yml not found or syntax error”

When uploading a compressed (zip) file through the EC-CUBE admin panel at “Owner’s Store” → “Plugin” → “Plugin List,” the error “config.yml not found or syntax error” appeared.

I checked the contents of the “config.yml” file, suspecting there was a problem with its syntax, but the error persisted despite multiple attempts.

The primary cause of this error message is a problem with the file structure during plugin upload. Specifically, if the entire plugin folder is compressed and uploaded, EC-CUBE3 cannot correctly recognize the required “config.yml” file, leading to this error.

【EC-CUBE3】Plugin Upload Error: Causes and Solutions

The solution to this issue is straightforward. By compressing the file structure of the plugin folder correctly, you can upload the plugin without encountering any errors.

Cause of the Upload Error

The cause was that the folder itself containing “config.yml” and PHP files was compressed and uploaded.

(Example of a sample plugin folder structure)

sample ← ※1: Do not compress this folder
│
│ ↓※2: Move to this directory and compress the files and subdirectories
│
│  config.yml
│  aaa.php
│  bbb.php
├─ccc
└─ddd

Solution for the Upload Error

※1: Compressing and uploading this folder (sample) itself resulted in an error. The directory structure shifted, and the “config.yml” file could not be found.

※2: Move to the directory within the folder (sample) and compress the files and subdirectories into a single zip file.

When the zip file compressed using method “※2” was uploaded through the “Plugin List” in the admin panel, the upload (installation) was successful.

By understanding and implementing this simple yet crucial point, you can seamlessly upload and install plugins without being troubled by the error message “config.yml not found or syntax error.”

Conclusion

If you encounter the error “config.yml not found or syntax error” when uploading a plugin in EC-CUBE3, review the structure of the files you are compressing. By re-compressing with the correct file structure, this problem can be easily resolved. I hope this article serves as a helpful guide for those operating e-commerce sites using EC-CUBE3.

While this article introduced a basic solution, there may be other challenges in using EC-CUBE3, such as plugin customization, theme changes, and security enhancements. Continuously learning and experimenting is key to mastering EC-CUBE3. By sharing such information, we aim to contribute to better e-commerce site management.

※ Please take full responsibility when using or referencing this information.