The ability to manage your products in an easy-to-use and organized place is important to any business. Akeneo PIM does exactly that. This tutorial will guide you through the steps it takes to download and run Akeneo community edition V 5.0 on a Mac for development. Whether you are interested in seeing what Akeneo has to offer or you are a developer, this step-by-step guide will lead you through the process of starting a local hosting on your machine.
I highly recommend if you run into any issues or have specific questions related to your installation check out the Akeneo documentation for the latest version of the PIM as some steps may have changed.
To start, we will be following the instructions for using a tool called Docker (Akeneo also has a tutorial on how to install manually but I will not be going over that in this tutorial).
There are four system requirements your machine needs to have installed, Docker 19+, docker-compose 1.24, make, and bash.
Installing and Checking Dependencies
Where does this information come from?For some of the below installation commands, the links to the documentation will be provided
To begin first take a look to see if your machine has make and Bash.
On macOS 10.15+ the default shell is no longer bash; it is zch. To make sure you don’t run into any issues when starting your PIM, type the following command into the terminal to start a bash shell:
I have started the PIM using zch; however, I would recommend following what Akeneo has documented.
Installing the Make Utility
The next step is to check and install a utility called make. To check if your system has this tool enter into your terminal the following:
If it is already installed you will see the following:
If not installed, you will be prompted by the following:
Click install to download command line developer tools onto your mac and allow this to install. Once done try typing make again and you should see that there is no targets specified and no makefile found.
The next step will be to install Docker Desktop. This application will help manage your PIM and easily install it.
Visit the docker website and click the button shown below:
Follow the download instructions and open up Docker.dmg and drag the app into your applications:
Before doing anything with docker we need to configure the application so your Akeneo PIM can run smoother.
First, you need to open up the Docker application, once open you should see a settings gear in the top right corner.
Once you are in the preferences menu, enter the resources tab and increase the resources Docker can use when running your local hosting. The settings are shown below that work for me but you can increase/decrease the values to maximize the performance of your local Akeneo PIM.
Once done, click Apply & Restart. You now are ready to install Akeneo on Docker!
Installing Akeneo PIM V5.0
Now that the dependencies are all taken care of, it’s time to move on and install Akeneo
To begin navigate back to your Terminal window that is in the bash shell and enter the following commands:
Then navigate to your new directory:
Now that you are in your PIM directory you will enter in the following command to install Akeneo Community Edition through Docker.
docker run -ti -u www-data --rm \ -v $(pwd):/srv/pim -v ~/.composer:/var/www/.composer -w /srv/pim \ akeneo/pim-php-dev:5.0 php /usr/local/bin/composer create-project \ akeneo/pim-community-standard /srv/pim "5.0.*@stable"
Once this operation is done you are ready to launch the enviornment.
Quick NoteWhen starting the local hosting, this process can take a couple of minutes to complete.
For any make command, you need to make sure that you are in the base folder for your Akeneo install, in this case, the “pim” directory we entered in the last step.
To start Akeneo type the following command into your terminal:
Once this is complete, can now open up the local Akeneo environment by going to your browser and typing:
The default username and password are both admin.
Congratulations, you are now all set to explore and develop Akeneo on your mac!
Shutting Down Akeneo
IMPORTANT: When shutting down your project using the command line method, realize all data will be erased as the data is stored in the Mysql container, to make the data persistent follow the suggestions provided in the Akeneo tutorial.
If you would like to shut down the PIM and not save any content you can simply type the following command into your terminal:
To shut down and allow your data to be persistent you can navigate to the Docker application and hover over the container to click the stop button on the PIM container:
When the PIM is shut down this is what your container will look like:
To simply restart the pim hover over the container once again and click the triangular start button:
When the container turns orange and says other, your PIM should be back up and running.
Congratulations you now know how to run a local instance of Akeneo Community Edition on your computer running MacOS!
Need Help Going to Production?
If you need a partner that can help you take Akeneo into production, please consider Alpine. Our consulting team has the skills and experience to help you integrate Akeneo into your business environment and configure the system to meet your product management needs and procedures. Learn more about Alpine’s Akeneo services or contact us today!