README

Warning

This repository is no longer maintained by our internal teams.
The template is provided as is and will not receive updates, bug fixes, or new features.
You are welcome to contribute on it or fork the repository and modify it for your own use. To deploy this template on Upsun, you can use the command upsun project:convert on this codebase to convert the existing .platform.app.yaml configuration file to the Upsun Flex format.

Akeneo PIM Community Edition for Platform.sh

This template builds the Akeneo PIM system for Platform.sh. By default it uses the "minimal" install profile. It requires at least a Medium plan as it uses a Worker instance for queue processing.

Akeneo is a Product Information Management (PIM) tool, which acts as a central store for product information, catalog information, and inventory management.

Services

PHP 7.4
MySQL 8.0
Elasticsearch 7.7

Deploy

You can quickly recreate this project locally with the following command:

composer create-project platformsh/pim-community-standard -s dev

Note:

Platform.sh templates prioritize upstream release versions over our own. Despite this, we update template dependencies on a scheduled basis independent of those upstreams. Because of this, template repos do not contain releases. This may change in the future, but until then the -s dev flag is necessary to use composer create-project.

Post-install

The first time the site is deployed, Akeneo's command line installer will run and initialize the database. It will not run again unless the installer/minimal.installed is removed. (Do not remove that file unless you want the installer to run on the next deploy!)
The installer will create an administrator account with username/password admin/admin. You need to change this password immediately. Not doing so is a security risk.
After you have deployed, you can additionally view a built-in demo version of Akeneo, complete with default settings and an initial catalog of products. On a new environment (platform environment:branch demo), update the variables.env block of .platform.app.yaml to match the following:

variables:
    env:
        APP_ENV: 'prod'
        APP_DEBUG: 0
        APP_DEFAULT_LOCALE: 'en_US'
        APP_PRODUCT_AND_PRODUCT_MODEL_INDEX_NAME: 'akeneo_pim_product_and_product_model'
        # AKENEO_STARTER: minimal
        AKENEO_STARTER: icecat_demo_dev
        # Update these for your desired Node version.
        NODE_VERSION: v14.19.0

AKENEO_STARTER will then be updated from the default minimal catalog to icecat_demo_dev. Like before, Akeneo will create an initial admin user (admin/admin), and you should update those credentials immediately.

Customizations

The following changes have been made relative to Akeneo as it is downloaded from Akeneo.com. If using this project as a reference for your own existing project, replicate the changes below to your project.

The .platform.app.yaml, .platform/services.yaml, and .platform/routes.yaml files have been added. These provide Platform.sh-specific configuration and are present in all projects on Platform.sh. You may customize them as you see fit.
The .environment file maps the Platform.sh environment variables to those expected by Akeneo. You can add additional environment setup there as needed but do not remove the lines that already exist.

platformsh / pim-community-standard

Maintainers

Details