Skip to content

manual installation

Benjamin Jonard edited this page Dec 13, 2023 · 1 revision

Manual - Using git or an archive file

Requirements

  1. PHP

    Koillection PHP version Maintained
    1.5.x 8.3 ✔️
    1.4.x 8.2
    1.3.x 8.1
    1.2.x 8.0
    1.1.x 7.4
    1.0.x 7.2
  2. Make sure you have the following PHP extensions installed:

    • ctype, fileinfo, gd, iconv, intl, json, apcu
  3. A webserver such as Apache2 or nginx

  4. A Postgresql (>= 10), Mysql (>= 8) or MariaDb database.

  5. Node 14 or more and Yarn

  6. Composer

Installation

  1. git clone the repository or download and unzip the project archive
  2. Create a .env.local file and copy the content of .env in it
  3. In .env.local replace the values by your configuration and remove all curly braces
    • APP_ENV -> Symfony environment, prod by default
    • APP_DEBUG -> activate Symfony debug mode, 0 or 1
    • DB_DRIVER -> pdo_mysql or pdo_pgsql
    • DB_USER -> your database user
    • DB_PASSWORD -> your database password
    • DB_HOST -> your database address (ex: 127.0.0.1 or localhost)
    • DB_PORT -> your database port (5432 by default for postgres, 3306 for mysql)
    • DB_NAME -> your database name
    • DB_VERSION -> your postgres server version (ex: 10.3)
    • PHP_TZ -> Your timezone (ex: Europe/Paris)
  4. In the project root folder execute composer install --no-dev --classmap-authoritative
  5. Then php bin/console doctrine:migrations:migrate
  6. Dump translations for interface php bin/console app:translations:dump
  7. (Optional) Generate SSH keys for API php bin/console lexik:jwt:generate-keypair (not mandatory if you do not plan on using the API)
  8. Configure a vhost (an example can be found in docker/default.conf)
  9. Generate assets : cd assets/ && yarn install && yarn build && cd ..
  10. (Optional) Copy the values contained in docker/php.ini in your own php.ini. Not mandatory but can improve performance greatly