Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

This page describes how to install and run the core microservice

Table of contents

Table of Contents

Requirements


Full system installation

  1. PHP
    1. PHP >= 5.6.4
    2. OpenSSL PHP Extension
    3. PDO PHP Extension
    4. Mbstring PHP Extension
    5. Tokenizer PHP Extension
    6. Composer
  2. Server - Nginx recommended
  3. Database - PostgreSQL recommended
  4. Command line (SSH) access to the deploy server

Installation

Warning

Everytime you make a modification in the .env or config files you need to run the command php artisan config:cache so that your configuration is saved and used!

  • Copy the repository files to a directory on the disk
  • Copy / Rename the file ",env.example" to ".env"
  • Edit the desired configuration details (excepting the APP_KEY property, we will set that later)
  • Point the web server's document root to the public folder
  • Using SSH, in the root directory of the project run the following comands
    1. composer install
    2. php artisan config:cache
    3. php artisan migrate
    4. php artisan key:generate
    5. php artisan config:cache
    6. php artisan db:seed
    7. php artisan config:cache
  • Point your browser to the domain on which the application was installed on
  • Login with the default credentials:
  • username: flaviu@glitch.ro
  • password 1234
    Tip
    titleTip!

    This is the recommended way of installation!

    The core is automatically installed as part of the full Online Membership System, you can install it using the installation instructions over here.

    From that article you can also find several further links to get you started with the system, including the core.

    Seperate service installation

    Docker container

    Installing the core using the docker containers as present in the full system can be quickly done, simply take the Docker-compose.yml and choose the containers you want to use. Based on your exact needs you need to use 'omscore' and you can choose whether or not to use additional containers 'omscore-nginx', 'php-fpm' and 'traefik'.

    Native install (without docker)

    We currently do not give support on how to install the core without using the provided docker container. However you can have a look at the files inside the oms-core/docker/ folder, which contain the instructions docker uses for installation.