hfarm/pimcore repository overview

⁠What is Pimcore?

https://pimcore.com/⁠

⁠How to use this image

⁠Run Pimcore with a Database Container

Running Pimcore with a database server is the recommended way. You can run the containers manually.

⁠Run the application manually

If you want to run the application these are the basic steps you need to run:

1. Create a new network for the application and the database:

$ docker network create pimcore-tier

1. Create a volume for MariaDB persistence and create a MariaDB container (choose your favorite docker image, in the following example there is MariaDB by Bitnami)

$ docker volume create --name mariadb_data
$ docker run -d --name mariadb \
  -e ALLOW_EMPTY_PASSWORD=yes \
  -e MARIADB_USER=pimcore \
  -e MARIADB_PASSWORD=pimcore \
  -e MARIADB_DATABASE=pimcore \
  --net pimcore-tier \
  --volume mariadb_data:/bitnami \
  bitnami/mariadb:latest

Note: You need to give the container a name in order for Pimcore to resolve the host

1. Create volumes for Pimcore persistence and launch the container

$ docker volume create --name pimcore_data
$ docker run -d --name pimcore -p 80:80 \
  -e PIMCORE_INSTALL_MYSQL_HOSTNAME=mariadb \
  --net pimcore-tier \
  --volume pimcore_data:/opt/pimcore \
  hfarm/pimcore:latest

Then you can access your application at http://your-ip/⁠

⁠Run the application using Docker Compose

This is an example of docker-compose.yml template:

version: '2'

services:
  mariadb:
    image: 'bitnami/mariadb:latest'
    environment:
      - ALLOW_EMPTY_PASSWORD=yes
      - MARIADB_USER=pimcore
      - MARIADB_PASSWORD=pimcore
      - MARIADB_DATABASE=pimcore
    volumes:
      - /path/to/mariadb-persistence:/bitnami
  pimcore:
    image: 'hfarm/pimcore:latest'
    environment:
      - PIMCORE_INSTALL_MYSQL_HOSTNAME=mariadb
    depends_on:
      - mariadb
    ports:
      - '80:80'
    volumes:
      - '/path/to/pimcore-persistence:/opt/pimcore'

⁠Upgrade this application

1. Get the updated images:

$ docker pull hfarm/pimcore:latest

1. Stop your container

• For docker-compose: $ docker-compose stop pimcore
• For manual execution: $ docker stop pimcore

1. Take a snapshot of the application state

$ rsync -a /path/to/pimcore-persistence /path/to/pimcore-persistence.bkp.$(date +%Y%m%d-%H.%M.%S)

⁠Configuration

⁠Environment variables

When you start the pimcore image, you can adjust the configuration of the instance by passing one or more environment variables either on the docker-compose file or on the docker run command line. If you want to add a new environment variable:

• For docker-compose add the variable name and value under the application section:

pimcore:
  image: hfarm/pimcore:latest
  ports:
    - 80:80
  environment:
    - PIMCORE_INSTALL_ADMIN_USERNAME=administrator
    - PIMCORE_INSTALL_ADMIN_PASSWORD=password01

• For manual execution add a -e option with each variable and value:

$ docker run -d --name pimcore -p 80:80 \
  -e PIMCORE_INSTALL_ADMIN_PASSWORD=password01 \
  --net pimcore-tier \
  --volume /path/to/pimcore-persistence:/opt/pimcore \
  hfarm/pimcore:latest

Available variables:

⁠User and Site configuration

• PUID: UserID to map with volumes. Default: 1001
• PGID: GroupID to map with volumes. Default: 1001
• PIMCORE_INSTALL_ADMIN_USERNAME: Pimcore admin username. Default: admin
• PIMCORE_INSTALL_ADMIN_PASSWORD: Pimcore admin password. Default: admin
• PIMCORE_INSTALL_MYSQL_USERNAME: Database username. Default: pimcore
• PIMCORE_INSTALL_MYSQL_PASSWORD: Database password. Default: pimcore
• PIMCORE_INSTALL_MYSQL_HOSTNAME: Host domain or IP. Default: localhost
• PIMCORE_INSTALL_MYSQL_DATABASE: Database name. Default: pimcore

⁠License

Copyright 2019 H-FARM S.P.A. (MIT)